diff options
author | Kshitij Sisodia <kshitij.sisodia@arm.com> | 2022-08-18 12:54:34 +0100 |
---|---|---|
committer | Nina Drozd <nina.drozd@arm.com> | 2022-08-25 14:32:02 +0000 |
commit | c9f1717d227e21ebfab72cceee90b1f8f8522867 (patch) | |
tree | 991e1cb1b921f4cbe6cc88edc1797eb0eafba4cc /docs | |
parent | 271c69e8e364361f3e4c839a10a4f29ef4c9c866 (diff) | |
download | ml-embedded-evaluation-kit-c9f1717d227e21ebfab72cceee90b1f8f8522867.tar.gz |
MLECO-3252: Minor documentation additions
Documentation md files added under source tree with links to
the main docs. Minor updates to FAQs for MLECO-3251 as well.
Change-Id: Ifdcc587f2fcf77228fd46e211d3f9c3963bc9b97
Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/quick_start.md | 5 | ||||
-rw-r--r-- | docs/sections/building.md | 6 | ||||
-rw-r--r-- | docs/sections/faq.md | 8 |
3 files changed, 18 insertions, 1 deletions
diff --git a/docs/quick_start.md b/docs/quick_start.md index 93e7943..2af0c8e 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -303,3 +303,8 @@ cmake .. \ > **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#arm_ml-embedded-evaluation-kit). For example, if you wanted to modify the number of > MACs units of the Ethos-U, or running a custom neural network. + +> **Note:** The performance summary produced by Vela compiler for any model are **estimates only**. Vela computes +> these figures from a very simplistic approximation. To get accurate performance numbers for the Arm Ethos-U NPU, +> please use the FVP or the FPGA platforms. + diff --git a/docs/sections/building.md b/docs/sections/building.md index 4750e3e..973b644 100644 --- a/docs/sections/building.md +++ b/docs/sections/building.md @@ -708,7 +708,7 @@ After compiling, your custom model has now replaced the default one in the appli > The source code is hosted on <https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/>. > **Note:** Using the 22.05 versions of software dependencies will require Vela to be at least version 3.4.0 -> or you may encounter issues when trying to run applications on different variants of Ethos-U. +> or you may encounter issues when trying to run applications on different variants of Ethos-U NPUs. 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. @@ -758,6 +758,10 @@ To see Vela helper for all the parameters use: `vela --help`. > **Note:** By default, use of the *Ethos-U* NPU is enabled in the CMake configuration. This can be changed by passing > `-DETHOS_U_NPU_ENABLED`. +> **Note:** The performance summary produced by Vela compiler for any model are **estimates only**. Vela computes +> these figures from a very simplistic approximation. To get accurate performance numbers for the Arm Ethos-U NPU, use +> of FVP or FPGA platforms is recommended. + ## Building for different Ethos-U NPU variants The building process described in the previous paragraphs assumes building for the default *Ethos-U55* NPU with 128 MACs, diff --git a/docs/sections/faq.md b/docs/sections/faq.md index 0ffd0bd..887249c 100644 --- a/docs/sections/faq.md +++ b/docs/sections/faq.md @@ -13,6 +13,14 @@ A good starting point to explore the repository is the ---- +**Q: What is an FVP or AVH?** + +**A:** FVP stands for Fixed Virtual Platform and AVH is Arm Virtual Hardware. More details for these can be found under: +* https://developer.arm.com/Tools%20and%20Software/Fixed%20Virtual%20Platforms +* https://www.arm.com/products/development-tools/simulation/virtual-hardware + +---- + **Q: I’m running through the quick-start guide and I’m running into an error with pip. When I run `./build_default.py`, I get an error `ImportError: No module named pip`, but pip is installed on my machine.** |