Documentation update (mlcommons#1735)

krai · Jun 18, 2024 · 0a0f531 · 0a0f531
1 parent ad25362
commit 0a0f531
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 13 deletions.
diff --git 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
@@ -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
 ```