MLECO-2235: Fix documentation
Signed-off-by: Isabella Gottardi <isabella.gottardi@arm.com>
Change-Id: If8d6bf60cd4961be4c29f46ea75422b093185b04
diff --git a/build_default.py b/build_default.py
index e4aa59d..b863c51 100755
--- a/build_default.py
+++ b/build_default.py
@@ -104,7 +104,7 @@
action="store_true")
args = parser.parse_args()
- logging.basicConfig(filename='log_build_default.log', level=logging.DEBUG)
+ logging.basicConfig(filename='log_build_default.log', level=logging.DEBUG, filemode='w')
logging.getLogger().addHandler(logging.StreamHandler(sys.stdout))
run(args.toolchain.lower(), not args.skip_download, not args.skip_vela)
diff --git a/docs/documentation.md b/docs/documentation.md
index b9b0f91..f82f330 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -34,7 +34,7 @@
- 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 download Page](https://developer.arm.com/tools-and-software/embedded/arm-compiler/downloads/)
+ [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:
- An MPS3 board loaded with Arm® Corstone™-300 reference package (`AN547`) from:
@@ -115,7 +115,7 @@
- `scripts`: Build and source generation scripts.
- `source`: C/C++ sources for the platform and ML applications.
- > **Note:** Common code related to the `Ethos-U` NPU software framework resides in *application* subfolder.
+ > **Note:** Common code related to the `Ethos-U` NPU software framework resides in *application* subfolder.
The contents of the *application* subfolder is as follows:
@@ -204,12 +204,12 @@
## Models and resources
-The models used in the use-cases implemented in this project can be downloaded from: [Arm ML-Zoo](https://github.com/ARM-software/ML-zoo/).
+The models used in the use-cases implemented in this project can be downloaded from: [Arm ML-Zoo](https://github.com/ARM-software/ML-zoo).
-- [Mobilenet V2](https://github.com/ARM-software/ML-zoo/blob/master/models/image_classification/mobilenet_v2_1.0_224/tflite_uint8).
-- [DS-CNN](https://github.com/ARM-software/ML-zoo/blob/master/models/keyword_spotting/ds_cnn_large/tflite_clustered_int8).
+- [Mobilenet V2](https://github.com/ARM-software/ML-zoo/tree/e0aa361b03c738047b9147d1a50e3f2dcb13dbcb/models/image_classification/mobilenet_v2_1.0_224/tflite_uint8).
+- [DS-CNN](https://github.com/ARM-software/ML-zoo/tree/68b5fbc77ed28e67b2efc915997ea4477c1d9d5b//models/keyword_spotting/ds_cnn_large/tflite_clustered_int8).
- [Wav2Letter](https://github.com/ARM-software/ML-zoo/tree/1a92aa08c0de49a7304e0a7f3f59df6f4fd33ac8/models/speech_recognition/wav2letter/tflite_pruned_int8).
-- [Anomaly Detection](https://github.com/ARM-software/ML-zoo/raw/7c32b097f7d94aae2cd0b98a8ed5a3ba81e66b18/models/anomaly_detection/micronet_medium/tflite_int8/ad_medium_int8.tflite).
+- [Anomaly Detection](https://github.com/ARM-software/ML-zoo/tree/7c32b097f7d94aae2cd0b98a8ed5a3ba81e66b18/models/anomaly_detection/micronet_medium/tflite_int8).
When using *Ethos-U* NPU backend, Vela compiler optimizes the the NN model. However, if not and it is supported by
TensorFlow Lite Micro, then it falls back on the CPU and execute.
@@ -243,14 +243,14 @@
- [Fetching submodules](./sections/building.md#fetching-submodules)
- [Fetching resource files](./sections/building.md#fetching-resource-files)
- [Create a build directory](./sections/building.md#create-a-build-directory)
- - [Configuring the build for MPS3 SSE-300](./sections/building.md#configuring-the-build-for-mps3-sse-300)
+ - [Configuring the build for MPS3 SSE-300](./sections/building.md#configuring-the-build-for-mps3-sse_300)
- [Using GNU Arm embedded toolchain](./sections/building.md#using-gnu-arm-embedded-toolchain)
- [Using Arm Compiler](./sections/building.md#using-arm-compiler)
- [Generating project for Arm Development Studio](./sections/building.md#generating-project-for-arm-development-studio)
- [Working with model debugger from Arm Fast Model Tools](./sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Configuring with custom TPIP dependencies](./sections/building.md#configuring-with-custom-tpip-dependencies)
- - [Configuring native unit-test build](./sections/building.md#configuring-native-unit-test-build)
- - [Configuring the build for simple_platform](./sections/building.md#configuring-the-build-for-simple_platform)
+ - [Configuring native unit-test build](./sections/building.md#configuring-native-unit_test-build)
+ - [Configuring the build for simple-platform](./sections/building.md#configuring-the-build-for-simple_platform)
- [Building the configured project](./sections/building.md#building-the-configured-project)
- [Building timing adapter with custom options](./sections/building.md#building-timing-adapter-with-custom-options)
- [Add custom inputs](./sections/building.md#add-custom-inputs)
@@ -265,9 +265,9 @@
For further information, please see:
-- [Deployment](./sections/deployment.md)
+- [Deployment](./sections/deployment.md#deployment)
- [Fixed Virtual Platform](./sections/deployment.md#fixed-virtual-platform)
- - [Setting up the MPS3 Corstone-300 FVP](./sections/deployment.md#setting-up-the-mps3-arm-corstone-300-fvp)
+ - [Setting up the MPS3 Corstone-300 FVP](./sections/deployment.md#setting-up-the-mps3-arm-corstone_300-fvp)
- [Deploying on an FVP emulating MPS3](./sections/deployment.md#deploying-on-an-fvp-emulating-mps3)
- [MPS3 board](./sections/deployment.md#mps3-board)
- [Deployment on MPS3 board](./sections/deployment.md#deployment-on-mps3-board)
@@ -283,35 +283,35 @@
For further information, please see:
-- [Implementing custom ML application](./sections/customizing.md)
+- [Implementing custom ML application](./sections/customizing.md#implementing-custom-ml-application)
- [Software project description](./sections/customizing.md#software-project-description)
- [Hardware Abstraction Layer API](./sections/customizing.md#hardware-abstraction-layer-api)
- [Main loop function](./sections/customizing.md#main-loop-function)
- [Application context](./sections/customizing.md#application-context)
- [Profiler](./sections/customizing.md#profiler)
- [NN Model API](./sections/customizing.md#nn-model-api)
- - [Adding custom ML use-case](./sections/customizing.md#adding-custom-ml-use-case)
+ - [Adding custom ML use-case](./sections/customizing.md#adding-custom-ml-use_case)
- [Implementing main loop](./sections/customizing.md#implementing-main-loop)
- [Implementing custom NN model](./sections/customizing.md#implementing-custom-nn-model)
- [Executing inference](./sections/customizing.md#executing-inference)
- [Printing to console](./sections/customizing.md#printing-to-console)
- [Reading user input from console](./sections/customizing.md#reading-user-input-from-console)
- [Output to MPS3 LCD](./sections/customizing.md#output-to-mps3-lcd)
- - [Building custom use-case](./sections/customizing.md#building-custom-use-case)
+ - [Building custom use-case](./sections/customizing.md#building-custom-use_case)
## Testing and benchmarking
-Please refer to: [Testing and benchmarking](./sections/testing_benchmarking.md).
+Please refer to: [Testing and benchmarking](./sections/testing_benchmarking.md#testing-and-benchmarking).
## Memory Considerations
-Please refer to: [Memory considerations](./sections/memory_considerations.md)
+Please refer to: [Memory considerations](./sections/memory_considerations.md#memory-considerations)
## Troubleshooting
For further information, please see:
-- [Troubleshooting](./sections/troubleshooting.md)
+- [Troubleshooting](./sections/troubleshooting.md#troubleshooting)
- [Inference results are incorrect for my custom files](./sections/troubleshooting.md#inference-results-are-incorrect-for-my-custom-files)
- [The application does not work with my custom model](./sections/troubleshooting.md#the-application-does-not-work-with-my-custom-model)
- [NPU configuration mismatch error when running inference](./sections/troubleshooting.md#npu-configuration-mismatch-error-when-running-inference)
@@ -320,5 +320,5 @@
Please refer to:
-- [Appendix](./sections/appendix.md)
+- [Appendix](./sections/appendix.md#appendix)
- [Cortex-M55 Memory map overview](./sections/appendix.md#arm_cortex_m55-memory-map-overview-for-corstone_300-reference-design)
diff --git a/docs/quick_start.md b/docs/quick_start.md
index ff260e1..6f1bc01 100644
--- a/docs/quick_start.md
+++ b/docs/quick_start.md
@@ -170,5 +170,5 @@
```
> **Note:** If you want to change the application, then, instead of using the `build_default` Python script, follow the
-> approach defined in [documentation.md](./documentation.md). For example, if you wanted to modify the number of
+> approach defined in [documentation.md](./documentation.md#arm_ml-embedded-evaluation-kit). For example, if you wanted to modify the number of
> MAC units of the Ethos-U, or running a custom neural network.
diff --git a/docs/sections/building.md b/docs/sections/building.md
index 0d6361b..f0c7310 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -9,14 +9,14 @@
- [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)
+ - [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)
+ - [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)
@@ -211,7 +211,7 @@
2. Configure the build for the platform chosen. This stage includes:
- CMake options configuration
- When `<use_case>_MODEL_TFLITE_PATH` build options are not provided, the default neural network models can be
- downloaded from [Arm ML-Zoo](https://github.com/ARM-software/ML-zoo/). For native builds, the network input and
+ 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).
@@ -412,7 +412,7 @@
└── ethos-u-<usecase1>
```
-### Configuring the build for simple_platform
+### Configuring the build for simple-platform
```commandline
cmake ../ -DTARGET_PLATFORM=simple_platform
@@ -549,13 +549,13 @@
- With a read latency of 64 cycles, and maximum pending reads as 2, each read could be a maximum of 64 or 128 bytes. As
defined for the *Ethos-U* NPU AXI bus attribute.
- The bandwidth is calculated solely by read parameters:
+ The bandwidth is calculated solely by read parameters:
- 
+ 
- This is higher than the overall bandwidth dictated by the bus parameters of:
+ This is higher than the overall bandwidth dictated by the bus parameters of:
- 
+ 
This suggests that the read operation is only limited by the overall bus bandwidth.
@@ -647,8 +647,8 @@
## Optimize custom model with Vela compiler
> **Note:** This tool is not available within this project. It is a Python tool available from
-> <https://pypi.org/project/ethos-u-vela/>.\
-The source code is hosted on <https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/>.
+> <https://pypi.org/project/ethos-u-vela/>.
+> The source code is hosted on <https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/>.
The Vela compiler is a tool that can optimize a neural network model into a version that can run on an embedded system
containing an *Ethos-U* NPU.
diff --git a/docs/sections/customizing.md b/docs/sections/customizing.md
index 4cea26f..3104986 100644
--- a/docs/sections/customizing.md
+++ b/docs/sections/customizing.md
@@ -7,7 +7,7 @@
- [Application context](#application-context)
- [Profiler](#profiler)
- [NN Model API](#nn-model-api)
- - [Adding custom ML use-case](#adding-custom-ml-use-case)
+ - [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)
@@ -15,7 +15,7 @@
- [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)
+ - [Building custom use-case](#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.
@@ -441,7 +441,7 @@
array. This generation the C++ array from the `.tflite` file, logic needs to be defined in the `usecase.cmake` file for
this `HelloWorld` example.
-For more details on `usecase.cmake`, refer to: [Building custom use-case](#building-custom-use-case).
+For more details on `usecase.cmake`, refer to: [Building options](./building.md#build-options).
For details on code generation flow in general, refer to: [Automatic file generation](./building.md#automatic-file-generation).
@@ -641,7 +641,7 @@
platform.data_psn->present_data_image((uint8_t *) inputTensor->data.data, 224, 224, 3, 10, 35, 2);
```
-Please refer to the [Hardware Abstraction Layer (HAL) API](#hardware-abstraction-layer-hal-api) section for more data presentation functions.
+Please refer to the [Hardware Abstraction Layer API](./customizing.md#hardware-abstraction-layer-api) section for more data presentation functions.
## Building custom use-case
diff --git a/docs/sections/deployment.md b/docs/sections/deployment.md
index 6c90c87..3e58464 100644
--- a/docs/sections/deployment.md
+++ b/docs/sections/deployment.md
@@ -2,10 +2,10 @@
- [Deployment](#deployment)
- [Fixed Virtual Platform](#fixed-virtual-platform)
- - [Setting up the MPS3 Arm Corstone-300 FVP](#setting-up-the-mps3-arm-corstone-300-fvp)
+ - [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)
+ - [MPS3 board top-view](#mps3-board-top_view)
- [Deployment on MPS3 board](#deployment-on-mps3-board)
The sample application for Arm® *Ethos™-U55* can be deployed on two target platforms:
diff --git a/docs/sections/memory_considerations.md b/docs/sections/memory_considerations.md
index a89175a..599c902 100644
--- a/docs/sections/memory_considerations.md
+++ b/docs/sections/memory_considerations.md
@@ -4,10 +4,10 @@
- [Introduction](#introduction)
- [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)
+ - [Total Off-chip Flash used](#total-off_chip-flash-used)
- [Non-default configurations](#non-default-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 usage for ML use-cases](#memory-usage-for-ml-use_cases)
- [Memory constraints](#memory-constraints)
## Introduction
@@ -16,7 +16,7 @@
Although the guidance provided here is concerning the Arm® *Corstone™-300* system, it is fairly generic and is
applicable for other platforms too. The Arm® *Corstone™-300* is composed of both the Arm® *Cortex™-M55* and the Arm®
-*Ethos™-U* NPU. The memory map for the Arm® *Cortex™-M55* core can be found in the [Appendix](./appendix.md).
+*Ethos™-U* NPU. The memory map for the Arm® *Cortex™-M55* core can be found in the [Appendix](./appendix.md#appendix).
The Arm® *Ethos™-U* NPU interacts with the system through two AXI interfaces. The first one, is envisaged to be the
higher-bandwidth, lower-latency, interface. In a typical system, this is wired to an SRAM as it is required to service
@@ -75,7 +75,7 @@
To make use of a neural network model that is optimized for this configuration, the linker script for the target
platform must be changed. By default, the linker scripts are set up to support the default configuration only.
-For script snippets, please refer to: [Memory constraints](#memory-constraints).
+For script snippets, please refer to: [Memory constraints](./memory_considerations.md#memory-constraints).
> **Note:**
>
@@ -130,7 +130,7 @@
design. The CMake configuration parameter `TARGET_SUBSYSTEM` sets the design, which is described in:
[build options](./building.md#build-options).
-The memory map exposed by this design is located in the [Appendix](./appendix.md), and can be used as a reference when
+The memory map exposed by this design is located in the [Appendix](./appendix.md#appendix), and can be used as a reference when
editing the linker script. This is useful to make sure that the region boundaries are respected. The snippet from the
scatter file is as follows:
diff --git a/docs/sections/testing_benchmarking.md b/docs/sections/testing_benchmarking.md
index d040d17..43f74c7 100644
--- a/docs/sections/testing_benchmarking.md
+++ b/docs/sections/testing_benchmarking.md
@@ -27,7 +27,7 @@
- `use_case`: Every use-case specific test in their respective folders.
- `utils`: Utility sources that are only used within the tests.
-When [configuring](./building.md#configuring-the-build-native-unit-test) and
+When [configuring](./building.md#configuring-native-unit_test-build) and
[building](./building.md#building-the-configured-project) for your `native` target platform, the results of the build is
placed under `<build folder>/bin/` folder. For example:
diff --git a/docs/use_cases/ad.md b/docs/use_cases/ad.md
index 84a601c..babbb93 100644
--- a/docs/use_cases/ad.md
+++ b/docs/use_cases/ad.md
@@ -10,14 +10,14 @@
- [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-u-npu-code-sample)
- - [Setting up the Ethos-U Fast Model](#setting-up-the-ethos-u-fast-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)
## Introduction
-This document describes the process of setting up and running the Arm® *Ethos™-U55* Anomaly Detection example.
+This document describes the process of setting up and running the Arm® *Ethos™-U* NPU Anomaly Detection example.
Use-case code could be found in the following directory: [source/use_case/ad](../../source/use_case/ad).
@@ -132,7 +132,7 @@
- [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)
+- [Configuring the build for simple-platform](../sections/building.md#configuring-the-build-for-simple_platform)
- [Working with model debugger from Arm Fast Model Tools](../sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Building for different Ethos-U NPU variants](../sections/building.md#building-for-different-ethos_u-npu-variants)
@@ -256,9 +256,9 @@
>**Note:** To successfully run the model, the NPU must be enabled and the platform `TARGET_PLATFORM` is set to `mps3`
>and `TARGET_SUBSYSTEM` is `SSE-300`.
-## Setting-up and running Ethos-U55 Code Sample
+## Setting up and running Ethos-U NPU code sample
-### Setting up the Ethos-U Fast Model
+### Setting up the Ethos-U NPU Fast Model
The FVP is available publicly from
[Arm Ecosystem FVP downloads](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
diff --git a/docs/use_cases/asr.md b/docs/use_cases/asr.md
index 9863ce6..f7daf7a 100644
--- a/docs/use_cases/asr.md
+++ b/docs/use_cases/asr.md
@@ -10,14 +10,14 @@
- [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 Fast Model](#setting-up-the-ethos-u-fast-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)
## Introduction
-This document describes the process of setting up and running the Arm® *Ethos™-U55* Automatic Speech Recognition
+This document describes the process of setting up and running the Arm® *Ethos™-U* NPU Automatic Speech Recognition
example.
Use-case code could be found in the following directory: [source/use_case/asr](../../source/use_case/asr).
@@ -179,7 +179,7 @@
- [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)
+- [Configuring the build for simple-platform](../sections/building.md#configuring-the-build-for-simple_platform)
- [Working with model debugger from Arm Fast Model Tools](../sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Building for different Ethos-U NPU variants](../sections/building.md#building-for-different-ethos_u-npu-variants)
@@ -319,7 +319,7 @@
## Setting up and running Ethos-U NPU code sample
-### Setting up the Ethos-U Fast Model
+### Setting up the Ethos-U NPU Fast Model
The FVP is available publicly from
[Arm Ecosystem FVP downloads](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
diff --git a/docs/use_cases/img_class.md b/docs/use_cases/img_class.md
index ae74d8a..13856e8 100644
--- a/docs/use_cases/img_class.md
+++ b/docs/use_cases/img_class.md
@@ -8,14 +8,14 @@
- [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 Fast Model](#setting-up-the-ethos-u-fast-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)
## Introduction
-This document describes the process of setting up and running the Arm® *Ethos™-U55* Image Classification example.
+This document describes the process of setting up and running the Arm® *Ethos™-U* NPU Image Classification example.
This use-case example solves the classical computer vision problem of image classification. The ML sample was developed
using the *MobileNet v2* model that was trained on the *ImageNet* dataset.
@@ -98,7 +98,7 @@
- [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)
+- [Configuring the build for simple-platform](../sections/building.md#configuring-the-build-for-simple_platform)
- [Working with model debugger from Arm Fast Model Tools](../sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Building for different Ethos-U NPU variants](../sections/building.md#building-for-different-ethos_u-npu-variants)
@@ -241,7 +241,7 @@
## Setting up and running Ethos-U NPU code sample
-### Setting up the Ethos-U Fast Model
+### Setting up the Ethos-U NPU Fast Model
The FVP is available publicly from
[Arm Ecosystem FVP downloads](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md
index 91cca44..7334886 100644
--- a/docs/use_cases/inference_runner.md
+++ b/docs/use_cases/inference_runner.md
@@ -7,14 +7,14 @@
- [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 Fast Model](#setting-up-the-ethos-u-fast-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)
## Introduction
-This document describes the process of setting up and running the Arm® *Ethos™-U55* NPU Inference Runner.
+This document describes the process of setting up and running the Arm® *Ethos™-U* NPU Inference Runner.
The inference runner is intended for quickly checking profiling results for any wanted network, providing it has been
processed by the Vela compiler.
@@ -90,7 +90,7 @@
- [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)
+- [Configuring the build for simple-platform](../sections/building.md#configuring-the-build-for-simple_platform)
- [Working with model debugger from Arm Fast Model Tools](../sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Building for different Ethos-U NPU variants](../sections/building.md#building-for-different-ethos_u-npu-variants)
@@ -173,7 +173,7 @@
## Setting up and running Ethos-U NPU code sample
-### Setting up the Ethos-U Fast Model
+### Setting up the Ethos-U NPU Fast Model
The FVP is available publicly from
[Arm Ecosystem FVP downloads](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
diff --git a/docs/use_cases/kws.md b/docs/use_cases/kws.md
index d490f2b..11d4146 100644
--- a/docs/use_cases/kws.md
+++ b/docs/use_cases/kws.md
@@ -10,14 +10,14 @@
- [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 Fast Model](#setting-up-the-ethos-u-fast-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)
## Introduction
-This document describes the process of setting up and running the Arm® *Ethos™-U55* Keyword Spotting example.
+This document describes the process of setting up and running the Arm® *Ethos™-U* NPU Keyword Spotting example.
Use-case code could be found in the following directory: [source/use_case/kws](../../source/use_case/kws).
@@ -147,7 +147,7 @@
- [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)
+- [Configuring the build for simple-platform](../sections/building.md#configuring-the-build-for-simple_platform)
- [Working with model debugger from Arm Fast Model Tools](../sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Building for different Ethos-U NPU variants](../sections/building.md#building-for-different-ethos_u-npu-variants)
@@ -286,7 +286,7 @@
## Setting up and running Ethos-U NPU code sample
-### Setting up the Ethos-U Fast Model
+### Setting up the Ethos-U NPU Fast Model
The FVP is available publicly from
[Arm Ecosystem FVP downloads](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
diff --git a/docs/use_cases/kws_asr.md b/docs/use_cases/kws_asr.md
index 80e5265..bac1039 100644
--- a/docs/use_cases/kws_asr.md
+++ b/docs/use_cases/kws_asr.md
@@ -12,8 +12,8 @@
- [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 Fast Model](#setting-up-the-ethos-u-fast-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)
@@ -25,7 +25,7 @@
The Keyword Spotting and Automatic Speech Recognition example demonstrates how to run multiple models sequentially.
A Keyword Spotting model is first run on the CPU. If a set keyword is detected on the remaining audio, then an Automatic
-Speech Recognition model is run on the *Ethos-U55*.
+Speech Recognition model is run on the *Ethos-U* NPU.
The tensor arena memory region is reused between models to optimize application memory footprint.
@@ -240,7 +240,7 @@
- [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)
+- [Configuring the build for simple-platform](../sections/building.md#configuring-the-build-for-simple_platform)
- [Working with model debugger from Arm Fast Model Tools](../sections/building.md#working-with-model-debugger-from-arm-fast-model-tools)
- [Building for different Ethos-U NPU variants](../sections/building.md#building-for-different-ethos_u-npu-variants)
@@ -377,7 +377,7 @@
## Setting up and running Ethos-U NPU code sample
-### Setting up the Ethos-U Fast Model
+### Setting up the Ethos-U NPU Fast Model
The FVP is available publicly from
[Arm Ecosystem FVP downloads](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
diff --git a/download_dependencies.py b/download_dependencies.py
index 9d2e6fa..7219203 100755
--- a/download_dependencies.py
+++ b/download_dependencies.py
@@ -81,7 +81,7 @@
if __name__ == '__main__':
- logging.basicConfig(filename='download_dependencies.log', level=logging.DEBUG)
+ logging.basicConfig(filename='download_dependencies.log', level=logging.DEBUG, filemode='w')
logging.getLogger().addHandler(logging.StreamHandler(sys.stdout))
download_dir = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "dependencies"))