MLBEDSW-2575: Update documentation for Yoda Beta
- Added release information
- Added PyPi documentation
Signed-off-by: Tim Hall <tim.hall@arm.com>
Change-Id: Iaae64cfe10a2fa65f0559d13940b19d6f57edfdc
diff --git a/PYPI.md b/PYPI.md
new file mode 100644
index 0000000..3ea590a
--- /dev/null
+++ b/PYPI.md
@@ -0,0 +1,189 @@
+# Vela
+
+This tool is used to compile a
+[TensorFlow Lite for Microcontrollers](https://www.tensorflow.org/lite/microcontrollers)
+neural network model into an optimised version that can run on an embedded
+system containing an
+[Ethos-U55 NPU](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u55).
+
+The optimised model will contain TensorFlow Lite Custom operators for those
+parts of the model that can be accelerated by the Ethos-U55. Parts of the model
+that cannot be accelerated are left unchanged and will instead run on the
+Cortex-M series CPU using an appropriate kernel (such as the
+[Arm](https://www.arm.com) optimised
+[CMSIS-NN](https://github.com/ARM-software/CMSIS_5/tree/develop/CMSIS/NN)
+kernels).
+
+After compilation the optimised model can only be run on an Ethos-U55 NPU
+embedded system.
+
+The tool will also generate performance estimates (EXPERIMENTAL) for the
+compiled model.
+
+## TensorFlow Support
+
+Vela supports TensorFlow 2.1.0 (for experimental Int16 support please use the
+latest nightly build of TensorFlow).
+
+## Environment
+
+Vela runs on the Linux operating system.
+
+## Prerequisites
+
+The following should be installed prior to the installation of Vela:
+
+* Python >= 3.6
+* Pip3
+* GNU toolchain (GCC, Binutils and libraries) or alternative C compiler/linker
+toolchain
+
+And optionally:
+
+* Pipenv virtual environment tool
+
+## Installation
+
+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://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela).
+Both methods will automatically install all the required dependencies.
+
+### PyPi
+
+Install Vela from PyPi using the following command:
+
+```bash
+pip3 install ethos-u-vela
+```
+
+### ML Platform
+
+First obtain the source code by either downloading the desired TGZ file from:
+<https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela>
+
+Or by cloning the git repository:
+
+```bash
+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
+command:
+
+```bash
+pip3 install -U setuptools>=40.1.0
+pip3 install .
+```
+
+Or, if you use `pipenv`:
+
+```bash
+pipenv install .
+```
+
+#### 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.
+This is done by adding the `-e` option to the above install commands like so:
+
+```bash
+pip3 install -e .
+```
+
+Or, if you use `pipenv`:
+
+```bash
+pipenv install -e .
+```
+
+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](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/refs/tags/1.1.0/TESTING.md)
+for more details).
+
+## Running
+
+Vela is run with an input `.tflite` file passed on the command line. This file
+contains the neural network to be compiled. The tool then outputs an optimised
+version with a `_vela.tflite` file prefix, along with the performance estimate
+(EXPERIMENTAL) CSV files, all to the output directory.
+
+If you use the `pipenv` virtual environment tool then first start by spawning a
+shell in the virtual environment.:
+
+```bash
+pipenv shell
+```
+
+After which running Vela is the same regardless of whether you are in a virtual
+environment or not.
+
+Example usage:
+
+1) Compile the network `my_model.tflite`. The optimised version will be output
+to `./output/my_network_vela.tflite`.
+
+```bash
+vela my_model.tflite
+```
+
+1) Compile the network `/path/to/my_model.tflite` and specify the output to go
+in the directory `./results_dir/`.
+
+```bash
+vela --output-dir ./results_dir /path/to/my_model.tflite
+```
+
+1) To specify information about the embedded system's configuration use Vela's
+system configuration file. The following command selects the `MySysConfig`
+settings that are described in the `sys_cfg_vela.ini` system configuration file.
+More details can be found in the next section.
+
+```bash
+vela --config sys_cfg_vela.ini --system-config MySysConfig my_model.tflite
+```
+
+1) To get a list of all available options:
+
+```bash
+vela --help
+```
+
+Information about all of Vela's CLI options as well as the system configuration
+file format can be found in
+[Vela Options](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/refs/tags/1.1.0/OPTIONS.md).
+
+## Testing
+
+Please see
+[Vela Testing](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/refs/tags/1.1.0/TESTING.md)
+
+## Contributions
+
+Please see
+[Vela Contributions](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/refs/tags/1.1.0/CONTRIBUTIONS.md).
+
+## Security
+
+Please see
+[Vela Security](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/refs/tags/1.1.0/SECURITY.md).
+
+## Releases
+
+Please see
+[Vela Releases](https://review.mlplatform.org/plugins/gitiles/ml/ethos-u/ethos-u-vela/+/refs/tags/1.1.0/RELEASES.md).
+
+## Resources
+
+Additional useful information:
+
+* [Arm Products: Ethos-U55](https://www.arm.com/products/silicon-ip-cpu/ethos/ethos-u55)
+* [Arm Developer: Ethos-U55](https://developer.arm.com/ip-products/processors/machine-learning/ethos-u55)
+
+## License
+
+Vela is licensed under
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
diff --git a/README.md b/README.md
index 99fb929..9496f14 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,8 @@
## 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 @@
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 @@
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 @@
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 @@
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).
diff --git a/RELEASES.md b/RELEASES.md
index fcd100f..abab754 100644
--- a/RELEASES.md
+++ b/RELEASES.md
@@ -5,7 +5,19 @@
fixed. The version numbering adheres to the
[semantic versioning](https://semver.org/) scheme.
-## Release 1.0 - 18/06/2020
+## Release 1.1.0 - 30/06/2020
+
+**Main feature changes:**
+
+* Multi-core support
+* DRAM memory allocation support
+
+**Interface changes:**
+
+* Change to CLI options: `--accelerator-config` (added values `yoda-256` and
+`yoda-512`)
+
+## Release 1.0.0 - 18/06/2020
**Main feature changes:**
@@ -23,9 +35,9 @@
**Reported defect fixes:**
-* MLCE-218: Crop2D operator not passing through optimizer
-* MLCE-219: Custom Operator not passing through optimizer
+* Crop2D operator not passing through optimizer (MLCE-218)
+* Custom Operator not passing through optimizer (MLCE-219)
-## Release 0.1 - 29/04/2020
+## Release 0.1.0 - 29/04/2020
Initial release.
diff --git a/setup.py b/setup.py
index 1ef462a..07ab2d1 100644
--- a/setup.py
+++ b/setup.py
@@ -23,7 +23,7 @@
# Read the contents of README.md file
this_directory = path.abspath(path.dirname(__file__))
-with open(path.join(this_directory, "README.md"), encoding="utf-8") as f:
+with open(path.join(this_directory, "PYPI.md"), encoding="utf-8") as f:
long_description = f.read()
mlw_module = Extension(