From e6588f620c648dd0492f6133152855d77c672568 Mon Sep 17 00:00:00 2001 From: Isabella Gottardi Date: Fri, 10 Sep 2021 14:41:42 +0100 Subject: MLECO-2238: Add FAQ section to documentation Change-Id: I4dbab11223697c6c1405a3466fdbe87e9b23cf0d --- docs/documentation.md | 4 ++++ docs/sections/faq.md | 44 +++++++++++++++++++++++++++++++++++ docs/sections/testing_benchmarking.md | 2 +- 3 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 docs/sections/faq.md diff --git a/docs/documentation.md b/docs/documentation.md index f82f330..59c1650 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -322,3 +322,7 @@ Please refer to: - [Appendix](./sections/appendix.md#appendix) - [Cortex-M55 Memory map overview](./sections/appendix.md#arm_cortex_m55-memory-map-overview-for-corstone_300-reference-design) + +## FAQ + +Please refer to: [FAQ](./sections/faq.md#faq) \ No newline at end of file diff --git a/docs/sections/faq.md b/docs/sections/faq.md new file mode 100644 index 0000000..6330164 --- /dev/null +++ b/docs/sections/faq.md @@ -0,0 +1,44 @@ +# FAQ + +**Q: I'm unable to clone the ML embedded evaluation kit. When I run the command +`git clone "ssh://review.mlplatform.org:29418/ml/ethos-u/ml-embedded-evaluation-kit"` and get a permission denied +(publickey) error. What should I do to get the code base?** + +**A:** When cloning the repository, it's recommended to use https protocol command instead of ssh, use: + +`git clone "https://review.mlplatform.org/ml/ethos-u/ml-embedded-evaluation-kit"` + +A good starting point to explore the repository is the +[quick starting guide](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ml-embedded-evaluation-kit/+/HEAD/docs/quick_start.md). + +---- + +**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.** + +**A:** Network or third party repository issues can cause the `build_default` script to fail and leave build environment in a +broken inconsistent state. Removing the `build` and `resources_downloaded` folders and running the script again may help. +If the problem persist contact your Arm representative or open a discussion on +[https://discuss.mlplatform.org/c/ml-embedded-evaluation-kit](https://discuss.mlplatform.org/c/ml-embedded-evaluation-kit/). + +---- + +**Q: When pointing to the TensorFlow Lite file explicitly in the cmake command, I get the following error message:** + +```log +CMake Error at scripts/cmake/util_functions.cmake:73 (message): Invalid file path. +Description: NN models file to be used in the evaluation application. Model files must be in tflite format. +``` + +**A:** This issue is usually caused by an incorrect path to the model file, pointed by the `-D_MODEL_TFLITE_PATH` +parameter. Check that the path is correct, clean the build folder and re-run the `cmake` command. + +---- + +**Q: How can we interpret the NPU and CPU cycles in terms of latency? Is the latency a summation of the total cycles +(idle and active NPU, active CPU)?** + +**A:** For Fast Model simulations, active NPU cycles should be representative of a real system. +However, when running code samples on Corstone-300 FVP, active CPU cycles should not be used for any performance analysis or interpretation. +The Cortex-M part of the Fast Model **is not** cycle accurate or approximate, meanwhile NPU (Ethos-U) part **is** cycle approximate. +If you need to interpret cycles for Cortex-M part, you need to use FPGA system (based on MPS3) or cycle accurate modelling environment. diff --git a/docs/sections/testing_benchmarking.md b/docs/sections/testing_benchmarking.md index 43f74c7..a08789f 100644 --- a/docs/sections/testing_benchmarking.md +++ b/docs/sections/testing_benchmarking.md @@ -23,7 +23,7 @@ The `tests` folder uses the following structure: The folders contain the following information: -- `common`: The tests for generic and common appplication functions. +- `common`: The tests for generic and common application functions. - `use_case`: Every use-case specific test in their respective folders. - `utils`: Utility sources that are only used within the tests. -- cgit v1.2.1