Update docs: SCC24, fix broken redirect (#1843)

* Support batch-size in llama2 run * Add Rclone-Cloudflare download instructions to README.md * Add Rclone-Cloudflare download instructiosn to README.md * Minor wording edit to README.md * Add Rclone-Cloudflare download instructions to README.md * Add Rclone-GDrive download instructions to README.md * Add new and old instructions to README.md * Tweak language in README.md * Language tweak in README.md * Minor language tweak in README.md * Fix typo in README.md * Count error when logging errors: submission_checker.py * Fixes #1648, restrict loadgen uncommitted error message to within the loadgen directory * Update test-rnnt.yml (#1688) Stopping the github action for rnnt * Added docs init Added github action for website publish Update benchmark documentation Update publish.yaml Update publish.yaml Update benchmark documentation Improved the submission documentation Fix taskname Removed unused images * Fix benchmark URLs * Fix links * Add _full variation to run commands * Added script flow diagram * Added docker setup command for CM, extra run options * Added support for docker options in the docs * Added --quiet to the CM run_cmds in docs * Fix the test query count for cm commands * Support ctuning-cpp implementation * Added commands for mobilenet models * Docs cleanup * Docs cleanup * Added separate files for dataset and models in the docs * Remove redundant tab in the docs * Fixes some WIP models in the docs * Use the official docs page for CM installation * Fix the deadlink in docs * Fix indendation issue in docs * Added dockerinfo for nvidia implementation * Added run options for gptj * Added execution environment tabs * Cleanup of the docs * Cleanup of the docs * Reordered the sections of the docs page * Removed an unnecessary heading in the docs * Fixes the commands for datacenter * Fix the build --sdist for loadgen * Fixes #1761, llama2 and mixtral runtime error on CPU systems * Added mixtral to the benchmark list, improved benchmark docs * Update docs for MLPerf inference v4.1 * Update docs for MLPerf inference v4.1 * Fix typo * Gave direct link to implementation readmes * Added tables detailing implementations * Update vision README.md, split the frameworks into separate rows * Update README.md * pointed links to specific frameworks * pointed links to specific frameworks * Update Submission_Guidelines.md * Update Submission_Guidelines.md * Update Submission_Guidelines.md * api support llama2 * Added request module and reduced max token len * Fix for llama2 api server * Update SUT_API offline to work for OpenAI * Update SUT_API.py * Minor fixes * Fix json import in SUT_API.py * Fix llama2 token length * Added model name verification with server * clean temp files * support num_workers in LLAMA2 SUTs * Remove batching from Offline SUT_API.py * Update SUT_API.py * Minor fixes for llama2 API * Fix for llama2 API * removed table of contents * enabled llama2-nvidia + vllm-NM : WIP * enabled dlrm for intel * lower cased implementation * added raw data input * corrected data download commands * renamed filename * changes for bert and vllm * documentation to work on custom repo and branch * benchmark index page update * enabled sdxl for nvidia and intel * updated vllm server run cmd * benchmark page information addition * fix indendation issue * Added submission categories * update submission page - generate submission with or w/o using CM for benchmarking * Updated kits dataset documentation * Updated model parameters * updation of information * updated non cm based benchmark * added info about hf password * added links to model and access tokens * Updated reference results structuree tree * submission docs cleanup * Some cleanups for benchmark info * Some cleanups for benchmark info * Some cleanups for benchmark info * added generic stubs deepsparse * Some cleanups for benchmark info * Some cleanups for benchmark info * Some cleanups for benchmark info * Some cleanups for benchmark info (FID and CLIP data added) * typo fix for bert deepsparse framework * added min system requirements for models * fixed code version * changes for displaying reference and intel implementation tip * added reference to installation page * updated neural magic documentation * Added links to the install page, redirect benchmarks page * added tips about batch size and dataset for nvidia llama2 * fix conditions logic * modified tips and additional run cmds * sentence corrections * Minor fix for the documentation * fixed bug in deepsparse generic model stubs + styling * added more information to stubs * Added SCC24 readme, support reproducibility in the docs * Made clear the custom CM repo URL format * Support conditional implementation, setup and run tips * Support rocm for sdxl * Fix _short tag support * Fix install URL * Expose bfloat16 and float16 options for sdxl * Expose download model to host option for sdxl * IndySCC24 documentation added * Improve the SCC24 docs * Improve the support of short variation * Improved the indyscc24 documentation * Updated scc run commands * removed test_query_count option for scc * Remove scc24 in the main docs * Remove scc24 in the main docs * Fix docs: indendation issue on the submission page * generalised code for skipping test query count * Fixes for SCC24 docs * Fix scenario text in main.py * Fix links for scc24 * Fix links for scc24 * Improve the general docs * Fix links for scc24 * Use float16 in scc24 doc * Improve scc24 docs * Improve scc24 docs * Use float16 in scc24 doc * fixed command bug --------- Co-authored-by: Nathan Wasson <[email protected]> Co-authored-by: anandhu-eng <[email protected]> Co-authored-by: ANANDHU S <[email protected]> Co-authored-by: Michael Goin <[email protected]>
mlcommons · Sep 24, 2024 · c4d0b3e · c4d0b3e
1 parent 7d2f0c4
commit c4d0b3e
Show file tree

Hide file tree

Showing 15 changed files with 376 additions and 163 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](site: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,10 @@ hide:
   - toc
 ---
 
+
 # Image Classification using ResNet50 
 
+
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 

diff --git a/docs/benchmarks/language/gpt-j.md b/docs/benchmarks/language/gpt-j.md
@@ -5,7 +5,6 @@ hide:
 
 # Text Summarization using GPT-J
 
-
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 

diff --git a/docs/benchmarks/language/llama2-70b.md b/docs/benchmarks/language/llama2-70b.md
@@ -5,7 +5,6 @@ hide:
 
 # Text Summarization using LLAMA2-70b
 
-
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 
@@ -25,4 +24,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,9 @@ hide:
   - toc
 ---
 
+# Question Answering, Math, and Code Generation using Mixtral-8x7B
+
 === "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/language/reproducibility/indyscc24-bert.md b/docs/benchmarks/language/reproducibility/indyscc24-bert.md
@@ -0,0 +1,48 @@
+---
+hide:
+  - toc
+---
+
+# Question and Answering using Bert Large for IndySCC 2024
+
+## Introduction
+
+This guide is designed for the [IndySCC 2024](https://sc24.supercomputing.org/students/indyscc/) to walk participants through running and optimizing the [MLPerf Inference Benchmark](https://arxiv.org/abs/1911.02549) using [Bert Large](https://github.com/mlcommons/inference/tree/master/language/bert#supported-models) across various software and hardware configurations. The goal is to maximize system throughput (measured in samples per second) without compromising accuracy.
+
+For a valid MLPerf inference submission, two types of runs are required: a performance run and an accuracy run. In this competition, we focus on the `Offline` scenario, where throughput is the key metric—higher values are better. The official MLPerf inference benchmark for Bert Large requires processing a minimum of 10833 samples in both performance and accuracy modes using the Squad v1.1 dataset. Setting up for Nvidia GPUs may take 2-3 hours but can be done offline. Your final output will be a tarball (`mlperf_submission.tar.gz`) containing MLPerf-compatible results, which you will submit to the SCC organizers for scoring.
+
+## Scoring
+
+In the SCC, your first objective will be to run a reference (unoptimized) Python implementation or a vendor-provided version (such as Nvidia's) of the MLPerf inference benchmark to secure a baseline score.
+
+Once the initial run is successful, you'll have the opportunity to optimize the benchmark further by maximizing system utilization, applying quantization techniques, adjusting ML frameworks, experimenting with batch sizes, and more, all of which can earn you additional points.
+
+Since vendor implementations of the MLPerf inference benchmark vary and are often limited to single-node benchmarking, teams will compete within their respective hardware categories (e.g., Nvidia GPUs, AMD GPUs). Points will be awarded based on the throughput achieved on your system.
+
+
+!!! info
+    Both MLPerf and CM automation are evolving projects.
+    If you encounter issues or have questions, please submit them [here](https://github.com/mlcommons/cm4mlops/issues)
+
+## Artifacts to submit to the SCC committee
+
+You will need to submit the following files:
+
+* `mlperf_submission_short.tar.gz` - automatically generated file with validated MLPerf results.
+* `mlperf_submission_short_summary.json` - automatically generated summary of MLPerf results.
+* `mlperf_submission_short.run` - CM commands to run MLPerf BERT inference benchmark saved to this file.
+* `mlperf_submission_short.tstamps` - execution timestamps before and after CM command saved to this file.
+* `mlperf_submission_short.md` - description of your platform and some highlights of the MLPerf benchmark execution.
+
+
+
+=== "MLCommons-Python"
+    ## MLPerf Reference Implementation in Python
+
+{{ mlperf_inference_implementation_readme (4, "bert-99", "reference", extra_variation_tags=",_short", scenarios=["Offline"],categories=["Edge"], setup_tips=False) }}
+
+=== "Nvidia"
+    ## Nvidia MLPerf Implementation
+{{ mlperf_inference_implementation_readme (4, "bert-99", "nvidia", extra_variation_tags=",_short", scenarios=["Offline"],categories=["Edge"], setup_tips=False, implementation_tips=False) }}
+
+
diff --git a/docs/benchmarks/medical_imaging/3d-unet.md b/docs/benchmarks/medical_imaging/3d-unet.md
@@ -5,7 +5,6 @@ hide:
 
 # Medical Imaging using 3d-unet (KiTS 2019 kidney tumor segmentation task)
 
-
 === "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,6 @@ hide:
 
 # Recommendation using DLRM v2
 
-
-## Benchmark Implementations
 === "MLCommons-Python"
     ## MLPerf Reference Implementation in Python
 
@@ -26,4 +24,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/benchmarks/text_to_image/reproducibility/scc24.md b/docs/benchmarks/text_to_image/reproducibility/scc24.md
@@ -0,0 +1,96 @@
+---
+hide:
+  - toc
+---
+
+# Text-to-Image with Stable Diffusion for Student Cluster Competition 2024
+
+## Introduction
+
+This guide is designed for the [Student Cluster Competition 2024](https://sc24.supercomputing.org/students/student-cluster-competition/) to walk participants through running and optimizing the [MLPerf Inference Benchmark](https://arxiv.org/abs/1911.02549) using [Stable Diffusion XL 1.0](https://github.com/mlcommons/inference/tree/master/text_to_image#supported-models) across various software and hardware configurations. The goal is to maximize system throughput (measured in samples per second) without compromising accuracy. Since the model performs poorly on CPUs, it is essential to run it on GPUs.
+
+For a valid MLPerf inference submission, two types of runs are required: a performance run and an accuracy run. In this competition, we focus on the `Offline` scenario, where throughput is the key metric—higher values are better. The official MLPerf inference benchmark for Stable Diffusion XL requires processing a minimum of 5,000 samples in both performance and accuracy modes using the COCO 2014 dataset. However, for SCC, we have reduced this and we also have two variants. `scc-base` variant has dataset size reduced to 50 samples, making it possible to complete both performance and accuracy runs in approximately 5-10 minutes. `scc-main` variant has dataset size of 500 and running it will fetch extra points as compared to running just the base variant. Setting up for Nvidia GPUs may take 2-3 hours but can be done offline. Your final output will be a tarball (`mlperf_submission.tar.gz`) containing MLPerf-compatible results, which you will submit to the SCC organizers for scoring.
+
+## Scoring
+
+In the SCC, your first objective will be to run `scc-base` variant for reference (unoptimized) Python implementation or a vendor-provided version (such as Nvidia's) of the MLPerf inference benchmark to secure a baseline score.
+
+Once the initial run is successful, you'll have the opportunity to optimize the benchmark further by maximizing system utilization, applying quantization techniques, adjusting ML frameworks, experimenting with batch sizes, and more, all of which can earn you additional points.
+
+Since vendor implementations of the MLPerf inference benchmark vary and are often limited to single-node benchmarking, teams will compete within their respective hardware categories (e.g., Nvidia GPUs, AMD GPUs). Points will be awarded based on the throughput achieved on your system.
+
+Additionally, significant bonus points will be awarded if your team enhances an existing implementation, adds support for new hardware (such as an unsupported GPU), enables multi-node execution, or adds/extends scripts to [cm4mlops repository](https://github.com/mlcommons/cm4mlops/tree/main/script) supporting new devices, frameworks, implementations etc. All improvements must be made publicly available under the Apache 2.0 license and submitted alongside your results to the SCC committee to earn these bonus points, contributing to the MLPerf community.
+
+
+!!! info
+    Both MLPerf and CM automation are evolving projects.
+    If you encounter issues or have questions, please submit them [here](https://github.com/mlcommons/cm4mlops/issues)
+
+## Artifacts to submit to the SCC committee
+
+You will need to submit the following files:
+
+* `mlperf_submission.run` - CM commands to run MLPerf inference benchmark saved to this file.
+* `mlperf_submission.md` - description of your platform and some highlights of the MLPerf benchmark execution.
+* `<Team Name>` under which results are pushed to the github repository. 
+
+
+## SCC interview
+
+You are encouraged to highlight and explain the obtained MLPerf inference throughput on your system
+and describe any improvements and extensions to this benchmark (such as adding new hardware backend
+or supporting multi-node execution) useful for the community and [MLCommons](https://mlcommons.org).
+
+## Run Commands
+
+=== "MLCommons-Python"
+    ## MLPerf Reference Implementation in Python
+
+{{ mlperf_inference_implementation_readme (4, "sdxl", "reference", extra_variation_tags=",_short,_scc24-base", devices=["ROCm", "CUDA"],scenarios=["Offline"],categories=["Datacenter"], setup_tips=False, skip_test_query_count=True, extra_input_string="--precision=float16") }}
+
+=== "Nvidia"
+    ## Nvidia MLPerf Implementation
+{{ mlperf_inference_implementation_readme (4, "sdxl", "nvidia", extra_variation_tags=",_short,_scc24-base", scenarios=["Offline"],categories=["Datacenter"], setup_tips=False, implementation_tips=False, skip_test_query_count=True) }}
+
+!!! info
+    Once the above run is successful, you can change `_scc24-base` to `_scc24-main` to run the main variant.
+
+## Submission Commands
+
+### Generate actual submission tree
+
+```bash
+cm run script --tags=generate,inference,submission \
+   --clean \
+   --preprocess_submission=yes \
+   --run-checker \
+   --tar=yes \
+   --env.CM_TAR_OUTFILE=submission.tar.gz \
+   --division=open \
+   --category=datacenter \
+   --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
+   --run_style=test \
+   --adr.submission-checker.tags=_short-run \
+   --quiet \
+   --submitter=<Team Name>
+```
+
+* Use `--hw_name="My system name"` to give a meaningful system name.
+
+
+### Push Results to GitHub
+
+Fork the repository URL at [https://github.com/gateoverflow/cm4mlperf-inference](https://github.com/gateoverflow/cm4mlperf-inference). 
+
+Run the following command after **replacing `--repo_url` with your GitHub fork URL**.
+
+```bash
+cm run script --tags=push,github,mlperf,inference,submission \
+   --repo_url=https://github.com/gateoverflow/cm4mlperf-inference \
+   --repo_branch=mlperf-inference-results-scc24 \
+   --commit_message="Results on system <HW Name>" \
+   --quiet
+```
+
+Once uploaded give a Pull Request to the origin repository. Github action will be running there and once 
+finished you can see your submitted results at [https://gateoverflow.github.io/cm4mlperf-inference](https://gateoverflow.github.io/cm4mlperf-inference).
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,5 @@ mkdocs-material
 swagger-markdown
 mkdocs-macros-plugin
 ruamel.yaml
+mkdocs-redirects
+mkdocs-site-urls
diff --git a/docs/submission/index.md b/docs/submission/index.md
@@ -60,63 +60,63 @@ Once all the results across all the models are ready you can use the following c
 === "Closed Edge"
     ### Closed Edge Submission
     ```bash
-       cm run script --tags=generate,inference,submission \
-          --clean \
-          --preprocess_submission=yes \
-          --run-checker \
-          --submitter=MLCommons \
-          --tar=yes \
-          --env.CM_TAR_OUTFILE=submission.tar.gz \
-          --division=closed \
-          --category=edge \
-          --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
-          --quiet
+    cm run script --tags=generate,inference,submission \
+       --clean \
+       --preprocess_submission=yes \
+       --run-checker \
+       --submitter=MLCommons \
+       --tar=yes \
+       --env.CM_TAR_OUTFILE=submission.tar.gz \
+       --division=closed \
+       --category=edge \
+       --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
+       --quiet
     ```
 
 === "Closed Datacenter"
     ### Closed Datacenter Submission
     ```bash
-       cm run script --tags=generate,inference,submission \
-          --clean \
-          --preprocess_submission=yes \
-          --run-checker \
-          --submitter=MLCommons \
-          --tar=yes \
-          --env.CM_TAR_OUTFILE=submission.tar.gz \
-          --division=closed \
-          --category=datacenter \
-          --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
-          --quiet
+    cm run script --tags=generate,inference,submission \
+       --clean \
+       --preprocess_submission=yes \
+       --run-checker \
+       --submitter=MLCommons \
+       --tar=yes \
+       --env.CM_TAR_OUTFILE=submission.tar.gz \
+       --division=closed \
+       --category=datacenter \
+       --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
+       --quiet
     ```
 === "Open Edge"
     ### Open Edge Submission
     ```bash
-       cm run script --tags=generate,inference,submission \
-          --clean \
-          --preprocess_submission=yes \
-          --run-checker \
-          --submitter=MLCommons \
-          --tar=yes \
-          --env.CM_TAR_OUTFILE=submission.tar.gz \
-          --division=open \
-          --category=edge \
-          --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
-          --quiet
+    cm run script --tags=generate,inference,submission \
+       --clean \
+       --preprocess_submission=yes \
+       --run-checker \
+       --submitter=MLCommons \
+       --tar=yes \
+       --env.CM_TAR_OUTFILE=submission.tar.gz \
+       --division=open \
+       --category=edge \
+       --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
+       --quiet
     ```
 === "Open Datacenter"
     ### Closed Datacenter Submission
     ```bash
-       cm run script --tags=generate,inference,submission \
-          --clean \
-          --preprocess_submission=yes \
-          --run-checker \
-          --submitter=MLCommons \
-          --tar=yes \
-          --env.CM_TAR_OUTFILE=submission.tar.gz \
-          --division=open \
-          --category=datacenter \
-          --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
-          --quiet
+    cm run script --tags=generate,inference,submission \
+       --clean \
+       --preprocess_submission=yes \
+       --run-checker \
+       --submitter=MLCommons \
+       --tar=yes \
+       --env.CM_TAR_OUTFILE=submission.tar.gz \
+       --division=open \
+       --category=datacenter \
+       --env.CM_DETERMINE_MEMORY_CONFIGURATION=yes \
+       --quiet
     ```
 
 * Use `--hw_name="My system name"` to give a meaningful system name. Examples can be seen [here](https://github.com/mlcommons/inference_results_v3.0/tree/main/open/cTuning/systems)
@@ -134,7 +134,7 @@ If you are collecting results across multiple systems you can generate different
 Run the following command after **replacing `--repo_url` with your GitHub repository URL**.
 
 ```bash
-   cm run script --tags=push,github,mlperf,inference,submission \
+cm run script --tags=push,github,mlperf,inference,submission \
    --repo_url=https://github.com/GATEOverflow/mlperf_inference_submissions_v4.1 \
    --commit_message="Results on <HW name> added by <Name>" \
    --quiet