summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKshitij Sisodia <kshitij.sisodia@arm.com>2023-03-17 10:40:45 +0000
committerKshitij Sisodia <kshitij.sisodia@arm.com>2023-03-17 11:22:53 +0000
commit1bd434e1d618b6222968202531e36a922c7c44f7 (patch)
tree267e14ad03d0f61a9cfb7055c12ceb56fa65f9cc /docs
parent26bc923b15be6d1a1788f5afb26241b6fb89a718 (diff)
downloadml-embedded-evaluation-kit-1bd434e1d618b6222968202531e36a922c7c44f7.tar.gz
MLECO-3842, MLECO-3801, MLECO-3899: Minor improvements
Some minor improvements in this patch: * Added notes on troubleshooting WSL2 build issues. * Fixed a stray guard for MPS3_PLATFORM from noise reduction use-case. * The default build script `build_default.py` will now return an error code to the calling process if it fails. Change-Id: I4557a402646fdf903b2cb043bf68d5d0b0d12972 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/documentation.md1
-rw-r--r--docs/sections/troubleshooting.md24
2 files changed, 23 insertions, 2 deletions
diff --git a/docs/documentation.md b/docs/documentation.md
index 6302c68..6e016e6 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -23,6 +23,7 @@
- Arm® and Corstone™ are registered trademarks or trademarks of Arm® Limited (or its subsidiaries) in the US and/or
elsewhere.
- Arm®, Keil® and µVision® are registered trademarks of Arm Limited (or its subsidiaries) in the US and/or elsewhere.
+- Microsoft® and Windows® are proprietary registered trademarks of Microsoft and its group of companies.
- TensorFlow™, the TensorFlow logo, and any related marks are trademarks of Google Inc.
## Prerequisites
diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md
index 0b6f4f9..b29b30a 100644
--- a/docs/sections/troubleshooting.md
+++ b/docs/sections/troubleshooting.md
@@ -10,6 +10,7 @@
- [How to update Python3 package to 3.7 version](./troubleshooting.md#how-to-update-python3-package-to-newer-version)
- [Error trying to build on Arm Virtual Hardware](./troubleshooting.md#error-trying-to-build-on-arm-virtual-hardware)
- [Internal Compiler Error](./troubleshooting.md#internal-compiler-error)
+ - [Build issues with WSL2](./troubleshooting.md#build-issues-with-wsl2)
## Inference results are incorrect for my custom files
@@ -268,9 +269,28 @@ Please include the complete backtrace with any bug report.
See <https://bugs.linaro.org/> for instructions.
```
-This is expected to be fixed in the next release of the toolchain. We recommend using the previous version 11.3.Rel1
-(from August 2022).
+It has been worked around by a CMSIS-NN patch from Dec 23, 2023. Make sure you are on a later commit of CMSIS-NN.
See
- [GCC patches: PR107987](https://gcc.gnu.org/pipermail/gcc-patches/2022-December/607963.html)
- [CMSIS-NN issue 13](https://github.com/ARM-software/CMSIS-NN/issues/13)
+- [Workaround for GNU Toolchain 12.x bug ](https://github.com/ARM-software/CMSIS-NN/commit/245089501eef18e8b638865c5afd6cdf2d03386f)
+
+## Build issues with WSL2
+
+Builds using Windows® Subsystem For Linux (WSL2) can run into issues if their
+environment's PATH variable has paths containing unescaped space characters.
+The error might look like:
+
+```
+****Building TensorFlow Lite Micro library… /bin/sh: 1: Syntax error: “(” unexpected
+ make[2]: *** [CMakeFiles/tensorflow_build.dir/build.make:71: CMakeFiles/tensorflow_build] Error 2
+ make[1]: *** [CMakeFiles/Makefile2:537: CMakeFiles/tensorflow_build.dir/all] Error 2
+ make[1]: *** Waiting for unfinished jobs…
+```
+
+The error here was caused by `C:/Program Files (x86)/` being part of the PATH.
+To resolve this issue, remove any paths with spaces. Alternatively, if these
+paths are required, escape them using `\` or enclose them with quotes.
+
+Another example of a similar issue: [Discourse issue 171: Build error in makefile](https://discuss.mlplatform.org/t/build-error-in-makefile/171).