MLECO-3375: Update documentation for missing AVH python3.8 venv package
Change-Id: Idfee5b33b31cabdf7e825c2161df1e71191d115a
diff --git a/docs/quick_start.md b/docs/quick_start.md
index ff0646b..93e7943 100644
--- a/docs/quick_start.md
+++ b/docs/quick_start.md
@@ -11,7 +11,7 @@
To get started quickly, please follow these steps:
-1. First, verify that you have installed [the required prerequisites](sections/building.md#build-prerequisites).
+1. First, verify that you have installed all of [the required prerequisites](sections/building.md#build-prerequisites).
2. Clone the *Ethos-U* evaluation kit repository:
@@ -37,14 +37,14 @@
[supported by Vela](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/HEAD/SUPPORTED_OPS.md).
```commandline
- ./build_default.py
+ python3 ./build_default.py
```
> **Note** The preceding command assumes you are using the GNU Arm Embedded toolchain. If you are using the Arm
> Compiler instead, you can override the default selection by executing:
```commandline
- ./build_default.py --toolchain arm
+ python3 ./build_default.py --toolchain arm
```
5. Launch the project as explained in the following section: [Deployments](sections/deployment.md#deployment). In quick
diff --git a/docs/sections/building.md b/docs/sections/building.md
index 69ba0e2..1c39027 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -105,6 +105,12 @@
python3 -m venv
```
+ > **Note:** If you are using an Arm Virtual Hardware instance then Python virtual environment is not installed by default.
+ > You will need to install it yourself by running the following command:
+ > ```commandline
+ > sudo apt install python3.8-venv
+ > ```
+
- The build system uses external Python libraries during the building process. Please make sure that the latest pip and
libsndfile versions are installed.
diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md
index 3603c4b..fd2f393 100644
--- a/docs/sections/troubleshooting.md
+++ b/docs/sections/troubleshooting.md
@@ -8,6 +8,7 @@
- [Problem installing Vela](./troubleshooting.md#problem-installing-vela)
- [No matching distribution found for ethos-u-vela==3.4.0](./troubleshooting.md#no-matching-distribution-found-for-ethos_u_vela)
- [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)
## Inference results are incorrect for my custom files
@@ -202,3 +203,48 @@
> from `#!/usr/bin/python3` to `#!/usr/bin/python3.6`.
Next section of the documentation: [Appendix](appendix.md).
+
+## Error trying to build on Arm Virtual Hardware
+
+If trying to build on Arm Virtual Hardware and you encounter an error similar to the following:
+
+```log
+The virtual environment was not created successfully because ensurepip is not
+available. On Debian/Ubuntu systems, you need to install the python3-venv
+package using the following command.
+
+ apt install python3.8-venv
+
+You may need to use sudo with that command. After installing the python3-venv
+package, recreate your virtual environment.
+
+Failing command: ['/home/test/ml-embedded-evaluation-kit/resources_downloaded/env/bin/python3', '-Im', 'ensurepip', '--upgrade', '--default-pip']
+
+
+Traceback (most recent call last):
+ File "./build_default.py", line 184, in <module>
+ run(
+ File "./build_default.py", line 89, in run
+ (download_dir, env_path) = set_up_resources(
+ File "/home/test/ml-embedded-evaluation-kit/set_up_default_resources.py", line 439, in set_up_resources
+ call_command(command)
+ File "/home/test/ml-embedded-evaluation-kit/set_up_default_resources.py", line 276, in call_command
+ proc.check_returncode()
+ File "/usr/lib/python3.8/subprocess.py", line 448, in check_returncode
+ raise CalledProcessError(self.returncode, self.args, self.stdout,
+subprocess.CalledProcessError: Command 'python3 -m venv env' returned non-zero exit status 1.
+```
+
+You can fix this error by installing Python virtual environment and removing the corrupted resources_downloaded folder.
+
+```commandline
+sudo apt install python3.8-venv
+rm -r resources_downloaded
+```
+
+You can then try rebuilding again e.g.
+
+```commandline
+python3 ./build_default.py
+```
+and the error should be fixed.
\ No newline at end of file