From 6df537e702d020a599a35bbbee04c45eb99ffee4 Mon Sep 17 00:00:00 2001 From: George Gekov Date: Wed, 9 Jun 2021 14:27:32 +0100 Subject: MLECO-1988: Add links to Ethos-U landing pages Change-Id: Id6788b3fdc8ffae9079c99e95c459c5aa4abda7a Signed-off-by: George Gekov --- Readme.md | 2 +- docs/documentation.md | 2 ++ docs/sections/building.md | 17 +++++++---------- docs/sections/troubleshooting.md | 2 +- model_conditioning_examples/Readme.md | 2 +- 5 files changed, 12 insertions(+), 13 deletions(-) diff --git a/Readme.md b/Readme.md index ddfb14b..66bbf66 100644 --- a/Readme.md +++ b/Readme.md @@ -45,7 +45,7 @@ The Ethos-U NPU software stack is described [here](https://developer.arm.com/doc All ML use cases, albeit illustrating a different application, have common code such as initializing the Hardware Abstraction Layer (HAL). The application common code can be run on x86 or Arm Cortex-M architecture thanks to the HAL. For the ML application-specific part, Google® TensorFlow™ Lite for Microcontrollers inference engine is used to schedule -the neural networks models executions. TensorFlow Lite for Microcontrollers is integrated with the [Ethos-U55 driver](https://git.mlplatform.org/ml/ethos-u/ethos-u-core-driver.git) +the neural networks models executions. TensorFlow Lite for Microcontrollers is integrated with the [Ethos-U55 driver](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-core-driver) and delegates execution of certain operators to the NPU or, if the neural network model operators are not supported on NPU, to the CPU. [CMSIS-NN](https://github.com/ARM-software/CMSIS_5) is used to optimise CPU workload execution with int8 data type. diff --git a/docs/documentation.md b/docs/documentation.md index 3ccdcbd..bb89c63 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -63,6 +63,8 @@ for additional information: - Arm® ML-Zoo: +- Arm® Ethos-U software: + To access Arm documentation online, please visit: ## Repository structure diff --git a/docs/sections/building.md b/docs/sections/building.md index dccc712..d2e2546 100644 --- a/docs/sections/building.md +++ b/docs/sections/building.md @@ -136,16 +136,16 @@ The build parameters are: build. All the valid toolchain files are located in the scripts directory. For example, see: [bare-metal-gcc.cmake](../../scripts/cmake/toolchains/bare-metal-gcc.cmake). -- `TENSORFLOW_SRC_PATH`: the path to the root of the TensorFlow directory. The default value points to the TensorFlow - submodule in the [ethos-u](https://git.mlplatform.org/ml/ethos-u/ethos-u.git/about/) `dependencies` folder. +- `TENSORFLOW_SRC_PATH`: the path to the root of the TensorFlow directory. The default value points to the + `dependencies/tensorflow` git submodule. Respository is hosted here: [tensorflow](https://github.com/tensorflow/tensorflow) - `ETHOS_U55_DRIVER_SRC_PATH`: The path to the *Ethos-U55* NPU core driver sources. The default value points to the - `core_driver` submodule in the [ethos-u](https://git.mlplatform.org/ml/ethos-u/ethos-u.git/about/) `dependencies` - folder. + `dependencies/core-driver` git submodule. Repository is hosted here: + [ethos-u-core-driver](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-core-driver). - `CMSIS_SRC_PATH`: The path to the CMSIS sources to be used to build TensorFlow Lite Micro library. This parameter is - optional and is only valid for Arm® *Cortex®-M* CPU targeted configurations. The default value points to the `CMSIS` - submodule in the [ethos-u](https://git.mlplatform.org/ml/ethos-u/ethos-u.git/about/) `dependencies` folder. + optional and is only valid for Arm® *Cortex®-M* CPU targeted configurations. The default value points to the + `dependencies/cmsis` git submodule. Respository is hosted here: [CMSIS-5](https://github.com/ARM-software/CMSIS_5.git) - `ETHOS_U55_ENABLED`: Sets whether the use of *Ethos-U55* NPU is available for the deployment target. By default, this is set and therefore application is built with *Ethos-U55* NPU supported. @@ -229,9 +229,6 @@ repository to link against. 2. [Ethos-U55 NPU core driver repository](https://review.mlplatform.org/admin/repos/ml/ethos-u/ethos-u-core-driver) 3. [CMSIS-5](https://github.com/ARM-software/CMSIS_5.git) -These are part of the [ethos-u repository](https://git.mlplatform.org/ml/ethos-u/ethos-u.git/about/) and set as -submodules of this project. - > **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. > @@ -647,7 +644,7 @@ After compiling, your custom model has now replaced the default one in the appli > **Note:** This tool is not available within this project. It is a Python tool available from > .\ -The source code is hosted on . +The source code is hosted on . 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-U55* NPU. diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md index 0ba6ced..e306d6f 100644 --- a/docs/sections/troubleshooting.md +++ b/docs/sections/troubleshooting.md @@ -22,7 +22,7 @@ Also, please check that the cmake parameters used match the input requirements o > **Note:** The Vela tool is not available within this software project. It is a separate Python tool that is available > from: . The source code is hosted on -> . +> . ## NPU configuration mismatch error when running inference diff --git a/model_conditioning_examples/Readme.md b/model_conditioning_examples/Readme.md index ede2c24..bb00b79 100644 --- a/model_conditioning_examples/Readme.md +++ b/model_conditioning_examples/Readme.md @@ -170,4 +170,4 @@ compiler for further optimizations before it can be used (see [Optimize model wi - [Quantization aware training](https://www.tensorflow.org/model_optimization/guide/quantization/training) - [Weight pruning](https://www.tensorflow.org/model_optimization/guide/pruning) - [Weight clustering](https://www.tensorflow.org/model_optimization/guide/clustering) -- [Vela](https://git.mlplatform.org/ml/ethos-u/ethos-u-vela.git/about/) +- [Vela](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela) -- cgit v1.2.1