summaryrefslogtreecommitdiff
path: root/docs/sections
diff options
context:
space:
mode:
authorIsabella Gottardi <isabella.gottardi@arm.com>2022-02-14 12:50:48 +0000
committerIsabella Gottardi <isabella.gottardi@arm.com>2022-02-15 16:46:36 +0000
commit31916b62321020b4949474b5d0a84799a27436d0 (patch)
tree517bb0a6b2fdf397ebbb5078e885545454410a32 /docs/sections
parent5916952c0fe6167989afa363829fc4e1d053c683 (diff)
downloadml-embedded-evaluation-kit-31916b62321020b4949474b5d0a84799a27436d0.tar.gz
MLECO-2614: Minor documentation updates
* Adding troubleshooting for cloning errors Change-Id: Ib57353900064c68c30ecb2141602081180c50c99 Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
Diffstat (limited to 'docs/sections')
-rw-r--r--docs/sections/building.md20
-rw-r--r--docs/sections/troubleshooting.md28
2 files changed, 37 insertions, 11 deletions
diff --git a/docs/sections/building.md b/docs/sections/building.md
index 2739320..c39cabc 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -32,7 +32,7 @@ This section assumes that you are using an **x86 Linux** build machine.
Before proceeding, it is *essential* to ensure that the following prerequisites have been fulfilled:
-- GNU Arm embedded toolchain 10.2.1 (or higher) or the Arm Compiler version 6.15, or higher, is installed and available
+- GNU Arm embedded toolchain 10.2.1 (or higher) or the Arm Compiler version 6.16, or higher, is installed and available
on the path. Test the compiler by running:
```commandline
@@ -40,8 +40,8 @@ Before proceeding, it is *essential* to ensure that the following prerequisites
```
```log
- Product: ARM Compiler 6.15 Professional
- Component: ARM Compiler 6.15
+ Product: ARM Compiler 6.16 Professional
+ Component: ARM Compiler 6.16
```
Alternatively, use:
@@ -58,12 +58,12 @@ Before proceeding, it is *essential* to ensure that the following prerequisites
```
> **Note:** If required, add the compiler to the path (can be added to ~/.bashrc to be set permanently):
->
+>
> `export PATH=/path/to/armclang/bin:$PATH` OR `export PATH=/path/to/gcc-arm-none-eabi-toolchain/bin:$PATH`
- If you are using the proprietary Arm Compiler, ensure that the compiler license has been correctly configured.
-- CMake version 3.15 or above is installed and available on the path. Test CMake by running:
+- CMake version 3.15.6 or above is installed and available on the path. Test CMake by running:
```commandline
cmake --version
@@ -183,7 +183,7 @@ The build parameters are:
- `Dedicated_Sram` (default for *Ethos-U65* NPU)
- `Sram_Only`
- >**Note:** The `Shared_Sram` memory mode is available on both *Ethos-U55* and *Ethos-U65* NPU, `Dedicated_Sram` only
+ > **Note:** The `Shared_Sram` memory mode is available on both *Ethos-U55* and *Ethos-U65* NPU, `Dedicated_Sram` only
> for *Ethos-U65* NPU and `Sram_Only` only for Ethos-U55* NPU.
- `ETHOS_U_NPU_CONFIG_ID`: This parameter is set by default based on the value of `ETHOS_U_NPU_ID`.
@@ -241,8 +241,8 @@ chosen configuration.
DS and other tools which can interpret the latest DWARF format. To allow debugging using the Model Debugger from Arm
Fast Model Tools Suite, this argument can be used to pass DWARF format version as "3".
- >**Note:** This option is only available when the CMake project is configured with the `-DCMAKE_BUILD_TYPE=Debug`
- >argument. Also, the same dwarf format is used for building TensorFlow Lite Micro library.
+ > **Note:** This option is only available when the CMake project is configured with the `-DCMAKE_BUILD_TYPE=Debug`
+ > argument. Also, the same dwarf format is used for building TensorFlow Lite Micro library.
For details on the specific use-case build options, follow the instructions in the use-case specific documentation.
@@ -371,8 +371,8 @@ Additional command line arguments supported by this script are:
- `ethos-u65-256`
- `ethos-u65-512`
- `--make-jobs`: Specifies the number of concurrent jobs to use for compilation.
-The default value is equal to the number of cores in the system.
-Lowering this value can be useful in case of limited resources.
+ The default value is equal to the number of cores in the system.
+ Lowering this value can be useful in case of limited resources.
- `--make-verbose`: Make the compile process verbose. This is equal to run ```make VERBOSE=1```.
To build for *Ethos™-U55* 32 MAC configuration, using `Arm Compiler`, run:
diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md
index 794bfb0..da96206 100644
--- a/docs/sections/troubleshooting.md
+++ b/docs/sections/troubleshooting.md
@@ -5,6 +5,7 @@
- [The application does not work with my custom model](./troubleshooting.md#the-application-does-not-work-with-my-custom-model)
- [NPU configuration mismatch error when running inference](./troubleshooting.md#npu-configuration-mismatch-error-when-running-inference)
- [Problem installing Vela](./troubleshooting.md#problem-installing-vela)
+ - [Errors when cloning the repository](/troubleshooting.md#errors-when-cloning-the-repository)
## Inference results are incorrect for my custom files
@@ -85,4 +86,29 @@ ERROR: Command errored out with exit status 1: /venv/bin/python -u -c 'import sy
To solve this issue install libpython3 on the system.
-Next section of the documentation: [Appendix](appendix.md). \ No newline at end of file
+## Errors when cloning the repository
+
+If you see following errors when cloning the repository:
+
+- ```log
+ fatal: unable to access 'https://review.mlplatform.org/ml/ethos-u/ml-embedded-evaluation-kit/': server certificate verification failed. CAfile: /etc/ssl/certs/ca-certificates.crt CRLfile: none
+ ```
+
+ We suggest to update to the lastest common CA certificates:
+
+ ```commandline
+ sudo apt-get update
+ sudo apt-get install ca-certificates
+ ```
+
+- ```log
+ fatal: unable to access 'https://review.mlplatform.org/ml/ethos-u/ml-embedded-evaluation-kit/': error:06FFF089:digital envelope routines:CRYPTO_internal:bad key length
+ ```
+
+ We suggest to export the `CURL_SSL_BACKEND` variable as `secure-transport`:
+
+ ```commandline
+ export CURL_SSL_BACKEND="secure-transport"
+ ```
+
+Next section of the documentation: [Appendix](appendix.md).