aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Hall <tim.hall@arm.com>2021-02-18 21:52:57 +0000
committerTim Hall <tim.hall@arm.com>2021-02-19 11:50:20 +0000
commit2b74b9a25a6c89a0c059c3fbb2d9145c76c0ea23 (patch)
tree5c2580a2cbcf1d7fd9f706756d9dc125626a021d
parent0fb3851d7a6c33142729ec102c17dccc34e67204 (diff)
downloadethos-u-vela-2b74b9a25a6c89a0c059c3fbb2d9145c76c0ea23.tar.gz
MLBEDSW-4109: Add OPTIONS section to the README
- Added CLI Options section. - Minor fixes to some numbering. Signed-off-by: Tim Hall <tim.hall@arm.com> Change-Id: Ic67e7010a328f0ad80992d012f3e41250642210c
-rw-r--r--README.md26
1 files changed, 15 insertions, 11 deletions
diff --git a/README.md b/README.md
index 1d6d073..5e460c0 100644
--- a/README.md
+++ b/README.md
@@ -159,30 +159,34 @@ system configuration along with the `My_Mem_Mode` memory mode from the `vela_cfg
vela --config vela_cfg.ini --system-config My_Sys_Config --memory-mode My_Mem_Mode my_model.tflite
```
-5) To get a list of all available options:
+5) To get a list of all available options (see CLI Options section below):
```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](OPTIONS.md).
-
-## External APIs
-
-Vela provides a low-level external API to enable Ethos-U code generation from
-other tools. Please see [Vela External APIs](API.md).
-
## Example Networks
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
+
+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.
+
+## CLI Options
+
+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.
+
## Supported Operators
-Please see [Supported Operators](SUPPORTED_OPS.md) for the list of supported
-operators in this release.
+Please see [Vela Supported Operators](SUPPORTED_OPS.md) for the list of
+operators that Vela supports in this release.
## Testing