aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDmitrii Agibov <dmitrii.agibov@arm.com>2022-11-15 13:19:53 +0000
committerDmitrii Agibov <dmitrii.agibov@arm.com>2022-11-16 09:42:15 +0000
commit302ce432829ae7c25e100a5cca718f0aadbe4fd4 (patch)
tree96e31bc88f795752ecaa6a9672fe512f8b0d9041 /README.md
parent47fc50576e7040680c19e152592b2c5e5cc297f5 (diff)
downloadmlia-302ce432829ae7c25e100a5cca718f0aadbe4fd4.tar.gz
MLIA-649 Support tosa-checker as a backend
- Add new type of the backend based on python packages - Add installation class for TOSA checker - Update documentation - Extend support of the parameter "force" in the "install" command Change-Id: I95567b75e1cfe85daa1f1c3d359975bb67b2504e
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 8 insertions, 13 deletions
diff --git a/README.md b/README.md
index 1b9f494..a0a82ad 100644
--- a/README.md
+++ b/README.md
@@ -58,7 +58,7 @@ The `mlia-backend` command is used to manage the installation of new backends.
The usage is:
```bash
-mlia backend install --help
+mlia-backend install --help
```
and the result looks like:
@@ -71,22 +71,18 @@ optional arguments:
* -h/--help: Show this help message and exit
* --path PATH: Path to the installed backend
-* --download: Download and install a backend
+* --force: Force reinstalling backend in the specified path
* --noninteractive: Non interactive mode with automatic confirmation of every action
Example:
```bash
-# Use this command to see what backends can be downloaded.
-mlia backend install --download
+mlia-backend install Corstone-300
```
After a successful installation of the backend(s), start using mlia in your
virtual environment.
-*Please note*: Backends cannot be removed once installed.
-Consider creating a new environment and reinstall backends when needed.
-
### Backend compatibility table
Not all backends work on any platform. Please refer to the compatibility table
@@ -112,14 +108,13 @@ below:
### Using Corstone™-300
-To install Corstone™-300 as a backend for Ethos™-U both options (`--download`
-and `--path`) can be used:
+To install Corstone™-300 as a backend for Ethos™-U next commands can be used:
```bash
# To download and install Corstone-300 automatically
-mlia backend install --download Corstone-300
+mlia-backend install Corstone-300
# To point MLIA to an already locally installed version of Corstone-300
-mlia backend install --path YOUR_LOCAL_PATH_TO_CORSTONE_300
+mlia-backend install Corstone-300 --path YOUR_LOCAL_PATH_TO_CORSTONE_300
```
Please note: Corstone™-300 used in the example above is available only
@@ -136,11 +131,11 @@ Corstone™-310 is available as Arm® Virtual Hardware (AVH).
### Using TOSA checker
-TOSA compatibility checker is available in MLIA as an external dependency.
+TOSA compatibility checker is available in MLIA as a separate backend.
Please, install it into the same environment as MLIA using next command:
```bash
-pip install mlia[tosa]
+mlia-backend install tosa-checker
```
TOSA checker resources: