MLECO-2520: Change md files to have correct file links
Change-Id: I3ec18583c321eb2815a670d56f4958e610331d6d
diff --git a/docs/documentation.md b/docs/documentation.md
index 0642075..7049630 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -1,18 +1,18 @@
# Arm® ML embedded evaluation kit
-- [Arm® ML embedded evaluation kit](#arm_ml-embedded-evaluation-kit)
- - [Trademarks](#trademarks)
- - [Prerequisites](#prerequisites)
- - [Additional reading](#additional-reading)
- - [Repository structure](#repository-structure)
- - [Models and resources](#models-and-resources)
- - [Building](#building)
- - [Deployment](#deployment)
- - [Implementing custom ML application](#implementing-custom-ml-application)
- - [Testing and benchmarking](#testing-and-benchmarking)
- - [Memory Considerations](#memory-considerations)
- - [Troubleshooting](#troubleshooting)
- - [Appendix](#appendix)
+- [Arm® ML embedded evaluation kit](./documentation.md#arm_ml-embedded-evaluation-kit)
+ - [Trademarks](./documentation.md#trademarks)
+ - [Prerequisites](./documentation.md#prerequisites)
+ - [Additional reading](./documentation.md#additional-reading)
+ - [Repository structure](./documentation.md#repository-structure)
+ - [Models and resources](./documentation.md#models-and-resources)
+ - [Building](./documentation.md#building)
+ - [Deployment](./documentation.md#deployment)
+ - [Implementing custom ML application](./documentation.md#implementing-custom-ml-application)
+ - [Testing and benchmarking](./documentation.md#testing-and-benchmarking)
+ - [Memory Considerations](./documentation.md#memory-considerations)
+ - [Troubleshooting](./documentation.md#troubleshooting)
+ - [Appendix](./documentation.md#appendix)
## Trademarks
diff --git a/docs/quick_start.md b/docs/quick_start.md
index 7613912..fc48149 100644
--- a/docs/quick_start.md
+++ b/docs/quick_start.md
@@ -124,6 +124,12 @@
--output ./resources_downloaded/noise_reduction/ofm4.npy
curl -L https://github.com/ARM-software/ML-zoo/raw/68b5fbc77ed28e67b2efc915997ea4477c1d9d5b/models/keyword_spotting/dnn_small/tflite_int8/dnn_s_quantized.tflite \
--output ./resources_downloaded/inference_runner/dnn_s_quantized.tflite
+curl -L https://github.com/ARM-software/ML-zoo/raw/7dd3b16bb84007daf88be8648983c07f3eb21140/models/visual_wake_words/micronet_vww4/tflite_int8/vww4_128_128_INT8.tflite \
+ --output ./resources_downloaded/vww/vww4_128_128_INT8.tflite
+curl -L https://github.com/ARM-software/ML-zoo/raw/7dd3b16bb84007daf88be8648983c07f3eb21140/models/visual_wake_words/micronet_vww4/tflite_int8/testing_input/input/0.npy \
+ --output ./resources_downloaded/vww/ifm0.npy
+curl -L https://github.com/ARM-software/ML-zoo/raw/7dd3b16bb84007daf88be8648983c07f3eb21140/models/visual_wake_words/micronet_vww4/tflite_int8/testing_output/Identity/0.npy \
+ --output ./resources_downloaded/vww/ofm0.npy
. resources_downloaded/env/bin/activate && vela resources_downloaded/kws/ds_cnn_clustered_int8.tflite \
--accelerator-config=ethos-u55-128 \
diff --git a/docs/sections/arm_virtual_hardware.md b/docs/sections/arm_virtual_hardware.md
index ca60a28..cb5ed48 100644
--- a/docs/sections/arm_virtual_hardware.md
+++ b/docs/sections/arm_virtual_hardware.md
@@ -1,5 +1,5 @@
-- [Overview](#overview)
- - [Getting started](#getting-started)
+- [Overview](./arm_virtual_hardware.md#overview)
+ - [Getting started](./arm_virtual_hardware.md#getting-started)
# Overview
diff --git a/docs/sections/building.md b/docs/sections/building.md
index f2911a8..28130d6 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -1,29 +1,29 @@
# Building the ML embedded code sample applications from sources
-- [Building the ML embedded code sample applications from sources](#building-the-ml-embedded-code-sample-applications-from-sources)
- - [Build prerequisites](#build-prerequisites)
- - [Build options](#build-options)
- - [Build process](#build-process)
- - [Preparing build environment](#preparing-build-environment)
- - [Fetching submodules](#fetching-submodules)
- - [Fetching resource files](#fetching-resource-files)
- - [Building for default configuration](#building-for-default-configuration)
- - [Create a build directory](#create-a-build-directory)
- - [Configuring the build for MPS3 SSE-300](#configuring-the-build-for-mps3-sse_300)
- - [Using GNU Arm Embedded toolchain](#using-gnu-arm-embedded-toolchain)
- - [Using Arm Compiler](#using-arm-compiler)
- - [Generating project for Arm Development Studio](#generating-project-for-arm-development-studio)
- - [Working with model debugger from Arm Fast Model Tools](#working-with-model-debugger-from-arm-fast-model-tools)
- - [Configuring with custom TPIP dependencies](#configuring-with-custom-tpip-dependencies)
- - [Configuring native unit-test build](#configuring-native-unit_test-build)
- - [Configuring the build for simple-platform](#configuring-the-build-for-simple_platform)
- - [Building the configured project](#building-the-configured-project)
- - [Building timing adapter with custom options](#building-timing-adapter-with-custom-options)
- - [Add custom inputs](#add-custom-inputs)
- - [Add custom model](#add-custom-model)
- - [Optimize custom model with Vela compiler](#optimize-custom-model-with-vela-compiler)
- - [Building for different Ethos-U NPU variants](#building-for-different-ethos_u-npu-variants)
- - [Automatic file generation](#automatic-file-generation)
+- [Building the ML embedded code sample applications from sources](./building.md#building-the-ml-embedded-code-sample-applications-from-sources)
+ - [Build prerequisites](./building.md#build-prerequisites)
+ - [Build options](./building.md#build-options)
+ - [Build process](./building.md#build-process)
+ - [Preparing build environment](./building.md#preparing-build-environment)
+ - [Fetching submodules](./building.md#fetching-submodules)
+ - [Fetching resource files](./building.md#fetching-resource-files)
+ - [Building for default configuration](./building.md#building-for-default-configuration)
+ - [Create a build directory](./building.md#create-a-build-directory)
+ - [Configuring the build for MPS3 SSE-300](./building.md#configuring-the-build-for-mps3-sse_300)
+ - [Using GNU Arm Embedded toolchain](./building.md#using-gnu-arm-embedded-toolchain)
+ - [Using Arm Compiler](./building.md#using-arm-compiler)
+ - [Generating project for Arm Development Studio](./building.md#generating-project-for-arm-development-studio)
+ - [Working with model debugger from Arm Fast Model Tools](./building.md#working-with-model-debugger-from-arm-fast-model-tools)
+ - [Configuring with custom TPIP dependencies](./building.md#configuring-with-custom-tpip-dependencies)
+ - [Configuring native unit-test build](./building.md#configuring-native-unit_test-build)
+ - [Configuring the build for simple-platform](./building.md#configuring-the-build-for-simple_platform)
+ - [Building the configured project](./building.md#building-the-configured-project)
+ - [Building timing adapter with custom options](./building.md#building-timing-adapter-with-custom-options)
+ - [Add custom inputs](./building.md#add-custom-inputs)
+ - [Add custom model](./building.md#add-custom-model)
+ - [Optimize custom model with Vela compiler](./building.md#optimize-custom-model-with-vela-compiler)
+ - [Building for different Ethos-U NPU variants](./building.md#building-for-different-ethos_u-npu-variants)
+ - [Automatic file generation](./building.md#automatic-file-generation)
This section assumes that you are using an **x86 Linux** build machine.
@@ -109,7 +109,7 @@
- Access to the internet to download the third-party dependencies, specifically: TensorFlow Lite Micro, Arm®
*Ethos™-U55* NPU driver, and CMSIS. Instructions for downloading these are listed under:
- [preparing build environment](#preparing-build-environment).
+ [preparing build environment](./building.md#preparing-build-environment).
## Build options
@@ -173,7 +173,7 @@
configuration for all the use cases. If the user has overridden use-case specific model path
parameter `ETHOS_U_NPU_CONFIG_ID` parameter will become irrelevant for that use-case. Also, the
model files for the chosen `ETHOS_U_NPU_CONFIG_ID` are expected to exist in the default locations.
-See [Fetching resource files](#fetching-resource-files) for details on how to do this for your
+See [Fetching resource files](./building.md#fetching-resource-files) for details on how to do this for your
chosen configuration.
- `CPU_PROFILE_ENABLED`: Sets whether profiling information for the CPU core should be displayed. By default, this is
@@ -232,7 +232,7 @@
The build process uses three major steps:
1. Prepare the build environment by downloading third-party sources required, see
- [Preparing build environment](#preparing-build-environment).
+ [Preparing build environment](./building.md#preparing-build-environment).
2. Configure the build for the platform chosen. This stage includes:
- CMake options configuration
@@ -240,11 +240,11 @@
downloaded from [Arm ML-Zoo](https://github.com/ARM-software/ML-zoo). For native builds, the network input and
output data for tests are downloaded.
- Some files such as neural network models, network inputs, and output labels are automatically converted into C/C++
- arrays, see: [Automatic file generation](#automatic-file-generation).
+ arrays, see: [Automatic file generation](./building.md#automatic-file-generation).
3. Build the application.\
Application and third-party libraries are now built. For further information, see:
- [Building the configured project](#building-the-configured-project).
+ [Building the configured project](./building.md#building-the-configured-project).
### Preparing build environment
@@ -258,7 +258,7 @@
3. [CMSIS-5](https://github.com/ARM-software/CMSIS_5.git)
> **Note:** If you are using non git project sources, run `python3 ./download_dependencies.py` and ignore further git
-> instructions. Proceed to [Fetching resource files](#fetching-resource-files) section.
+> instructions. Proceed to [Fetching resource files](./building.md#fetching-resource-files) section.
>
To pull the submodules:
@@ -293,7 +293,7 @@
This fetches every model into the `resources_downloaded` directory. It also optimizes the models using the Vela compiler
for the default 128 MACs configuration of the Arm® *Ethos™-U55* NPU and for the default 256 MACs configuration of the Arm® *Ethos™-U65* NPU.
-> **Note:** This script requires Python version 3.6 or higher. Please make sure all [build prerequisites](#build-prerequisites)
+> **Note:** This script requires Python version 3.6 or higher. Please make sure all [build prerequisites](./building.md#build-prerequisites)
> are satisfied.
If you need to optimize the models for a different Ethos-U configuration, you can pass a
diff --git a/docs/sections/coding_guidelines.md b/docs/sections/coding_guidelines.md
index c1eba00..039b1e0 100644
--- a/docs/sections/coding_guidelines.md
+++ b/docs/sections/coding_guidelines.md
@@ -1,16 +1,16 @@
# Coding standards and guidelines
-- [Coding standards and guidelines](#coding-standards-and-guidelines)
- - [Introduction](#introduction)
- - [Language version](#language-version)
- - [File naming](#file-naming)
- - [File layout](#file-layout)
- - [Block Management](#block-management)
- - [Naming Conventions](#naming-conventions)
- - [CPP language naming conventions](#cpp-language-naming-conventions)
- - [C language naming conventions](#c-language-naming-conventions)
- - [Layout and formatting conventions](#layout-and-formatting-conventions)
- - [Language usage](#language-usage)
+- [Coding standards and guidelines](./coding_guidelines.md#coding-standards-and-guidelines)
+ - [Introduction](./coding_guidelines.md#introduction)
+ - [Language version](./coding_guidelines.md#language-version)
+ - [File naming](./coding_guidelines.md#file-naming)
+ - [File layout](./coding_guidelines.md#file-layout)
+ - [Block Management](./coding_guidelines.md#block-management)
+ - [Naming Conventions](./coding_guidelines.md#naming-conventions)
+ - [CPP language naming conventions](./coding_guidelines.md#cpp-language-naming-conventions)
+ - [C language naming conventions](./coding_guidelines.md#c-language-naming-conventions)
+ - [Layout and formatting conventions](./coding_guidelines.md#layout-and-formatting-conventions)
+ - [Language usage](./coding_guidelines.md#language-usage)
## Introduction
diff --git a/docs/sections/customizing.md b/docs/sections/customizing.md
index 854a3ed..3bf9b26 100644
--- a/docs/sections/customizing.md
+++ b/docs/sections/customizing.md
@@ -1,21 +1,21 @@
# Implementing custom ML application
-- [Implementing custom ML application](#implementing-custom-ml-application)
- - [Software project description](#software-project-description)
- - [Hardware Abstraction Layer API](#hardware-abstraction-layer-api)
- - [Main loop function](#main-loop-function)
- - [Application context](#application-context)
- - [Profiler](#profiler)
- - [NN Model API](#nn-model-api)
- - [Adding custom ML use-case](#adding-custom-ml-use_case)
- - [Implementing main loop](#implementing-main-loop)
- - [Implementing custom NN model](#implementing-custom-nn-model)
- - [Define ModelPointer and ModelSize methods](#define-modelpointer-and-modelsize-methods)
- - [Executing inference](#executing-inference)
- - [Printing to console](#printing-to-console)
- - [Reading user input from console](#reading-user-input-from-console)
- - [Output to MPS3 LCD](#output-to-mps3-lcd)
- - [Building custom use-case](#building-custom-use_case)
+- [Implementing custom ML application](./customizing.md#implementing-custom-ml-application)
+ - [Software project description](./customizing.md#software-project-description)
+ - [Hardware Abstraction Layer API](./customizing.md#hardware-abstraction-layer-api)
+ - [Main loop function](./customizing.md#main-loop-function)
+ - [Application context](./customizing.md#application-context)
+ - [Profiler](./customizing.md#profiler)
+ - [NN Model API](./customizing.md#nn-model-api)
+ - [Adding custom ML use-case](./customizing.md#adding-custom-ml-use_case)
+ - [Implementing main loop](./customizing.md#implementing-main-loop)
+ - [Implementing custom NN model](./customizing.md#implementing-custom-nn-model)
+ - [Define ModelPointer and ModelSize methods](./customizing.md#define-modelpointer-and-modelsize-methods)
+ - [Executing inference](./customizing.md#executing-inference)
+ - [Printing to console](./customizing.md#printing-to-console)
+ - [Reading user input from console](./customizing.md#reading-user-input-from-console)
+ - [Output to MPS3 LCD](./customizing.md#output-to-mps3-lcd)
+ - [Building custom use-case](./customizing.md#building-custom-use_case)
This section describes how to implement a custom Machine Learning application running on Arm® *Corstone™-300* based FVP
or on the Arm® MPS3 FPGA prototyping board.
@@ -323,7 +323,7 @@
```
Start with creation of a sub-directory under the `use_case` directory and two additional directories `src` and `include`
-as described in the [Software project description](#software-project-description) section.
+as described in the [Software project description](./customizing.md#software-project-description) section.
## Implementing main loop
@@ -336,9 +336,9 @@
Layer (HAL).
Start by creating a `MainLoop.cc` file in the `src` directory (the one created under
-[Adding custom ML use case](#adding-custom-ml-use-case)). The name used is not important.
+[Adding custom ML use case](./customizing.md#adding-custom-ml-use-case)). The name used is not important.
-Now define the `main_loop` function with the signature described in [Main loop function](#main-loop-function):
+Now define the `main_loop` function with the signature described in [Main loop function](./customizing.md#main-loop-function):
```C++
#include "hal.h"
@@ -348,7 +348,7 @@
}
```
-The preceeding code is already a working use-case. If you compile and run it (see [Building custom usecase](#building-custom-use-case)),
+The preceeding code is already a working use-case. If you compile and run it (see [Building custom usecase](./customizing.md#building-custom-use-case)),
then the application starts and prints a message to console and exits straight away.
You can now start filling this function with logic.
@@ -358,7 +358,7 @@
Before inference could be run with a custom NN model, TensorFlow Lite Micro framework must learn about the operators, or
layers, included in the model. You must register operators using the `MicroMutableOpResolver` API.
-The *Ethos-U* code samples project has an abstraction around TensorFlow Lite Micro API (see [NN model API](#nn-model-api)).
+The *Ethos-U* code samples project has an abstraction around TensorFlow Lite Micro API (see [NN model API](./customizing.md#nn-model-api)).
Create `HelloWorldModel.hpp` in the use-case include sub-directory, extend Model abstract class,
and then declare the required methods.
diff --git a/docs/sections/deployment.md b/docs/sections/deployment.md
index 3e58464..5d858ce 100644
--- a/docs/sections/deployment.md
+++ b/docs/sections/deployment.md
@@ -1,12 +1,12 @@
# Deployment
-- [Deployment](#deployment)
- - [Fixed Virtual Platform](#fixed-virtual-platform)
- - [Setting up the MPS3 Arm Corstone-300 FVP](#setting-up-the-mps3-arm-corstone_300-fvp)
- - [Deploying on an FVP emulating MPS3](#deploying-on-an-fvp-emulating-mps3)
- - [MPS3 board](#mps3-board)
- - [MPS3 board top-view](#mps3-board-top_view)
- - [Deployment on MPS3 board](#deployment-on-mps3-board)
+- [Deployment](./deployment.md#deployment)
+ - [Fixed Virtual Platform](./deployment.md#fixed-virtual-platform)
+ - [Setting up the MPS3 Arm Corstone-300 FVP](./deployment.md#setting-up-the-mps3-arm-corstone_300-fvp)
+ - [Deploying on an FVP emulating MPS3](./deployment.md#deploying-on-an-fvp-emulating-mps3)
+ - [MPS3 board](./deployment.md#mps3-board)
+ - [MPS3 board top-view](./deployment.md#mps3-board-top_view)
+ - [Deployment on MPS3 board](./deployment.md#deployment-on-mps3-board)
The sample application for Arm® *Ethos™-U55* can be deployed on two target platforms:
@@ -45,7 +45,7 @@
### Deploying on an FVP emulating MPS3
This section assumes that the FVP has been installed (see
-[Setting up the MPS3 Arm Corstone-300 FVP](#setting-up-the-mps3-arm-corstone-300-fvp))
+[Setting up the MPS3 Arm Corstone-300 FVP](./deployment.md#setting-up-the-mps3-arm-corstone-300-fvp))
to the home directory of the user: `~/FVP_Corstone_SSE-300`.
The installation, typically, has the executable under `~/FVP_Corstone_SSE-300/model/<OS>_<compiler-version>/`
diff --git a/docs/sections/memory_considerations.md b/docs/sections/memory_considerations.md
index 89baf41..89acb1e 100644
--- a/docs/sections/memory_considerations.md
+++ b/docs/sections/memory_considerations.md
@@ -1,16 +1,16 @@
# Memory considerations
-- [Memory considerations](#memory-considerations)
- - [Introduction](#introduction)
- - [Memory available on the target platform](#memory-available-on-the-target-platform)
- - [Parameters linked to SRAM size definitions](#parameters-linked-to-sram-size-definitions)
- - [Understanding memory usage from Vela output](#understanding-memory-usage-from-vela-output)
- - [Total SRAM used](#total-sram-used)
- - [Total Off-chip Flash used](#total-off_chip-flash-used)
- - [Memory mode configurations](#memory-mode-configurations)
- - [Tensor arena and neural network model memory placement](#tensor-arena-and-neural-network-model-memory-placement)
- - [Memory usage for ML use-cases](#memory-usage-for-ml-use_cases)
- - [Memory constraints](#memory-constraints)
+- [Memory considerations](./memory_considerations.md#memory-considerations)
+ - [Introduction](./memory_considerations.md#introduction)
+ - [Memory available on the target platform](./memory_considerations.md#memory-available-on-the-target-platform)
+ - [Parameters linked to SRAM size definitions](./memory_considerations.md#parameters-linked-to-sram-size-definitions)
+ - [Understanding memory usage from Vela output](./memory_considerations.md#understanding-memory-usage-from-vela-output)
+ - [Total SRAM used](./memory_considerations.md#total-sram-used)
+ - [Total Off-chip Flash used](./memory_considerations.md#total-off_chip-flash-used)
+ - [Memory mode configurations](./memory_considerations.md#memory-mode-configurations)
+ - [Tensor arena and neural network model memory placement](./memory_considerations.md#tensor-arena-and-neural-network-model-memory-placement)
+ - [Memory usage for ML use-cases](./memory_considerations.md#memory-usage-for-ml-use_cases)
+ - [Memory constraints](./memory_considerations.md#memory-constraints)
## Introduction
@@ -199,7 +199,7 @@
memory requirements for the different use-cases of the evaluation kit.
> **Note:** The SRAM usage does not include memory used by TensorFlow Lite Micro and must be topped up as explained
-> under [Total SRAM used](#total-sram-used).
+> under [Total SRAM used](./memory_considerations.md#total-sram-used).
- [Keyword spotting model](https://github.com/ARM-software/ML-zoo/tree/68b5fbc77ed28e67b2efc915997ea4477c1d9d5b//models/keyword_spotting/ds_cnn_large/tflite_clustered_int8)
requires
diff --git a/docs/sections/testing_benchmarking.md b/docs/sections/testing_benchmarking.md
index a08789f..d1cd9df 100644
--- a/docs/sections/testing_benchmarking.md
+++ b/docs/sections/testing_benchmarking.md
@@ -1,8 +1,8 @@
# Testing and benchmarking
-- [Testing and benchmarking](#testing-and-benchmarking)
- - [Testing](#testing)
- - [Benchmarking](#benchmarking)
+- [Testing and benchmarking](./testing_benchmarking.md#testing-and-benchmarking)
+ - [Testing](./testing_benchmarking.md#testing)
+ - [Benchmarking](./testing_benchmarking.md#benchmarking)
## Testing
diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md
index fc81ffd..794bfb0 100644
--- a/docs/sections/troubleshooting.md
+++ b/docs/sections/troubleshooting.md
@@ -1,10 +1,10 @@
# Troubleshooting
-- [Troubleshooting](#troubleshooting)
- - [Inference results are incorrect for my custom files](#inference-results-are-incorrect-for-my-custom-files)
- - [The application does not work with my custom model](#the-application-does-not-work-with-my-custom-model)
- - [NPU configuration mismatch error when running inference](#npu-configuration-mismatch-error-when-running-inference)
- - [Problem installing Vela](#problem-installing-vela)
+- [Troubleshooting](./troubleshooting.md#troubleshooting)
+ - [Inference results are incorrect for my custom files](./troubleshooting.md#inference-results-are-incorrect-for-my-custom-files)
+ - [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)
## Inference results are incorrect for my custom files
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 @@
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 @@
- `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 @@
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 @@
> **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 @@
> **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