summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorIsabella Gottardi <isabella.gottardi@arm.com>2021-11-30 12:33:27 +0000
committerIsabella Gottardi <isabella.gottardi@arm.com>2021-11-30 18:02:23 +0000
commit3acaaeeba7d8e85a20273bd1d8d4d9b3bb1322ad (patch)
tree147da98e07923bbe2aa4c048bc21b6868ba8768b /docs
parent2de7ba0b56f6c13570c1b2be1a10d011d2aad023 (diff)
downloadml-embedded-evaluation-kit-3acaaeeba7d8e85a20273bd1d8d4d9b3bb1322ad.tar.gz
MLECO-2745: Fix for arena-cache-size
Arena-cache-size is different from default when using Dedicated_Sram memory mode. Change-Id: Ie112146218e1ec456e17babd4ed3e7c7bc2009a8
Diffstat (limited to 'docs')
-rw-r--r--docs/quick_start.md27
-rw-r--r--docs/sections/building.md45
2 files changed, 46 insertions, 26 deletions
diff --git a/docs/quick_start.md b/docs/quick_start.md
index d892ab1..6522bdd 100644
--- a/docs/quick_start.md
+++ b/docs/quick_start.md
@@ -136,7 +136,8 @@ curl -L https://github.com/ARM-software/ML-zoo/raw/7dd3b16bb84007daf88be8648983c
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/kws
+ --output-dir=resources_downloaded/kws \
+ --arena-cache-size=2097152
mv resources_downloaded/kws/ds_cnn_clustered_int8_vela.tflite resources_downloaded/kws/ds_cnn_clustered_int8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/kws/ds_cnn_clustered_int8.tflite \
@@ -152,7 +153,8 @@ mv resources_downloaded/kws/ds_cnn_clustered_int8_vela.tflite resources_download
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/kws_asr
+ --output-dir=resources_downloaded/kws_asr \
+ --arena-cache-size=2097152
mv resources_downloaded/kws_asr/wav2letter_int8_vela.tflite resources_downloaded/kws_asr/wav2letter_int8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/kws_asr/wav2letter_int8.tflite \
@@ -168,7 +170,8 @@ mv resources_downloaded/kws_asr/wav2letter_int8_vela.tflite resources_downloaded
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/kws_asr
+ --output-dir=resources_downloaded/kws_asr \
+ --arena-cache-size=2097152
mv resources_downloaded/kws_asr/ds_cnn_clustered_int8_vela.tflite resources_downloaded/kws_asr/ds_cnn_clustered_int8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/kws_asr/ds_cnn_clustered_int8.tflite \
@@ -184,7 +187,8 @@ mv resources_downloaded/kws_asr/ds_cnn_clustered_int8_vela.tflite resources_down
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/inference_runner
+ --output-dir=resources_downloaded/inference_runner \
+ --arena-cache-size=2097152
mv resources_downloaded/inference_runner/dnn_s_quantized_vela.tflite resources_downloaded/inference_runner/dnn_s_quantized_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/inference_runner/dnn_s_quantized.tflite \
@@ -200,7 +204,8 @@ mv resources_downloaded/inference_runner/dnn_s_quantized_vela.tflite resources_d
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/img_class
+ --output-dir=resources_downloaded/img_class \
+ --arena-cache-size=2097152
mv resources_downloaded/img_class/mobilenet_v2_1.0_224_INT8_vela.tflite resources_downloaded/img_class/mobilenet_v2_1.0_224_INT8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/img_class/mobilenet_v2_1.0_224_INT8.tflite \
@@ -216,7 +221,8 @@ mv resources_downloaded/img_class/mobilenet_v2_1.0_224_INT8_vela.tflite resource
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/asr
+ --output-dir=resources_downloaded/asr \
+ --arena-cache-size=2097152
mv resources_downloaded/asr/wav2letter_int8_vela.tflite resources_downloaded/asr/wav2letter_int8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/asr/wav2letter_int8.tflite \
@@ -232,7 +238,8 @@ mv resources_downloaded/asr/wav2letter_int8_vela.tflite resources_downloaded/asr
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/ad
+ --output-dir=resources_downloaded/ad \
+ --arena-cache-size=2097152
mv resources_downloaded/ad/ad_medium_int8_vela.tflite resources_downloaded/ad/ad_medium_int8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/ad/ad_medium_int8.tflite \
@@ -248,7 +255,8 @@ mv resources_downloaded/ad/ad_medium_int8_vela.tflite resources_downloaded/ad/ad
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/ad
+ --output-dir=resources_downloaded/ad \
+ --arena-cache-size=2097152
mv resources_downloaded/vww/vww4_128_128_INT8_vela.tflite resources_downloaded/vww/vww4_128_128_INT8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/vww/vww4_128_128_INT8.tflite \
@@ -264,7 +272,8 @@ mv resources_downloaded/vww/vww4_128_128_INT8_vela.tflite resources_downloaded/v
--optimise Performance --config scripts/vela/default_vela.ini \
--memory-mode=Shared_Sram \
--system-config=Ethos_U55_High_End_Embedded \
- --output-dir=resources_downloaded/ad
+ --output-dir=resources_downloaded/ad \
+ --arena-cache-size=2097152
mv resources_downloaded/noise_reduction/rnnoise_INT8_vela.tflite resources_downloaded/noise_reduction/rnnoise_INT8_vela_H128.tflite
. resources_downloaded/env/bin/activate && vela resources_downloaded/noise_reduction/rnnoise_INT8.tflite \
diff --git a/docs/sections/building.md b/docs/sections/building.md
index b289e52..6cbabd9 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -318,21 +318,32 @@ for the default 128 MACs configuration of the Arm® *Ethos™-U55* NPU and for t
> **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
-list of additional configurations for Vela compiler. For example, to optimize the downloaded models
-for *Ethos™-U55* 32 MAC configuration and *Ethos™-U65* 512 MAC configuration, you can choose to run:
+Additional command line arguments supported by this script are:
-```sh
-python3 ./set_up_default_resources.py \
- --additional-ethos-u-config-name ethos-u55-32 \
- --additional-ethos-u-config-name ethos-u65-512
-```
-> **Note:** As the argument name suggests, the configuration names are **in addition to** the default ones: `ethos-u55-128` and `ethosu-u65-256`.
+- `--additional-ethos-u-config-name`: if you need to optimize the models for a different Ethos-U configuration,
+ you can pass a list of additional configurations for Vela compiler. For example, to optimize the downloaded models
+ for *Ethos™-U55* 32 MAC configuration and *Ethos™-U65* 512 MAC configuration, you can choose to run:
+
+ ```sh
+ python3 ./set_up_default_resources.py \
+ --additional-ethos-u-config-name ethos-u55-32 \
+ --additional-ethos-u-config-name ethos-u65-512
+ ```
+
+ > **Note:** As the argument name suggests, the configuration names are **in addition to** the default ones: `ethos-u55-128` and `ethosu-u65-256`.
+
+- `--arena-cache-size`: the size of the arena cache memory area, in bytes.
+ The default value is:
+ - the internal SRAM size for Corstone-300 implementation on MPS3 specified by AN552,
+ when optimizing for the default 128 MACs configuration of the Arm® *Ethos™-U55* NPU.
+ - the default value specified in the Vela configuration file [default_vela.ini](../../scripts/vela/default_vela.ini),
+ when optimizing for the default 256 MACs configuration of the Arm® *Ethos™-U65* NPU.
### Building for default configuration
A helper script `build_default.py` is provided to configure and build all the applications. It configures the project
-with default settings i.e., for `mps3` target, `sse-300` subsystem and *Ethos-U55* timing-adapter settings. Under the hood, it invokes all the necessary
+with default settings i.e., for `mps3` target, `sse-300` subsystem and *Ethos-U55* timing-adapter settings.
+Under the hood, it invokes all the necessary
CMake commands that are described in the next sections.
If using the `Arm GNU embedded toolchain`, execute:
@@ -353,16 +364,16 @@ Additional command line arguments supported by this script are:
- `--skip-vela`: Do not run Vela optimizer on downloaded models.
- `--npu-config-name`: Arm Ethos-U configuration to build for. The default value is
`ethos-u55-128`. Valid values are:
- - `ethos-u55-32`
- - `ethos-u55-64`
- - `ethos-u55-128`
- - `ethos-u55-256`
- - `ethos-u65-256`
- - `ethos-u65-512`
+ - `ethos-u55-32`
+ - `ethos-u55-64`
+ - `ethos-u55-128`
+ - `ethos-u55-256`
+ - `ethos-u65-256`
+ - `ethos-u65-512`
- `--make-jobs`: Specifies the number of concurrent jobs to use for compilation.
The default value is equal to the number of cores in the system.
Lowering this value can be useful in case of limited resources.
-- `--make-verbose`: Make the compile process verbose. This is equal to run ```make VERBOSE=1```.
+- `--make-verbose`: Make the compile process verbose. This is equal to run ```make VERBOSE=1```.
To build for *Ethos™-U55* 32 MAC configuration, using `Arm Compiler`, run: