aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTim Hall <tim.hall@arm.com>2021-02-25 14:28:06 +0000
committerTim Hall <tim.hall@arm.com>2021-02-25 16:41:50 +0000
commit7562bdf7600a1ee21dc546441c909aaaf01c6f66 (patch)
tree37b4fd6955f11022c935399a646bd6401907edc2 /README.md
parent4f728c04bcc90742d9d57b0e253be68a7251984f (diff)
downloadethos-u-vela-7562bdf7600a1ee21dc546441c909aaaf01c6f66.tar.gz
MLBEDSW-4095: Update RELEASE notes and other docs2.1.0.rc32.1.0
- Updated release notes - Updated supported ops - Clarified platform support - Minor clean up of README Signed-off-by: Tim Hall <tim.hall@arm.com> Change-Id: I62b9ff66fc7729b184a5dbb322406cfcdef4e542
Diffstat (limited to 'README.md')
-rw-r--r--README.md45
1 files changed, 23 insertions, 22 deletions
diff --git a/README.md b/README.md
index 5e460c0c..edd3fe76 100644
--- a/README.md
+++ b/README.md
@@ -31,8 +31,8 @@ compiled model.
## Environment
-Vela runs on the Linux operating system and on Microsoft Windows,
-see note in Installation section below.
+Vela runs on the Linux and Microsoft Windows 10 operating systems, see note in
+Installation section below.
## Prerequisites
@@ -54,9 +54,9 @@ 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.
-**Note:** For installing on Microsoft Windows you need to have a C99 capable
-toolchain installed. The recommended and tested toolchain is Microsoft Visual
-C++ 14.x Build Tools, see <https://wiki.python.org/moin/WindowsCompilers>
+**Note:** For installing on Microsoft Windows 10 you need to have a C99 capable
+toolchain installed. The recommended and tested toolchain is Microsoft Visual
+C++ 14.2 Build Tools, see <https://wiki.python.org/moin/WindowsCompilers>
### PyPi
@@ -171,38 +171,39 @@ Some example networks that contain quantised operators which can be compiled by
Vela to run on the Ethos-U NPU can be found at:
<https://tfhub.dev/s?deployment-format=lite&q=quantized>
-## External APIs
+## APIs
-Please see [Vela External APIs](API.md) for information about Vela's low-level
-external API that can be used to enable Ethos-U code generation from other
-tools.
+Please see [Vela External APIs](API.md).
-## CLI Options
+## Contributions
-Please see [Vela CLI Options](OPTIONS.md) for detailed information about all of
-Vela's CLI options as well as a description of the system configuration file
-format.
+Please see [Vela Contributions](CONTRIBUTIONS.md).
-## Supported Operators
+## Debug Database
-Please see [Vela Supported Operators](SUPPORTED_OPS.md) for the list of
-operators that Vela supports in this release.
+Please see [Vela Debug Database](DEBUG_DB.md).
-## Testing
+## Options
-Please see [Vela Testing](TESTING.md).
+Please see [Vela CLI Options](OPTIONS.md). This includes a description of the
+system configuration file format.
-## Contributions
+## Releases
-Please see [Vela Contributions](CONTRIBUTIONS.md).
+Please see [Vela Releases](RELEASES.md).
## Security
Please see [Vela Security](SECURITY.md).
-## Releases
+## Supported Operators
-Please see [Vela Releases](RELEASES.md).
+Please see [Vela Supported Operators](SUPPORTED_OPS.md) for the list of
+operators supported in this release.
+
+## Testing
+
+Please see [Vela Testing](TESTING.md).
## Resources