From 8c32e15b613815052e47f793466f4f7b7c591eb1 Mon Sep 17 00:00:00 2001 From: Tim Hall Date: Tue, 30 Jun 2020 13:22:53 +0100 Subject: MLBEDSW-2575: Update documentation for Yoda Beta - Added release information - Added PyPi documentation Signed-off-by: Tim Hall Change-Id: Iaae64cfe10a2fa65f0559d13940b19d6f57edfdc --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 99fb9291..9496f141 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,8 @@ compiled model. ## TensorFlow Support -Vela supports TensorFlow 2.1.0. +Vela supports TensorFlow 2.1.0 (for experimental Int16 support please use the +latest nightly build of TensorFlow). ## Environment @@ -46,7 +47,7 @@ And optionally: Vela is available to install as a package from [PyPi](https://pypi.org/project/ethos-u-vela/), or as source code from -[ML Platform](https://git.mlplatform.org/ml/ethos-u/ethos-u-vela.git/about/). +[ML Platform](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela). Both methods will automatically install all the required dependencies. ### PyPi @@ -65,7 +66,7 @@ First obtain the source code by either downloading the desired TGZ file from: Or by cloning the git repository: ```bash -git clone https://git.mlplatform.org/ml/ethos-u/ethos-u-vela.git +git clone https://review.mlplatform.org/ml/ethos-u/ethos-u-vela.git ``` Once you have the source code, Vela can be installed using the following @@ -82,7 +83,7 @@ Or, if you use `pipenv`: pipenv install . ``` -### Advanced Installation for Developers +#### Advanced Installation for Developers If you plan to modify the Vela codebase then it is recommended to install Vela as an editable package to avoid the need to re-install after every modification. @@ -98,7 +99,7 @@ Or, if you use `pipenv`: pipenv install -e . ``` -If you plan to contribute to the Vela project (highly encouraged!!!) then it is +If you plan to contribute to the Vela project (highly encouraged!) then it is recommended to install Vela along with the pre-commit tools (see [Vela Testing](TESTING.md) for more details). -- cgit v1.2.1