summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoralexander <alexander.efremov@arm.com>2021-05-24 18:56:32 +0100
committerKshitij Sisodia <kshitij.sisodia@arm.com>2021-05-25 15:53:28 +0100
commit3ef1fd4880d76f62ee25c8a6f2afaa3f869498c1 (patch)
tree15ae35f1c7fcdf15e8063c1a9d57a969e8dc74e1 /docs
parent3c8256df7de49a4fb64cdbcdea46ff471ff5f846 (diff)
downloadml-embedded-evaluation-kit-3ef1fd4880d76f62ee25c8a6f2afaa3f869498c1.tar.gz
MLECO-1944: Minor documentation clean-up done and script to download TPIP added21.05-rc1
Signed-off-by: alexander <alexander.efremov@arm.com> Change-Id: Id4a9b220ce753a5ecf3483e86d837c1814dc7fb9
Diffstat (limited to 'docs')
-rw-r--r--docs/documentation.md17
-rw-r--r--docs/sections/building.md40
2 files changed, 48 insertions, 9 deletions
diff --git a/docs/documentation.md b/docs/documentation.md
index 7f8fbf9..d08e313 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -68,6 +68,9 @@ The repository has the following structure:
.
├── dependencies
├── docs
+├── model_conditioning_examples
+├── resources
+├── /resources_downloaded/
├── scripts
│ └── ...
├── source
@@ -77,9 +80,9 @@ The repository has the following structure:
│ │ └── tensorflow-lite-micro
│ └── use_case
│ └── <usecase_name>
-│   ├── include
-│   ├── src
-│   └── usecase.cmake
+│ ├── include
+│ ├── src
+│ └── usecase.cmake
├── tests
│ └── ...
└── CMakeLists.txt
@@ -91,6 +94,14 @@ Where:
- `docs`: contains the documentation for this ML applications.
+- `model_conditioning_examples`: contains short example scripts that demonstrate some methods available in TensorFlow
+ to condition your model in preparation for deployment on Arm Ethos NPU.
+
+- `resources`: contains ML use cases applications resources such as input data, label files, etc.
+
+- `resources_downloaded`: created by `set_up_default_resources.py`, contains downloaded resources for ML use cases
+ applications such as models, test data, etc.
+
- `scripts`: contains build related and source generation scripts.
- `source`: contains C/C++ sources for the platform and ML applications.
diff --git a/docs/sections/building.md b/docs/sections/building.md
index 98cb5e8..9e0d422 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -7,6 +7,7 @@
- [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)
@@ -253,6 +254,10 @@ repository to link against.
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.
+>
+
To pull the submodules:
```sh
@@ -263,11 +268,10 @@ This will download all the required components and place them in a tree like:
```tree
dependencies
- └── ethos-u
-    ├── cmsis
-    ├── core_driver
-   ├── tensorflow
- └── ...
+ ├── cmsis
+ ├── core-driver
+ ├── core-software
+ └── tensorflow
```
> **NOTE**: The default source paths for the TPIP sources assume the above directory structure, but all of the relevant
@@ -288,9 +292,33 @@ 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.
+### 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 and `sse-300` subsystem. 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:
+
+```commandline
+./build_default.py
+```
+
+If using the `Arm Compiler`, execute:
+
+```commandline
+./build_default.py --toolchain arm
+```
+
+Additional command line arguments supported by this script are:
+ - `--skip-download`: Do not download resources: models and test vectors
+ - `--skip-vela`: Do not run Vela optimizer on downloaded models.
+
### Create a build directory
-Create a build directory in the root of the project and navigate inside:
+To configure and build the project manually, create a build directory in the
+root of the project and navigate inside:
```commandline
mkdir build && cd build