MLECO-2614: Minor documentation updates
* Adding troubleshooting for cloning errors
Change-Id: Ib57353900064c68c30ecb2141602081180c50c99
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
diff --git a/docs/documentation.md b/docs/documentation.md
index 2ec2028..48db0a0 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -33,7 +33,7 @@
- At least one of the following toolchains:
- GNU Arm Embedded toolchain (version 10.2.1 or above) -
[GNU Arm Embedded toolchain downloads](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
- - Arm Compiler (version 6.15 or above) with a valid license -
+ - Arm Compiler (version 6.16 or above) with a valid license -
[Arm Compiler download Page](https://developer.arm.com/tools-and-software/embedded/arm-compiler/downloads)
- An Arm® MPS3 FPGA prototyping board and components for FPGA evaluation or a `Fixed Virtual Platform` binary:
@@ -44,7 +44,7 @@
- `Arm Corstone-300` based FVP for MPS3 is available from:
<https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps>.
-> **NOTE**: There are two Arm® Corstone™-300 implementations available for the MPS3 FPGA board - application
+> **Note:**: There are two Arm® Corstone™-300 implementations available for the MPS3 FPGA board - application
> notes `AN547` and `AN552`. We are aligned with the latest application note `AN552`. However, the application built
> for MPS3 target should work on both FPGA packages.
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 @@
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 @@
```
```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 @@
```
> **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 @@
- `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 @@
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 @@
- `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 @@
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).
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md
index 2824def..d6e2681 100644
--- a/docs/use_cases/inference_runner.md
+++ b/docs/use_cases/inference_runner.md
@@ -272,7 +272,7 @@
This feature depends on these addresses to be specified in target platform's CMake description and, by
default, is available for use on the MPS3 FVP platform.
-> **NOTE**: The application built with this support will not work on the FPGA. This capability is only
+> **Note:**: The application built with this support will not work on the FPGA. This capability is only
> provided for use with the FVP, to make it easier to try different ML workloads without having to build
> the applications with different TFLite files baked into the application statically.
> Also, this feature is not available for `native` target.
@@ -305,7 +305,7 @@
and when the FVP exits, it dumps a file named `output.bin` with the output tensors consolidated into a
binary blob.
-> **NOTE** The CMake profile for the target should also give an indication of the maximum sizes for
+> **Note:** The CMake profile for the target should also give an indication of the maximum sizes for
> each of the regions. This is also mentioned in the linker scripts for the same target. For MPS3,
> the model size can be a maximum of 32MiB. The IFM and OFM spaces are both reserved as 16MiB sections.
@@ -324,7 +324,7 @@
parameter to check the size of the output first by looking at the application log. Alternatively, a
size of 16MiB will dump the whole reserved section for the OFM to a file.
-> **NOTE**: When there are multiple input tensors, the application is set up to iterate over all of
+> **Note:**: When there are multiple input tensors, the application is set up to iterate over all of
> them and populate each of them, in sequence, with the required amount of data. The sequence in which
> these tensors are populated is governed by the index assigned to them within the TensorFlow Lite Micro
> framework. So, the input binary blob should be a consolidated file containing data for all the input