diff options
| author | Kshitij Sisodia <kshitij.sisodia@arm.com> | 2021-05-27 13:57:35 +0100 |
|---|---|---|
| committer | Isabella Gottardi <isabella.gottardi@arm.com> | 2021-05-27 16:27:44 +0100 |
| commit | b9e9c899dcbbe35cac72bceb117ae4ec56494d81 (patch) | |
| tree | 5984a5ba1453c09e55094f9971e0b244169287a6 /docs/sections/troubleshooting.md | |
| parent | 698c5a7316044c64ed98500a9a602554c69c9f3f (diff) | |
| download | ml-embedded-evaluation-kit-b9e9c899dcbbe35cac72bceb117ae4ec56494d81.tar.gz | |
MLECO-1943: Documentation review
Major update for the documentation. Also, a minor logging
change in helper scripts.
Change-Id: Ia79f78a45c9fa2d139418fbc0ca9e52245704ba3
Diffstat (limited to 'docs/sections/troubleshooting.md')
| -rw-r--r-- | docs/sections/troubleshooting.md | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md index a4f60fb..8ab81eb 100644 --- a/docs/sections/troubleshooting.md +++ b/docs/sections/troubleshooting.md @@ -1,27 +1,26 @@ # Troubleshooting -- [Inference results are incorrect for my custom files](#inference-results-are-incorrect-for-my-custom-files) -- [The application does not work with my custom model](#the-application-does-not-work-with-my-custom-model) +- [Troubleshooting](#troubleshooting) + - [Inference results are incorrect for my custom files](#inference-results-are-incorrect-for-my-custom-files) + - [The application does not work with my custom model](#the-application-does-not-work-with-my-custom-model) ## Inference results are incorrect for my custom files -Ensure that the files you are using match the requirements of the model -you are using and that cmake parameters are set accordingly. More -information on these cmake parameters is detailed in their separate -sections. Note that preprocessing of the files could also affect the -inference result, such as the rescaling and padding operations done for -image classification. +Ensure that the files you are using match the requirements of the model you are using. Ensure that cmake parameters are +set accordingly. More information on these cmake parameters is detailed in their separate sections. + +> **Note:** Preprocessing of the files can also affect the inference result, such as the rescaling and padding +> operations performed for image classification. ## The application does not work with my custom model -Ensure that your model is in a fully quantized `.tflite` file format, -either uint8 or int8, and has successfully been run through the Vela -compiler. +Ensure that your model is in a fully quantized `.tflite` file format, either `uint8` or `int8`, and that it has +successfully been run through the Vela compiler. -Check that cmake parameters match your new models input requirements. +Also, please check that the cmake parameters used match the input requirements of your new model. -> **Note:** Vela tool is not available within this software project. -It is a python tool available from <https://pypi.org/project/ethos-u-vela/>. -The source code is hosted on <https://git.mlplatform.org/ml/ethos-u/ethos-u-vela.git/>. +> **Note:** The Vela tool is not available within this software project. It is a separate Python tool that is available +> from: <https://pypi.org/project/ethos-u-vela/>. The source code is hosted on +> <https://git.mlplatform.org/ml/ethos-u/ethos-u-vela.git/>. -Next section of the documentation: [Appendix](appendix.md). +The next section of the documentation is: [Appendix](appendix.md). |