From 0a0f53160f3f9d9757ec5013afbac4cfbcf32053 Mon Sep 17 00:00:00 2001 From: Arjun Suresh Date: Tue, 18 Jun 2024 17:08:07 +0100 Subject: [PATCH] Documentation update (#1735) --- .../image_classification/mobilenets.md | 30 ++++++++++++------- docs/install/index.md | 12 ++++++-- 2 files changed, 29 insertions(+), 13 deletions(-) diff --git a/docs/benchmarks/image_classification/mobilenets.md b/docs/benchmarks/image_classification/mobilenets.md index 1907c2a41..d676300df 100644 --- a/docs/benchmarks/image_classification/mobilenets.md +++ b/docs/benchmarks/image_classification/mobilenets.md @@ -7,53 +7,63 @@ Mobilenet models are not official MLPerf models and so cannot be used for a Clos === "Mobilenet-V1" ### Mobilenet V1 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_mobilenet-v1 --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_mobilenet-v1 \ + --adr.compiler.tags=gcc ``` === "Mobilenet-V2" ### Mobilenet V2 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_mobilenet-v2 --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_mobilenet-v2 \ + --adr.compiler.tags=gcc ``` === "Mobilenet-V2" ### Mobilenet V2 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_mobilenet-v2 --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_mobilenet-v2 \ + --adr.compiler.tags=gcc ``` === "Mobilenets" ### Mobilenet V1,V2,V3 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_mobilenet --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_mobilenet \ + --adr.compiler.tags=gcc ``` === "Efficientnet" ### Efficientnet ```bash - cm run script --tags=run,mobilenet-models,_tflite,_efficientnet --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_efficientnet \ + --adr.compiler.tags=gcc ``` ## ARMNN Backend === "Mobilenet-V1" ### Mobilenet V1 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet-v1 --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet-v1 \ + --adr.compiler.tags=gcc ``` === "Mobilenet-V2" ### Mobilenet V2 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet-v2 --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet-v2 \ + --adr.compiler.tags=gcc ``` === "Mobilenet-V2" ### Mobilenet V2 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet-v2 --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet-v2 \ + --adr.compiler.tags=gcc ``` === "Mobilenets" ### Mobilenet V1,V2,V3 ```bash - cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_armnn,_mobilenet \ + --adr.compiler.tags=gcc ``` === "Efficientnet" ### Efficientnet ```bash - cm run script --tags=run,mobilenet-models,_tflite,_armnn,_efficientnet --adr.compiler.tags=gcc + cm run script --tags=run,mobilenet-models,_tflite,_armnn,_efficientnet \ + --adr.compiler.tags=gcc ``` diff --git a/docs/install/index.md b/docs/install/index.md index 10ed6e325..9575e86c8 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -1,12 +1,18 @@ # Installation We use MLCommons CM Automation framework to run MLPerf inference benchmarks. -Please follow the [official installation page](https://docs.mlcommons.org/ck/install) to install CM +CM needs `git`, `python3-pip` and `python3-venv` installed on your system. If any of these are absent, please follow the [official CM installation page](https://docs.mlcommons.org/ck/install) to install them. Once the dependencies are installed, do the following -## Download the CM MLOps Repository +## Activate a VENV for CM +```bash + python3 -m venv cm + source cm/bin/activate +``` + +## Install CM and pulls any needed repositories ```bash - cm pull repo gateoverflow@cm4mlops + pip install cm4mlops ```