Merge branch 'master' into docs

GATEOverflow · Sep 5, 2024 · 069c2dd · 069c2dd
2 parents 294f85e + 9a27105
commit 069c2dd
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 20 deletions.
diff --git a/docs/benchmarks/image_classification/mobilenets.md b/docs/benchmarks/image_classification/mobilenets.md
@@ -5,6 +5,8 @@ hide:
 
 # Image Classification using Mobilenet models
 
+Install CM following the [installation page](/install).
+
 Mobilenet models are not official MLPerf models and so cannot be used for a Closed division MLPerf inference submission. But since they can be run with Imagenet dataset, we are allowed to use them for Open division submission. Only CPU runs are supported now. 
 
 ## TFLite Backend

diff --git a/docs/benchmarks/image_classification/resnet50.md b/docs/benchmarks/image_classification/resnet50.md
@@ -3,8 +3,11 @@ hide:
   - toc
 ---
 
+
 # Image Classification using ResNet50 
 
+Install CM following the [installation page](/install).
+
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 

diff --git a/docs/benchmarks/language/bert.md b/docs/benchmarks/language/bert.md
@@ -5,6 +5,8 @@ hide:
 
 # Question Answering using Bert-Large
 
+Install CM following the [installation page](/install).
+
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 

diff --git a/docs/benchmarks/language/gpt-j.md b/docs/benchmarks/language/gpt-j.md
@@ -5,6 +5,7 @@ hide:
 
 # Text Summarization using GPT-J
 
+Install CM following the [installation page](/install).
 
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python

diff --git a/docs/benchmarks/language/llama2-70b.md b/docs/benchmarks/language/llama2-70b.md
@@ -5,6 +5,7 @@ hide:
 
 # Text Summarization using LLAMA2-70b
 
+Install CM following the [installation page](/install).
 
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
@@ -25,4 +26,4 @@ hide:
 
 {{ mlperf_inference_implementation_readme (4, "llama2-70b-99", "neuralmagic") }}
 
-{{ mlperf_inference_implementation_readme (4, "llama2-70b-99.9", "neuralmagic") }}
+{{ mlperf_inference_implementation_readme (4, "llama2-70b-99.9", "neuralmagic") }}
diff --git a/docs/benchmarks/language/mixtral-8x7b.md b/docs/benchmarks/language/mixtral-8x7b.md
@@ -3,7 +3,11 @@ hide:
   - toc
 ---
 
+# Question Answering, Math, and Code Generation using Mixtral-8x7B
+
+Install CM following the [installation page](/install).
+
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 
-{{ mlperf_inference_implementation_readme (4, "mixtral-8x7b", "reference") }}
+{{ mlperf_inference_implementation_readme (4, "mixtral-8x7b", "reference") }}
diff --git a/docs/benchmarks/medical_imaging/3d-unet.md b/docs/benchmarks/medical_imaging/3d-unet.md
@@ -5,6 +5,7 @@ hide:
 
 # Medical Imaging using 3d-unet (KiTS 2019 kidney tumor segmentation task)
 
+Install CM following the [installation page](/install).
 
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python

diff --git a/docs/benchmarks/object_detection/retinanet.md b/docs/benchmarks/object_detection/retinanet.md
@@ -5,6 +5,8 @@ hide:
 
 # Object Detection using Retinanet
 
+Install CM following the [installation page](/install).
+
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 

diff --git a/docs/benchmarks/recommendation/dlrm-v2.md b/docs/benchmarks/recommendation/dlrm-v2.md
@@ -5,8 +5,8 @@ hide:
 
 # Recommendation using DLRM v2
 
+Install CM following the [installation page](/install).
 
-## Benchmark Implementations
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 
@@ -26,4 +26,4 @@ hide:
 
 {{ mlperf_inference_implementation_readme (4, "dlrm-v2-99", "intel") }}
 
-{{ mlperf_inference_implementation_readme (4, "dlrm-v2-99.9", "intel") }}
+{{ mlperf_inference_implementation_readme (4, "dlrm-v2-99.9", "intel") }}
diff --git a/docs/install/index.md b/docs/install/index.md
@@ -8,24 +8,24 @@ We use MLCommons CM Automation framework to run MLPerf inference benchmarks.
 
 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
 
-## Activate a VENV for CM
+## Activate a Virtual ENV for CM
+This step is not mandatory as CM can use separate virtual environment for MLPerf inference. But the latest `pip` install requires this or else will need the `--break-system-packages` flag while installing `cm4mlops`.
+
 ```bash
    python3 -m venv cm
    source cm/bin/activate
 ```
 
 ## Install CM and pulls any needed repositories
-
-```bash
-   pip install cm4mlops
-```
-
-## To work on custom GitHub repo and branch
-
-```bash
-   pip install cmind && cm init --quiet --repo=mlcommons@cm4mlops --branch=mlperf-inference
-```
-
-Here, repo is in the format `githubUsername@githubRepo`.
+=== "Use the default fork of CM MLOps repository"
+    ```bash
+     pip install cm4mlops
+    ```
+
+=== "Use custom fork/branch of the CM MLOps repository"
+    ```bash
+     pip install cmind && cm init --quiet --repo=mlcommons@cm4mlops --branch=mlperf-inference
+    ```
+    Here, `repo` is in the format `githubUsername@githubRepo`.
 
 Now, you are ready to use the `cm` commands to run MLPerf inference as given in the [benchmarks](../index.md) page
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,3 +2,4 @@ mkdocs-material
 swagger-markdown
 mkdocs-macros-plugin
 ruamel.yaml
+mkdocs-redirects
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -19,9 +19,7 @@ theme:
     - navigation.top
     - toc.follow
 nav:
-  - Install:
-    - install/index.md
-  - Benchmarks:
+  - Home:
     - index.md
     - Image Classification:
       - ResNet50: benchmarks/image_classification/resnet50.md
@@ -38,6 +36,8 @@ nav:
       - MIXTRAL-8x7B: benchmarks/language/mixtral-8x7b.md
     - Recommendation:
       - DLRM-v2: benchmarks/recommendation/dlrm-v2.md
+  - Install CM:
+    - install/index.md
   - Submission:
     - Submission Generation: submission/index.md
   - Release Notes:
@@ -62,3 +62,6 @@ markdown_extensions:
 plugins:
   - search
   - macros
+  - redirects:
+      redirect_maps:
+        'benchmarks/index.md': 'index.md'