From 4bd28aa1bc8d7dc952c3d4ff523d942540947280 Mon Sep 17 00:00:00 2001 From: Tim Hall Date: Tue, 1 Aug 2023 14:00:33 +0100 Subject: MLBEDSW-7656: Update Python versions in README - Added Python support information - Clarified TensorFlow support information - Updated Requires-Python version to 3.8 Change-Id: Iab38a2f4480e58a1bd36d5055342c4bf7379dd09 Signed-off-by: Tim Hall --- README.md | 22 +++++++++++++++++++--- pyproject.toml | 2 +- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b9f35e3..b2a13c39 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,10 @@ The tool has limited functionality for compiling a (EXPERIMENTAL). ## TensorFlow Support +Vela is tested by comparing the numerical behaviour of the optimised operators +against that of the corresponding TensorFlow Lite reference kernels. The +following list indicates which version is used for comparison: + * Vela 3.9.0 to current supports TensorFlow 2.12 * Vela 3.8.0 supports TensorFlow 2.11 * Vela 3.6.0 to 3.7.0 supports TensorFlow 2.10 @@ -56,6 +60,18 @@ The tool has limited functionality for compiling a * Vela 2.0.0 to 2.0.1 supports TensorFlow 2.3 * Vela 0.1.0 to 1.2.0 supports TensorFlow 2.1 +## Python Version Support +The majority of Vela's testing is done using a single version of Python, as +indicated by the first version in the list below. However, some additional +testing is also performed across a range of newer versions starting at the +minimum version (pyproject.toml:project.requires-python) indicated in the +brackets: + +* Vela 3.8.0 to current supports Python 3.9 (3.8) +* Vela 3.4.0 to 3.7.0 supports Python 3.7 (3.8) +* Vela 3.3.0 supports Python 3.8 (3.7) +* Vela 0.1.0 to 3.2.0 supports Python 3.6 (3.7) + ## Environment Vela runs on Linux and Microsoft Windows 10 operating systems. @@ -68,9 +84,9 @@ The following should be installed prior to the installation of Vela: - Development version containing the Python/C API header files - e.g. `apt install python3.9-dev` or `yum install python39-devel` * Pip3 -* A C99 capable compiler and associated toolchain +* C99 capable compiler and associated toolchain - For Linux operating systems, a GNU toolchain is recommended. - - For Microsoft Windows 10, Microsoft Visual C++ 14.2 Build Tools is recommended. + - For Microsoft Windows 10, the Microsoft Visual C++ 14.2 Build Tools are recommended. See ## Installation @@ -114,7 +130,7 @@ as an editable package to avoid the need to re-install after every modification. This is done by adding the `-e` option to the install command like so: ```bash -pip3 install -e . +pip3 install -e .[dev] ``` If you plan to contribute to the Vela project (highly encouraged!) then it is diff --git a/pyproject.toml b/pyproject.toml index f2c5d60f..e6428e46 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,7 @@ [project] name = "ethos-u-vela" description = "Neural network model compiler for Arm Ethos-U NPUs" -requires-python = "~=3.7" +requires-python = "~=3.8" authors = [{name = "Arm Ltd", email = "mlg-vela@arm.com"}] license = {text= "Apache License 2.0"} classifiers = [ -- cgit v1.2.1