aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRuomei Yan <ruomei.yan@arm.com>2022-11-02 16:47:56 +0000
committerRuomei Yan <ruomei.yan@arm.com>2022-11-15 13:02:56 +0000
commit47fc50576e7040680c19e152592b2c5e5cc297f5 (patch)
treef10fc331e7bc7358c7da8cf3582d9428db4e7367 /README.md
parentef73bb773df214f3f33f8e4ca7d276041106cad2 (diff)
downloadmlia-47fc50576e7040680c19e152592b2c5e5cc297f5.tar.gz
MLIA-649 Strip mlia backend management into a new command
* add entry point for mlia-backend in setup.cfg and main.py * add --force option for install from path: uninstall existing backend in ML Inference Advisor and install from given path * add uninstall and list program parameters: uninstall has backend_name as input arg, install has backend_name as a mandatory argument * add unit tests in test_cli_commands.py, test_cli_main.py, test_tools_metadata_common.py, test_tools_metadata_corstone.py * updated README.md * remove --download option for installing backend * add new lines for the display section when we do mlia-backen list * add case insensitive support for backend names in command line argument Change-Id: Icb89d8957fa6be4b767710e24fa074f26472674b
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 16 insertions, 6 deletions
diff --git a/README.md b/README.md
index 7d3726e..1b9f494 100644
--- a/README.md
+++ b/README.md
@@ -38,12 +38,22 @@ The ML Inference Advisor is designed to support multiple performance
estimators (backends) that could generate performance analysis for individual
types of hardware.
-The `backend` command is used to manage the installation of new backends.
-The `install` sub-command can be used to either
-
-* install a backend installed locally already (option `--path`) or
-* (if available) automatically download the necessary components and
- dependencies, install them and configure them properly (option `--download`).
+The `mlia-backend` command is used to manage the installation of new backends.
+
+* The `install` sub-command can be used after `mlia-backend` to:
+ * install a backend of ML Inference Advisor from a directory
+ which contains installed backend (option `--path`). The name (mandatory
+ argument `name`) of the backend can be case insensitive. If backend
+ is already installed, it is possible to use option `--force`
+ to force the installation
+ * (if available) automatically download the necessary components and
+ dependencies, install them and configure them properly (default behavior)
+
+* The `uninstall` sub-command can be used with option `backend_name` after
+ `mlia-backend` to remove the backend installation folder
+
+* The `list` sub-command can be used after `mlia-backend` to display
+ the installed and available for installation backends
The usage is: