MLECO-1953: Corrections for documentation
Minor documentation corrections for the location of
`images.txt` file (used for MPS3 FPGA deployment).
Change-Id: Icdeaae04a5b9132c0d2f3d48948588e4954a85e6
diff --git a/docs/quick_start.md b/docs/quick_start.md
index 3efbd52..80cbc30 100644
--- a/docs/quick_start.md
+++ b/docs/quick_start.md
@@ -22,6 +22,9 @@
4. Next, you can use the `build_default` python script to get the default neural network models, compile them with
Vela and build the project.
+
+ > **Note:** This helper script needs python version 3.6 or higher.
+
[Vela](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela) is an open-source python tool converting
TensorFlow Lite for Microcontrollers neural network model into an optimized model that can run on an embedded system
containing an Ethos-U55 NPU. It is worth noting that in order to take full advantage of the capabilities of the NPU, the
diff --git a/docs/sections/building.md b/docs/sections/building.md
index 9e0d422..9688586 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -288,6 +288,9 @@
python3 ./set_up_default_resources.py
```
+> **Note:** This script requires Python version 3.6 or higher. See all pre-requisites under the section
+> [Build Prerequisites](#build-prerequisites).
+
This will fetch all the models into `resources_downloaded` directory. It will
also optimize the models using the Vela compiler for default 128 MAC configuration
of Arm® Ethos™-U55 NPU.
@@ -460,8 +463,8 @@
├── ethos-u-<use_case_name>.axf
├── ethos-u-<use_case_name>.htm
├── ethos-u-<use_case_name>.map
- ├── images-<use_case_name>.txt
└── sectors
+ ├── images.txt
└── <use_case>
├── dram.bin
└── itcm.bin
@@ -480,10 +483,10 @@
- `ethos-u-<use case name>.htm`: Human readable file containing the
call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files
+- `sectors/<use_case_name>`: Folder containing the built application, split into files
for loading into different FPGA memory regions.
-- `images-<use case name>.txt`: Tells the FPGA which memory regions to
+- `sectors/images.txt`: Tells the FPGA which memory regions to
use for loading the binaries in sectors/** folder.
> **Note:** For the specific use case commands see the relative section
diff --git a/docs/sections/customizing.md b/docs/sections/customizing.md
index 056bc55..ae911d9 100644
--- a/docs/sections/customizing.md
+++ b/docs/sections/customizing.md
@@ -738,6 +738,6 @@
As a result, `ethos-u-hello_world.axf` should be created, MPS3 build
will also produce `sectors/hello_world` directory with binaries and
-`images-hello_world.txt` to be copied to the board MicroSD card.
+`sectors/images.txt` to be copied to the board MicroSD card.
Next section of the documentation: [Testing and benchmarking](testing_benchmarking.md).
diff --git a/docs/use_cases/ad.md b/docs/use_cases/ad.md
index 661cf49..a6e368c 100644
--- a/docs/use_cases/ad.md
+++ b/docs/use_cases/ad.md
@@ -146,8 +146,8 @@
├── ethos-u-.axf
├── ethos-u-ad.htm
├── ethos-u-.map
- ├── images-ad.txt
└── sectors
+ ├── images.txt
└── ad
├── dram.bin
└── itcm.bin
@@ -162,9 +162,9 @@
- `ethos-u-ad.htm`: Human readable file containing the call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files for loading into different FPGA memory regions.
+- `sectors/ad`: Folder containing the built application, split into files for loading into different FPGA memory regions.
-- `Images-ad.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/\*\* folder.
+- `sectors/images.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/\*\* folder.
### Add custom input
diff --git a/docs/use_cases/asr.md b/docs/use_cases/asr.md
index a8142aa..0f5da40 100644
--- a/docs/use_cases/asr.md
+++ b/docs/use_cases/asr.md
@@ -185,8 +185,8 @@
├── ethos-u-asr.axf
├── ethos-u-asr.htm
├── ethos-u-asr.map
- ├── images-asr.txt
└── sectors
+ ├── images.txt
└── asr
├── dram.bin
└── itcm.bin
@@ -201,9 +201,9 @@
- `ethos-u-asr.htm`: Human readable file containing the call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files for loading into different FPGA memory regions.
+- `sectors/asr`: Folder containing the built application, split into files for loading into different FPGA memory regions.
-- `Images-asr.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/** folder.
+- `sectors/images.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/** folder.
### Add custom input
diff --git a/docs/use_cases/img_class.md b/docs/use_cases/img_class.md
index 75f0bd6..2a31322 100644
--- a/docs/use_cases/img_class.md
+++ b/docs/use_cases/img_class.md
@@ -8,7 +8,7 @@
- [Build process](#build-process)
- [Add custom input](#add-custom-input)
- [Add custom model](#add-custom-model)
- - [Setting-up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample)
+ - [Setting up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample)
- [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model)
- [Starting Fast Model simulation](#starting-fast-model-simulation)
- [Running Image Classification](#running-image-classification)
@@ -115,8 +115,8 @@
├── ethos-u-img_class.axf
├── ethos-u-img_class.htm
├── ethos-u-img_class.map
- ├── images-img_class.txt
└── sectors
+ ├── images.txt
└── img_class
├── dram.bin
└── itcm.bin
@@ -131,9 +131,9 @@
- `ethos-u-img_class.htm`: Human readable file containing the call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files for loading into different FPGA memory regions.
+- `sectors/img_class`: Folder containing the built application, split into files for loading into different FPGA memory regions.
-- `Images-img_class.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/** folder.
+- `sectors/images.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/** folder.
### Add custom input
diff --git a/docs/use_cases/inference_runner.md b/docs/use_cases/inference_runner.md
index b8004ed..0ac604b 100644
--- a/docs/use_cases/inference_runner.md
+++ b/docs/use_cases/inference_runner.md
@@ -7,7 +7,7 @@
- [Build options](#build-options)
- [Build process](#build-process)
- [Add custom model](#add-custom-model)
- - [Setting-up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample)
+ - [Setting up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample)
- [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model)
- [Starting Fast Model simulation](#starting-fast-model-simulation)
- [Running Inference Runner](#running-inference-runner)
@@ -106,11 +106,9 @@
├── ethos-u-inference_runner.axf
├── ethos-u-inference_runner.htm
├── ethos-u-inference_runner.map
- ├── images-inference_runner.txt
└── sectors
- ├── kws
- │ └── ...
- └── img_class
+ ├── images.txt
+ └── inference_runner
├── dram.bin
└── itcm.bin
```
@@ -124,9 +122,9 @@
- `ethos-u-inference_runner.htm`: Human readable file containing the call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files for loading into different FPGA memory regions.
+- `sectors/inference_runner`: Folder containing the built application, split into files for loading into different FPGA memory regions.
-- `Images-inference_runner.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/**
+- `sectors/images.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/**
folder.
### Add custom model
diff --git a/docs/use_cases/kws.md b/docs/use_cases/kws.md
index bf3e088..dc0e1f5 100644
--- a/docs/use_cases/kws.md
+++ b/docs/use_cases/kws.md
@@ -10,7 +10,7 @@
- [Build process](#build-process)
- [Add custom input](#add-custom-input)
- [Add custom model](#add-custom-model)
- - [Setting-up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample)
+ - [Setting up and running Ethos-U55 code sample](#setting-up-and-running-ethos-u55-code-sample)
- [Setting up the Ethos-U55 Fast Model](#setting-up-the-ethos-u55-fast-model)
- [Starting Fast Model simulation](#starting-fast-model-simulation)
- [Running Keyword Spotting](#running-keyword-spotting)
@@ -154,8 +154,8 @@
├── ethos-u-kws.axf
├── ethos-u-kws.htm
├── ethos-u-kws.map
- ├── images-kws.txt
└── sectors
+ ├── images.txt
└── kws
├── dram.bin
└── itcm.bin
@@ -170,9 +170,9 @@
- `ethos-u-kws.htm`: Human readable file containing the call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files for loading into different FPGA memory regions.
+- `sectors/kws`: Folder containing the built application, split into files for loading into different FPGA memory regions.
-- `Images-kws.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/\*\* folder.
+- `sectors/images.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/\*\* folder.
### Add custom input
diff --git a/docs/use_cases/kws_asr.md b/docs/use_cases/kws_asr.md
index 745a108..9fbab26 100644
--- a/docs/use_cases/kws_asr.md
+++ b/docs/use_cases/kws_asr.md
@@ -225,8 +225,8 @@
├── ethos-u-kws_asr.axf
├── ethos-u-kws_asr.htm
├── ethos-u-kws_asr.map
- ├── images-kws_asr.txt
└── sectors
+ ├── images.txt
└── kws_asr
├── dram.bin
└── itcm.bin
@@ -242,9 +242,9 @@
- `ethos-u-kws_asr.htm`: Human readable file containing the call graph of application functions.
-- `sectors/`: Folder containing the built application, split into files for loading into different FPGA memory regions.
+- `sectors/kws_asr`: Folder containing the built application, split into files for loading into different FPGA memory regions.
-- `Images-kws_asr.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/** folder.
+- `sectors/images.txt`: Tells the FPGA which memory regions to use for loading the binaries in sectors/** folder.
### Add custom input