summaryrefslogtreecommitdiff
path: root/docs/use_cases
diff options
context:
space:
mode:
authorIsabella Gottardi <isabella.gottardi@arm.com>2021-05-12 08:27:15 +0100
committerIsabella Gottardi <isabella.gottardi@arm.com>2021-05-18 09:48:12 +0100
commit56ee6207c1524ddc4c444c6e48e05eb34105985a (patch)
treed4fc7823961034e95364f44b34fb098b34b99d0d /docs/use_cases
parentf4e2c4736f19d2e06fede715bb49c475f93d79a9 (diff)
downloadml-embedded-evaluation-kit-56ee6207c1524ddc4c444c6e48e05eb34105985a.tar.gz
MLECO-1858: Documentation update
* Removing `_` in front of private functions and member Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Change-Id: I5a5d652f9647ebb16d2d2bd16ab980e73f7be3cf
Diffstat (limited to 'docs/use_cases')
-rw-r--r--docs/use_cases/ad.md8
-rw-r--r--docs/use_cases/asr.md6
-rw-r--r--docs/use_cases/img_class.md9
-rw-r--r--docs/use_cases/inference_runner.md10
-rw-r--r--docs/use_cases/kws.md9
-rw-r--r--docs/use_cases/kws_asr.md7
6 files changed, 28 insertions, 21 deletions
diff --git a/docs/use_cases/ad.md b/docs/use_cases/ad.md
index 5f210b1..661cf49 100644
--- a/docs/use_cases/ad.md
+++ b/docs/use_cases/ad.md
@@ -110,6 +110,7 @@ On Linux, execute the following command to build **only** Anomaly Detection appl
```commandline
cmake ../ -DUSE_CASE_BUILD=ad
```
+
To configure a build that can be debugged using Arm-DS, we can just specify
the build type as `Debug` and use the `Arm Compiler` toolchain file:
@@ -121,10 +122,11 @@ cmake .. \
```
Also see:
-- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies)
+
+- [Configuring with custom TPIP dependencies](../sections/building.md#configuring-with-custom-tpip-dependencies)
- [Using Arm Compiler](../sections/building.md#using-arm-compiler)
-- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform)
-- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools)
+- [Configuring the build for simple_platform](../sections/building.md#configuring-the-build-for-simple_platform)
+- [Working with model debugger from Arm FastModel Tools](../sections/building.md#working-with-model-debugger-from-arm-fastmodel-tools)
> **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run
>the CMake command.
diff --git a/docs/use_cases/asr.md b/docs/use_cases/asr.md
index ec10fdb..a8142aa 100644
--- a/docs/use_cases/asr.md
+++ b/docs/use_cases/asr.md
@@ -162,10 +162,10 @@ cmake .. \
```
Also see:
-- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies)
+- [Configuring with custom TPIP dependencies](../sections/building.md#configuring-with-custom-tpip-dependencies)
- [Using Arm Compiler](../sections/building.md#using-arm-compiler)
-- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform)
-- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools)
+- [Configuring the build for simple_platform](../sections/building.md#configuring-the-build-for-simple_platform)
+- [Working with model debugger from Arm FastModel Tools](../sections/building.md#working-with-model-debugger-from-arm-fastmodel-tools)
> **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run
>the CMake command.
diff --git a/docs/use_cases/img_class.md b/docs/use_cases/img_class.md
index 68a5285..75f0bd6 100644
--- a/docs/use_cases/img_class.md
+++ b/docs/use_cases/img_class.md
@@ -91,10 +91,11 @@ cmake .. \
```
Also see:
-- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies)
+
+- [Configuring with custom TPIP dependencies](../sections/building.md#configuring-with-custom-tpip-dependencies)
- [Using Arm Compiler](../sections/building.md#using-arm-compiler)
-- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform)
-- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools)
+- [Configuring the build for simple_platform](../sections/building.md#configuring-the-build-for-simple_platform)
+- [Working with model debugger from Arm FastModel Tools](../sections/building.md#working-with-model-debugger-from-arm-fastmodel-tools)
> **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run
>the CMake command.
@@ -228,7 +229,7 @@ custom_model_after_vela.tflite.cc
After compiling, your custom model will have now replaced the default one in the application.
-## Setting-up and running Ethos-U55 code sample
+## Setting up and running Ethos-U55 code sample
### Setting up the Ethos-U55 Fast Model
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md
index ebc4677..b8004ed 100644
--- a/docs/use_cases/inference_runner.md
+++ b/docs/use_cases/inference_runner.md
@@ -70,6 +70,7 @@ Model when providing only the mandatory arguments for CMake configuration:
```commandline
cmake ../ -DUSE_CASE_BUILD=inference_runner
```
+
To configure a build that can be debugged using Arm-DS, we can just specify
the build type as `Debug` and use the `Arm Compiler` toolchain file:
@@ -81,10 +82,11 @@ cmake .. \
```
Also see:
-- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies)
+
+- [Configuring with custom TPIP dependencies](../sections/building.md#configuring-with-custom-tpip-dependencies)
- [Using Arm Compiler](../sections/building.md#using-arm-compiler)
-- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform)
-- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools)
+- [Configuring the build for simple_platform](../sections/building.md#configuring-the-build-for-simple_platform)
+- [Working with model debugger from Arm FastModel Tools](../sections/building.md#working-with-model-debugger-from-arm-fastmodel-tools)
> **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run
>the CMake command.
@@ -162,7 +164,7 @@ custom_model_after_vela.tflite.cc
After compiling, your custom model will have now replaced the default one in the application.
-## Setting-up and running Ethos-U55 code sample
+## Setting up and running Ethos-U55 code sample
### Setting up the Ethos-U55 Fast Model
diff --git a/docs/use_cases/kws.md b/docs/use_cases/kws.md
index 8811efb..bf3e088 100644
--- a/docs/use_cases/kws.md
+++ b/docs/use_cases/kws.md
@@ -131,10 +131,11 @@ cmake .. \
```
Also see:
-- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies)
+
+- [Configuring with custom TPIP dependencies](../sections/building.md#configuring-with-custom-tpip-dependencies)
- [Using Arm Compiler](../sections/building.md#using-arm-compiler)
-- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform)
-- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools)
+- [Configuring the build for simple_platform](../sections/building.md#configuring-the-build-for-simple_platform)
+- [Working with model debugger from Arm FastModel Tools](../sections/building.md#working-with-model-debugger-from-arm-fastmodel-tools)
> **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run the CMake command.
@@ -261,7 +262,7 @@ custom_model_after_vela.tflite.cc
After compiling, your custom model will have now replaced the default one in the application.
-## Setting-up and running Ethos-U55 code sample
+## Setting up and running Ethos-U55 code sample
### Setting up the Ethos-U55 Fast Model
diff --git a/docs/use_cases/kws_asr.md b/docs/use_cases/kws_asr.md
index b63ee3a..745a108 100644
--- a/docs/use_cases/kws_asr.md
+++ b/docs/use_cases/kws_asr.md
@@ -202,10 +202,11 @@ cmake .. \
```
Also see:
-- [Configuring with custom TPIP dependencies](../sections/building.md#Configuring-with-custom-TPIP-dependencies)
+
+- [Configuring with custom TPIP dependencies](../sections/building.md#configuring-with-custom-tpip-dependencies)
- [Using Arm Compiler](../sections/building.md#using-arm-compiler)
-- [Configuring the build for simple_platform](../sections/building.md#Configuring-the-build-for-simple_platform)
-- [Working with model debugger from Arm FastModel Tools](../sections/building.md#Working-with-model-debugger-from-Arm-FastModel-Tools)
+- [Configuring the build for simple_platform](../sections/building.md#configuring-the-build-for-simple_platform)
+- [Working with model debugger from Arm FastModel Tools](../sections/building.md#working-with-model-debugger-from-arm-fastmodel-tools)
> **Note:** If re-building with changed parameters values, it is highly advised to clean the build directory and re-run the CMake command.