summaryrefslogtreecommitdiff
path: root/docs/use_cases
diff options
context:
space:
mode:
authorCisco Cervellera <cisco.cervellera@arm.com>2021-11-16 09:54:20 +0000
committerCisco Cervellera <cisco.cervellera@arm.com>2021-11-16 09:54:20 +0000
commite7a0393973a1a1c1ed05b1bf1838fe931416890a (patch)
tree8127d74bf1024ee6f45a07100216162d346ae2a2 /docs/use_cases
parentb52b585f1c9ee3f2800fa51f3031117ed1396abd (diff)
downloadml-embedded-evaluation-kit-e7a0393973a1a1c1ed05b1bf1838fe931416890a.tar.gz
MLECO-2520: Change md files to have correct file links
Change-Id: I3ec18583c321eb2815a670d56f4958e610331d6d
Diffstat (limited to 'docs/use_cases')
-rw-r--r--docs/use_cases/ad.md28
-rw-r--r--docs/use_cases/asr.md28
-rw-r--r--docs/use_cases/img_class.md26
-rw-r--r--docs/use_cases/inference_runner.md28
-rw-r--r--docs/use_cases/kws.md28
-rw-r--r--docs/use_cases/kws_asr.md32
-rw-r--r--docs/use_cases/noise_reduction.md38
-rw-r--r--docs/use_cases/visual_wake_word.md24
8 files changed, 116 insertions, 116 deletions
diff --git a/docs/use_cases/ad.md b/docs/use_cases/ad.md
index f953f72..c14c921 100644
--- a/docs/use_cases/ad.md
+++ b/docs/use_cases/ad.md
@@ -1,19 +1,19 @@
# Anomaly Detection Code Sample
-- [Anomaly Detection Code Sample](#anomaly-detection-code-sample)
- - [Introduction](#introduction)
- - [Preprocessing and feature extraction](#preprocessing-and-feature-extraction)
- - [Postprocessing](#postprocessing)
- - [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-U NPU Code Sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Anomaly Detection](#running-anomaly-detection)
+- [Anomaly Detection Code Sample](./ad.md#anomaly-detection-code-sample)
+ - [Introduction](./ad.md#introduction)
+ - [Preprocessing and feature extraction](./ad.md#preprocessing-and-feature-extraction)
+ - [Postprocessing](./ad.md#postprocessing)
+ - [Prerequisites](./ad.md#prerequisites)
+ - [Building the code sample application from sources](./ad.md#building-the-code-sample-application-from-sources)
+ - [Build options](./ad.md#build-options)
+ - [Build process](./ad.md#build-process)
+ - [Add custom input](./ad.md#add-custom-input)
+ - [Add custom model](./ad.md#add-custom-model)
+ - [Setting-up and running Ethos-U NPU Code Sample](./ad.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./ad.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./ad.md#starting-fast-model-simulation)
+ - [Running Anomaly Detection](./ad.md#running-anomaly-detection)
## Introduction
diff --git a/docs/use_cases/asr.md b/docs/use_cases/asr.md
index f7daf7a..bbcde92 100644
--- a/docs/use_cases/asr.md
+++ b/docs/use_cases/asr.md
@@ -1,19 +1,19 @@
# Automatic Speech Recognition Code Sample
-- [Automatic Speech Recognition Code Sample](#automatic-speech-recognition-code-sample)
- - [Introduction](#introduction)
- - [Preprocessing and feature extraction](#preprocessing-and-feature-extraction)
- - [Postprocessing](#postprocessing)
- - [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-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Automatic Speech Recognition](#running-automatic-speech-recognition)
+- [Automatic Speech Recognition Code Sample](./asr.md#automatic-speech-recognition-code-sample)
+ - [Introduction](./asr.md#introduction)
+ - [Preprocessing and feature extraction](./asr.md#preprocessing-and-feature-extraction)
+ - [Postprocessing](./asr.md#postprocessing)
+ - [Prerequisites](./asr.md#prerequisites)
+ - [Building the code sample application from sources](./asr.md#building-the-code-sample-application-from-sources)
+ - [Build options](./asr.md#build-options)
+ - [Build process](./asr.md#build-process)
+ - [Add custom input](./asr.md#add-custom-input)
+ - [Add custom model](./asr.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./asr.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./asr.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./asr.md#starting-fast-model-simulation)
+ - [Running Automatic Speech Recognition](./asr.md#running-automatic-speech-recognition)
## Introduction
diff --git a/docs/use_cases/img_class.md b/docs/use_cases/img_class.md
index ea70ea5..7924ed5 100644
--- a/docs/use_cases/img_class.md
+++ b/docs/use_cases/img_class.md
@@ -1,17 +1,17 @@
# Image Classification Code Sample
-- [Image Classification Code Sample](#image-classification-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-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Image Classification](#running-image-classification)
+- [Image Classification Code Sample](./img_class.md#image-classification-code-sample)
+ - [Introduction](./img_class.md#introduction)
+ - [Prerequisites](./img_class.md#prerequisites)
+ - [Building the code sample application from sources](./img_class.md#building-the-code-sample-application-from-sources)
+ - [Build options](./img_class.md#build-options)
+ - [Build process](./img_class.md#build-process)
+ - [Add custom input](./img_class.md#add-custom-input)
+ - [Add custom model](./img_class.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./img_class.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./img_class.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./img_class.md#starting-fast-model-simulation)
+ - [Running Image Classification](./img_class.md#running-image-classification)
## Introduction
@@ -48,7 +48,7 @@ specifies:
be used in the application. The default value points to the `resources/img_class/samples` folder containing the
delivered set of images.
- For further information, please refer to: [Add custom input data section](#add-custom-input).
+ For further information, please refer to: [Add custom input data section](./img_class.md#add-custom-input).
- `img_class_IMAGE_SIZE`: The NN model requires input images to be of a specific size. This parameter defines the size
of the image side in pixels. Images are considered squared. The default value is `224`, which is what the supplied
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md
index 2b2013c..01bf4d0 100644
--- a/docs/use_cases/inference_runner.md
+++ b/docs/use_cases/inference_runner.md
@@ -1,18 +1,18 @@
# Inference Runner Code Sample
-- [Inference Runner Code Sample](#inference-runner-code-sample)
- - [Introduction](#introduction)
- - [Prerequisites](#prerequisites)
- - [Building the Code Samples application from sources](#building-the-code-samples-application-from-sources)
- - [Build options](#build-options)
- - [Build process](#build-process)
- - [Add custom model](#add-custom-model)
- - [Setting up and running Ethos-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Inference Runner](#running-inference-runner)
- - [Building with dynamic model load capability](#building-with-dynamic-model-load-capability)
- - [Running the FVP with dynamic model loading](#running-the-fvp-with-dynamic-model-loading)
+- [Inference Runner Code Sample](./inference_runner.md#inference-runner-code-sample)
+ - [Introduction](./inference_runner.md#introduction)
+ - [Prerequisites](./inference_runner.md#prerequisites)
+ - [Building the Code Samples application from sources](./inference_runner.md#building-the-code-samples-application-from-sources)
+ - [Build options](./inference_runner.md#build-options)
+ - [Build process](./inference_runner.md#build-process)
+ - [Add custom model](./inference_runner.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./inference_runner.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./inference_runner.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./inference_runner.md#starting-fast-model-simulation)
+ - [Running Inference Runner](./inference_runner.md#running-inference-runner)
+ - [Building with dynamic model load capability](./inference_runner.md#building-with-dynamic-model-load-capability)
+ - [Running the FVP with dynamic model loading](./inference_runner.md#running-the-fvp-with-dynamic-model-loading)
## Introduction
@@ -57,7 +57,7 @@ following:
- `inference_runner_ACTIVATION_BUF_SZ`: The intermediate, or activation, buffer size reserved for the NN model. By
default, it is set to 2MiB and is enough for most models.
-- `inference_runner_DYNAMIC_MEM_LOAD_ENABLED`: This can be set to ON or OFF, to allow dynamic model load capability for use with MPS3 FVPs. See section [Building with dynamic model load capability](#building-with-dynamic-model-load-capability) below for more details.
+- `inference_runner_DYNAMIC_MEM_LOAD_ENABLED`: This can be set to ON or OFF, to allow dynamic model load capability for use with MPS3 FVPs. See section [Building with dynamic model load capability](./inference_runner.md#building-with-dynamic-model-load-capability) below for more details.
To build **ONLY** the Inference Runner example application, add `-DUSE_CASE_BUILD=inferece_runner` to the `cmake`
command line, as specified in: [Building](../documentation.md#Building).
diff --git a/docs/use_cases/kws.md b/docs/use_cases/kws.md
index 11d4146..84eddd6 100644
--- a/docs/use_cases/kws.md
+++ b/docs/use_cases/kws.md
@@ -1,19 +1,19 @@
# Keyword Spotting Code Sample
-- [Keyword Spotting Code Sample](#keyword-spotting-code-sample)
- - [Introduction](#introduction)
- - [Preprocessing and feature extraction](#preprocessing-and-feature-extraction)
- - [Postprocessing](#postprocessing)
- - [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-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Keyword Spotting](#running-keyword-spotting)
+- [Keyword Spotting Code Sample](./kws.md#keyword-spotting-code-sample)
+ - [Introduction](./kws.md#introduction)
+ - [Preprocessing and feature extraction](./kws.md#preprocessing-and-feature-extraction)
+ - [Postprocessing](./kws.md#postprocessing)
+ - [Prerequisites](./kws.md#prerequisites)
+ - [Building the code sample application from sources](./kws.md#building-the-code-sample-application-from-sources)
+ - [Build options](./kws.md#build-options)
+ - [Build process](./kws.md#build-process)
+ - [Add custom input](./kws.md#add-custom-input)
+ - [Add custom model](./kws.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./kws.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./kws.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./kws.md#starting-fast-model-simulation)
+ - [Running Keyword Spotting](./kws.md#running-keyword-spotting)
## Introduction
diff --git a/docs/use_cases/kws_asr.md b/docs/use_cases/kws_asr.md
index bac1039..42c9d3a 100644
--- a/docs/use_cases/kws_asr.md
+++ b/docs/use_cases/kws_asr.md
@@ -1,21 +1,21 @@
# Keyword Spotting and Automatic Speech Recognition Code Sample
-- [Keyword Spotting and Automatic Speech Recognition Code Sample](#keyword-spotting-and-automatic-speech-recognition-code-sample)
- - [Introduction](#introduction)
- - [Preprocessing and feature extraction](#preprocessing-and-feature-extraction)
- - [Keyword Spotting Preprocessing](#keyword-spotting-preprocessing)
- - [Automatic Speech Recognition Preprocessing](#automatic-speech-recognition-preprocessing)
- - [Postprocessing](#postprocessing)
- - [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-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Keyword Spotting and Automatic Speech Recognition](#running-keyword-spotting-and-automatic-speech-recognition)
+- [Keyword Spotting and Automatic Speech Recognition Code Sample](./kws_asr.md#keyword-spotting-and-automatic-speech-recognition-code-sample)
+ - [Introduction](./kws_asr.md#introduction)
+ - [Preprocessing and feature extraction](./kws_asr.md#preprocessing-and-feature-extraction)
+ - [Keyword Spotting Preprocessing](./kws_asr.md#keyword-spotting-preprocessing)
+ - [Automatic Speech Recognition Preprocessing](./kws_asr.md#automatic-speech-recognition-preprocessing)
+ - [Postprocessing](./kws_asr.md#postprocessing)
+ - [Prerequisites](./kws_asr.md#prerequisites)
+ - [Building the code sample application from sources](./kws_asr.md#building-the-code-sample-application-from-sources)
+ - [Build options](./kws_asr.md#build-options)
+ - [Build process](./kws_asr.md#build-process)
+ - [Add custom input](./kws_asr.md#add-custom-input)
+ - [Add custom model](./kws_asr.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./kws_asr.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./kws_asr.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./kws_asr.md#starting-fast-model-simulation)
+ - [Running Keyword Spotting and Automatic Speech Recognition](./kws_asr.md#running-keyword-spotting-and-automatic-speech-recognition)
## Introduction
diff --git a/docs/use_cases/noise_reduction.md b/docs/use_cases/noise_reduction.md
index e6df89c..cd89091 100644
--- a/docs/use_cases/noise_reduction.md
+++ b/docs/use_cases/noise_reduction.md
@@ -1,21 +1,21 @@
# Noise Reduction Code Sample
-- [Noise Reduction Code Sample](#noise-reduction-code-sample)
- - [Introduction](#introduction)
- - [How the default neural network model works](#how-the-default-neural-network-model-works)
- - [Post-processing](#post_processing)
- - [Dumping of memory contents from the Fixed Virtual Platform](#dumping-of-memory-contents-from-the-fixed-virtual-platform)
- - [Dumping post processed results for all inferences](#dumping-post_processed-results-for-all-inferences)
- - [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-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Noise Reduction](#running-noise-reduction)
+- [Noise Reduction Code Sample](./noise_reduction.md#noise-reduction-code-sample)
+ - [Introduction](./noise_reduction.md#introduction)
+ - [How the default neural network model works](./noise_reduction.md#how-the-default-neural-network-model-works)
+ - [Post-processing](./noise_reduction.md#post_processing)
+ - [Dumping of memory contents from the Fixed Virtual Platform](./noise_reduction.md#dumping-of-memory-contents-from-the-fixed-virtual-platform)
+ - [Dumping post processed results for all inferences](./noise_reduction.md#dumping-post_processed-results-for-all-inferences)
+ - [Prerequisites](./noise_reduction.md#prerequisites)
+ - [Building the code sample application from sources](./noise_reduction.md#building-the-code-sample-application-from-sources)
+ - [Build options](./noise_reduction.md#build-options)
+ - [Build process](./noise_reduction.md#build-process)
+ - [Add custom input](./noise_reduction.md#add-custom-input)
+ - [Add custom model](./noise_reduction.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./noise_reduction.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./noise_reduction.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./noise_reduction.md#starting-fast-model-simulation)
+ - [Running Noise Reduction](./noise_reduction.md#running-noise-reduction)
## Introduction
@@ -71,7 +71,7 @@ For you to verify the outputs of the model after post-processing, you will have
to convert the post-processed outputs into a wav file.
This offline script takes a dump file as the input and saves the denoised WAV file to disk. The following is an example
of how to call the script from the command line after running the use-case and
-[selecting to dump memory contents](#dumping-post_processed-results-for-all-inferences).
+[selecting to dump memory contents](./noise_reduction.md#dumping-post_processed-results-for-all-inferences).
```commandline
python scripts/py/rnnoise_dump_extractor.py --dump_file <path_to_dump_file.bin> --output_dir <path_to_output_folder>
@@ -284,7 +284,7 @@ cmake .. \
> **Note** Changing the neural network model often also requires the pre-processing implementation
> to be changed. Please refer to:
-> [How the default neural network model works](#how-the-default-neural-network-model-works).
+> [How the default neural network model works](./noise_reduction.md#how-the-default-neural-network-model-works).
> **Note:** Before re-running the CMake command, clean the build directory.
@@ -504,7 +504,7 @@ INFO - NPU TOTAL cycles: 104514
> **Note:** When running Fast Model, each inference can take several seconds on most systems.
Each inference dumps the post processed output to memory. For further information, please refer to:
-[Dumping post processed results for all inferences](#dumping-post_processed-results-for-all-inferences).
+[Dumping post processed results for all inferences](./noise_reduction.md#dumping-post_processed-results-for-all-inferences).
The profiling section of the log shows that for this inference:
diff --git a/docs/use_cases/visual_wake_word.md b/docs/use_cases/visual_wake_word.md
index a011d5e..918402d 100644
--- a/docs/use_cases/visual_wake_word.md
+++ b/docs/use_cases/visual_wake_word.md
@@ -1,17 +1,17 @@
# Visual Wake Word Code Sample
-- [Visual Wake Word Code Sample](#visual-wake-word-code-sample)
- - [Introduction](#introduction)
- - [Prerequisites](#prerequisites)
- - [Building the Code Samples application from sources](#building-the-code-samples-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-U NPU code sample](#setting-up-and-running-ethos_u-npu-code-sample)
- - [Setting up the Ethos-U NPU Fast Model](#setting-up-the-ethos_u-npu-fast-model)
- - [Starting Fast Model simulation](#starting-fast-model-simulation)
- - [Running Visual Wake Word](#running-visual-wake-word)
+- [Visual Wake Word Code Sample](./visual_wake_word.md#visual-wake-word-code-sample)
+ - [Introduction](./visual_wake_word.md#introduction)
+ - [Prerequisites](./visual_wake_word.md#prerequisites)
+ - [Building the Code Samples application from sources](./visual_wake_word.md#building-the-code-samples-application-from-sources)
+ - [Build options](./visual_wake_word.md#build-options)
+ - [Build process](./visual_wake_word.md#build-process)
+ - [Add custom input](./visual_wake_word.md#add-custom-input)
+ - [Add custom model](./visual_wake_word.md#add-custom-model)
+ - [Setting up and running Ethos-U NPU code sample](./visual_wake_word.md#setting-up-and-running-ethos_u-npu-code-sample)
+ - [Setting up the Ethos-U NPU Fast Model](./visual_wake_word.md#setting-up-the-ethos_u-npu-fast-model)
+ - [Starting Fast Model simulation](./visual_wake_word.md#starting-fast-model-simulation)
+ - [Running Visual Wake Word](./visual_wake_word.md#running-visual-wake-word)
## Introduction