Docs - Upgrade version and release note (#277)

__Description__ Upgrade version and release note. __Major Revision__ - Upgrade package versions - Add release note for v0.4.0
microsoft · Dec 28, 2021 · 525cec7 · 525cec7
1 parent 8628545
commit 525cec7
Show file tree

Hide file tree

Showing 18 changed files with 81 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -7,15 +7,15 @@
 [![Docker Pulls](https://img.shields.io/docker/pulls/superbench/superbench.svg)](https://hub.docker.com/r/superbench/superbench/tags)
 [![License](https://img.shields.io/github/license/microsoft/superbenchmark.svg)](LICENSE)
 
-| Azure Pipelines | Build Status |
-| :---: | :---: |
-| cpu-unit-test | [![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/cpu-unit-test?branchName=main)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=77&branchName=main) |
-| cuda-unit-test | [![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/cuda-unit-test?branchName=main)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=80&branchName=main) |
+| Azure Pipelines          | Build Status                                                                                                                                                                                                            |
+|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| cpu-unit-test            | [![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/cpu-unit-test?branchName=main)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=77&branchName=main)            |
+| cuda-unit-test           | [![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/cuda-unit-test?branchName=main)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=80&branchName=main)           |
 | ansible-integration-test | [![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/ansible-integration-test?branchName=main)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=82&branchName=main) |
 
 __SuperBench__ is a validation and profiling tool for AI infrastructure.
 
-📢 [v0.3.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.3.0) has been released!
+📢 [v0.4.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.4.0) has been released!
 
 ## _Check [aka.ms/superbench](https://aka.ms/superbench) for more details._
 

diff --git a/docs/getting-started/installation.mdx b/docs/getting-started/installation.mdx
@@ -61,7 +61,7 @@ You can clone the source from GitHub and build it.
 :::note Note
 You should checkout corresponding tag to use release version, for example,
 
-`git clone -b v0.3.0 https://github.com/microsoft/superbenchmark`
+`git clone -b v0.4.0 https://github.com/microsoft/superbenchmark`
 :::
 
 ```bash

diff --git a/docs/getting-started/run-superbench.md b/docs/getting-started/run-superbench.md
@@ -27,7 +27,7 @@ sb deploy -f remote.ini --host-password [password]
 :::note Note
 You should deploy corresponding Docker image to use release version, for example,
 
-`sb deploy -f local.ini -i superbench/superbench:v0.3.0-cuda11.1.1`
+`sb deploy -f local.ini -i superbench/superbench:v0.4.0-cuda11.1.1`
 
 You should note that version of git repo only determines version of sb CLI, and not the sb container. You should define the container version even if you specified a release version for the git clone.
 

diff --git a/docs/superbench-config.mdx b/docs/superbench-config.mdx
@@ -70,7 +70,7 @@ superbench:
 <TabItem value='example'>
 
 ```yaml
-version: v0.3
+version: v0.4
 superbench:
   enable: benchmark_1
   monitor:

diff --git a/docs/user-tutorial/container-images.mdx b/docs/user-tutorial/container-images.mdx
@@ -29,6 +29,7 @@ available tags are listed below for all stable versions.
 
 | Tag               | Description                        |
 | ----------------- | ---------------------------------- |
+| v0.4.0-cuda11.1.1 | SuperBench v0.4.0 with CUDA 11.1.1 |
 | v0.3.0-cuda11.1.1 | SuperBench v0.3.0 with CUDA 11.1.1 |
 | v0.2.1-cuda11.1.1 | SuperBench v0.2.1 with CUDA 11.1.1 |
 | v0.2.0-cuda11.1.1 | SuperBench v0.2.0 with CUDA 11.1.1 |
@@ -38,6 +39,8 @@ available tags are listed below for all stable versions.
 
 | Tag                         | Description                                    |
 | --------------------------- | ---------------------------------------------- |
+| v0.4.0-rocm4.2-pytorch1.7.0 | SuperBench v0.4.0 with ROCm 4.2, PyTorch 1.7.0 |
+| v0.4.0-rocm4.0-pytorch1.7.0 | SuperBench v0.4.0 with ROCm 4.0, PyTorch 1.7.0 |
 | v0.3.0-rocm4.2-pytorch1.7.0 | SuperBench v0.3.0 with ROCm 4.2, PyTorch 1.7.0 |
 | v0.3.0-rocm4.0-pytorch1.7.0 | SuperBench v0.3.0 with ROCm 4.0, PyTorch 1.7.0 |
 

diff --git a/docs/user-tutorial/data-diagnosis.md b/docs/user-tutorial/data-diagnosis.md
@@ -64,7 +64,7 @@ superbench:
 example:
 ```yaml
 # SuperBench rules
-version: v0.3
+version: v0.4
 superbench:
   rules:
     failure-rule:

diff --git a/setup.py b/setup.py
@@ -165,7 +165,7 @@ def run(self):
             'pytest>=6.2.2',
             'types-pyyaml',
             'vcrpy>=4.1.1',
-            'yapf>=0.30.0',
+            'yapf==0.31.0',
         ],
         'nvidia': ['py3nvml>=0.2.6'],
         'ort': [

diff --git a/superbench/__init__.py b/superbench/__init__.py
@@ -6,5 +6,5 @@
 Provide hardware and software benchmarks for AI systems.
 """
 
-__version__ = '0.3.0'
+__version__ = '0.4.0'
 __author__ = 'Microsoft'
diff --git a/superbench/config/amd_mi100_hpe.yaml b/superbench/config/amd_mi100_hpe.yaml
@@ -3,7 +3,7 @@
 # Server:
 #   - Product: HPE Apollo 6500
 
-version: v0.3
+version: v0.4
 superbench:
   enable: null
   var:

diff --git a/superbench/config/amd_mi100_z53.yaml b/superbench/config/amd_mi100_z53.yaml
@@ -4,7 +4,7 @@
 #   - Product: G482-Z53
 #   - Link: https://www.gigabyte.cn/FileUpload/Global/MicroSite/553/G482-Z53.html
 
-version: v0.3
+version: v0.4
 superbench:
   enable: null
   var:

diff --git a/superbench/config/azure_ndmv4.yaml b/superbench/config/azure_ndmv4.yaml
@@ -3,7 +3,7 @@
 # Azure NDm A100 v4
 # reference: https://docs.microsoft.com/en-us/azure/virtual-machines/ndm-a100-v4-series
 
-version: v0.3
+version: v0.4
 superbench:
   enable: null
   monitor:

diff --git a/superbench/config/azure_ndv4.yaml b/superbench/config/azure_ndv4.yaml
@@ -1,5 +1,5 @@
 # SuperBench Config
-version: v0.3
+version: v0.4
 superbench:
   enable: null
   monitor:

diff --git a/superbench/config/default.yaml b/superbench/config/default.yaml
@@ -1,5 +1,5 @@
 # SuperBench Config
-version: v0.3
+version: v0.4
 superbench:
   enable: null
   monitor:

diff --git a/tests/analyzer/test_rules.yaml b/tests/analyzer/test_rules.yaml
@@ -1,5 +1,5 @@
 # SuperBench rules
-version: v0.3
+version: v0.4
 superbench:
   rules:
     rule0:

diff --git a/website/blog/2021-12-24-release-0-4.md b/website/blog/2021-12-24-release-0-4.md
@@ -0,0 +1,58 @@
+---
+slug: release-sb-v0.4
+title: Releasing SuperBench v0.4
+author: Peng Cheng
+author_title: SuperBench Team
+author_url: https://github.com/cp5555
+author_image_url: https://github.com/cp5555.png
+tags: [superbench, announcement, release]
+---
+
+We are very happy to announce that **SuperBench 0.4.0 version** is officially released today!
+
+You can install and try superbench by following [Getting Started Tutorial](https://microsoft.github.io/superbenchmark/docs/getting-started/installation).
+
+## SuperBench 0.4.0 Release Notes
+
+### SuperBench Framework
+
+#### Monitor
+
+- Add monitor framework for NVIDIA GPU, CPU, memory and disk.
+
+#### Data Diagnosis and Analysis
+
+- Support baseline-based data diagnosis.
+- Support basic analysis feature (boxplot figure, outlier detection, etc.).
+
+### Single-node Validation
+
+#### Micro Benchmarks
+
+- CPU Memory Validation (tool: Intel Memory Latency Checker).
+- GPU Copy Bandwidth (tool: built by MSRA).
+- Add ORT Model on AMD GPU platform.
+- Add inference backend TensorRT.
+- Add inference backend ORT.
+
+### Multi-node Validation
+
+#### Micro Benchmarks
+
+- IB Networking validation.
+- TCP validation (tool: TCPing).
+- GPCNet Validation (tool: GPCNet).
+
+### Other Improvement
+
+1. Enhancement
+   - Add pipeline for AMD docker.
+   - Integrate system config info script with SuperBench.
+   - Support FP32 mode without TF32.
+   - Refine unit test for microbenchmark.
+   - Unify metric names for all benchmarks.
+
+2. Document
+   - Add benchmark list
+   - Add monitor document
+   - Add data diagnosis document
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -101,7 +101,7 @@ module.exports = {
     announcementBar: {
       id: 'supportus',
       content:
-        '📢 <a href="https://microsoft.github.io/superbenchmark/blog/release-sb-v0.3">v0.3.0</a> has been released! ' +
+        '📢 <a href="https://microsoft.github.io/superbenchmark/blog/release-sb-v0.4">v0.4.0</a> has been released! ' +
         '⭐️ If you like SuperBench, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/microsoft/superbenchmark">GitHub</a>! ⭐️',
     },
     algolia: {

diff --git a/website/package-lock.json b/website/package-lock.json
diff --git a/website/package.json b/website/package.json
@@ -1,6 +1,6 @@
 {
   "name": "superbench-website",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",