summaryrefslogtreecommitdiff
path: root/docs/use_cases
diff options
context:
space:
mode:
authorIsabella Gottardi <isabella.gottardi@arm.com>2021-04-20 14:08:52 +0100
committerIsabella Gottardi <isabella.gottardi@arm.com>2021-04-23 17:52:15 +0100
commit8520983b8e73bf25826fab4cc99fc656b11fabc0 (patch)
tree5cf071084c567b0e013215261538e235a6568f45 /docs/use_cases
parentb88705d6c04d8b7b2fdffaf1501042b984e682cf (diff)
downloadml-embedded-evaluation-kit-8520983b8e73bf25826fab4cc99fc656b11fabc0.tar.gz
MLECO-1871: Adding external use-case directories support
* Cmake updates * Markdownlint on docs * Removing windows command leftovers Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com> Change-Id: I4a12b4e798559e8f4e8a3307038df7829137184a
Diffstat (limited to 'docs/use_cases')
-rw-r--r--docs/use_cases/ad.md35
-rw-r--r--docs/use_cases/asr.md5
-rw-r--r--docs/use_cases/img_class.md4
-rw-r--r--docs/use_cases/inference_runner.md2
-rw-r--r--docs/use_cases/kws.md6
-rw-r--r--docs/use_cases/kws_asr.md4
6 files changed, 18 insertions, 38 deletions
diff --git a/docs/use_cases/ad.md b/docs/use_cases/ad.md
index 93a9993..82da9e5 100644
--- a/docs/use_cases/ad.md
+++ b/docs/use_cases/ad.md
@@ -1,19 +1,19 @@
# Anomaly Detection Code Sample
- - [Introduction](#introduction)
- - [Prerequisites](#prerequisites)
- - [Building the code sample application from sources](#building-the-code-sample-application-from-sources)
- - [Build options](#build-options)
- - [Build process](#build-process)
- - [Add custom input](#add-custom-input)
- - [Add custom model](#add-custom-model)
- - [Setting-up and running Ethos-U55 Code Sample](#setting-up-and-running-ethos-u55-code-sample)
- - [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Anomaly Detection](#running-anomaly-detection)
- - [Anomaly Detection processing information](#anomaly-detection-processing-information)
- - [Preprocessing and feature extraction](#preprocessing-and-feature-extraction)
- - [Postprocessing](#postprocessing)
+- [Introduction](#introduction)
+ - [Prerequisites](#prerequisites)
+- [Building the code sample application from sources](#building-the-code-sample-application-from-sources)
+ - [Build options](#build-options)
+ - [Build process](#build-process)
+ - [Add custom input](#add-custom-input)
+ - [Add custom model](#add-custom-model)
+- [Setting-up and running Ethos-U55 Code Sample](#setting-up-and-running-ethos-u55-code-sample)
+ - [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model)
+ - [Starting Fast Model simulation](#starting-fast-model-simulation)
+ - [Running Anomaly Detection](#running-anomaly-detection)
+- [Anomaly Detection processing information](#anomaly-detection-processing-information)
+ - [Preprocessing and feature extraction](#preprocessing-and-feature-extraction)
+ - [Postprocessing](#postprocessing)
## Introduction
@@ -183,8 +183,6 @@ If the CMake command succeeded, build the application as follows:
make -j4
```
-For Windows, use `mingw32-make`.
-
Add VERBOSE=1 to see compilation and link details.
Results of the build will be placed under `build/bin` folder:
@@ -248,7 +246,8 @@ cmake \
-DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake \
-DUSE_CASE_BUILD=ad ..
```
-The images found in the _DIR folder will be picked up and automatically converted to C++ files during the CMake
+
+The audio flies found in the `ad_FILE_PATH` folder will be picked up and automatically converted to C++ files during the CMake
configuration stage and then compiled into the application during the build phase for performing inference with.
The log from the configuration stage should tell you what image directory path has been used:
@@ -277,8 +276,6 @@ cmake \
-DUSE_CASE_BUILD=ad ..
```
-For Windows, add `-G "MinGW Makefiles"` to the CMake command.
-
> **Note:** Clean the build directory before re-running the CMake command.
The `.tflite` model file pointed to by `ad_MODEL_TFLITE_PATH` will be converted
diff --git a/docs/use_cases/asr.md b/docs/use_cases/asr.md
index 9da2603..d20dc5a 100644
--- a/docs/use_cases/asr.md
+++ b/docs/use_cases/asr.md
@@ -154,6 +154,7 @@ cmake \
-DCMAKE_TOOLCHAIN_FILE=./scripts/cmake/bare-metal-toolchain.cmake \
-DUSE_CASE_BUILD=asr ..
```
+
Toolchain option `CMAKE_TOOLCHAIN_FILE` points to the toolchain specific file to set the compiler and platform specific
parameters.
@@ -223,8 +224,6 @@ If the CMake command succeeded, build the application as follows:
make -j4
```
-For Windows, use `mingw32-make`.
-
Add `VERBOSE=1` to see compilation and link details.
Results of the build will be placed under `build/bin` folder:
@@ -326,8 +325,6 @@ cmake \
-DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake ..
```
-For Windows, add `-G "MinGW Makefiles"` to the CMake command.
-
> **Note:** Clean the build directory before re-running the CMake command.
The `.tflite` model file pointed to by `asr_MODEL_TFLITE_PATH` and labels text file pointed to by `asr_LABELS_TXT_FILE`
diff --git a/docs/use_cases/img_class.md b/docs/use_cases/img_class.md
index 40d80b0..0102409 100644
--- a/docs/use_cases/img_class.md
+++ b/docs/use_cases/img_class.md
@@ -152,8 +152,6 @@ If the CMake command succeeds, build the application as follows:
make -j4
```
-For Windows, use `mingw32-make`.
-
Add VERBOSE=1 to see compilation and link details.
Results of the build will be placed under `build/bin` folder:
@@ -260,8 +258,6 @@ cmake \
-DUSE_CASE_BUILD=img_class ..
```
-For Windows, add `-G "MinGW Makefiles"` to the CMake command.
-
> **Note:** Clean the build directory before re-running the CMake command.
The `.tflite` model file pointed to by `img_class_MODEL_TFLITE_PATH` and labels text file pointed to by
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md
index d090caa..ad47e7e 100644
--- a/docs/use_cases/inference_runner.md
+++ b/docs/use_cases/inference_runner.md
@@ -144,8 +144,6 @@ If the CMake command succeeded, build the application as follows:
make -j4
```
-For Windows, use `mingw32-make`.
-
Add VERBOSE=1 to see compilation and link details.
Results of the build will be placed under `build/bin` folder:
diff --git a/docs/use_cases/kws.md b/docs/use_cases/kws.md
index 10b4662..baf813a 100644
--- a/docs/use_cases/kws.md
+++ b/docs/use_cases/kws.md
@@ -190,8 +190,6 @@ If the CMake command succeeded, build the application as follows:
make -j4
```
-For Windows, use `mingw32-make`.
-
Add VERBOSE=1 to see compilation and link details.
Results of the build will be placed under `build/bin` folder:
@@ -292,8 +290,6 @@ cmake \
-DCMAKE_TOOLCHAIN_FILE=scripts/cmake/bare-metal-toolchain.cmake ..
```
-For Windows, add `-G "MinGW Makefiles"` to the CMake command.
-
> **Note:** Clean the build directory before re-running the CMake command.
The `.tflite` model file pointed to by `kws_MODEL_TFLITE_PATH` and labels text file pointed to by `kws_LABELS_TXT_FILE` will
@@ -470,4 +466,4 @@ The profiling section of the log shows that for this inference:
- For FPGA platforms, CPU cycle count can also be enabled. For FVP, however, CPU cycle counters should not be used as
the CPU model is not cycle-approximate or cycle-accurate.
-The application prints the highest confidence score and the associated label from ds_cnn_labels.txt file. \ No newline at end of file
+The application prints the highest confidence score and the associated label from ds_cnn_labels.txt file.
diff --git a/docs/use_cases/kws_asr.md b/docs/use_cases/kws_asr.md
index 950d576..a347b16 100644
--- a/docs/use_cases/kws_asr.md
+++ b/docs/use_cases/kws_asr.md
@@ -261,8 +261,6 @@ If the CMake command succeeded, build the application as follows:
make -j4
```
-For Windows, use `mingw32-make`.
-
Add VERBOSE=1 to see compilation and link details.
Results of the build will be placed under `build/bin` folder:
@@ -359,8 +357,6 @@ cmake \
-DUSE_CASE_BUILD=kws_asr ..
```
-For Windows, add `-G "MinGW Makefiles"` to the CMake command.
-
> **Note:** Clean the build directory before re-running the CMake command.
The `.tflite` model files pointed to by `kws_asr_MODEL_TFLITE_PATH_KWS` and `kws_asr_MODEL_TFLITE_PATH_ASR`, labels text files pointed to by `kws_asr_LABELS_TXT_FILE_KWS` and `kws_asr_LABELS_TXT_FILE_ASR`