Docs - Upgrade version and release note (#348)

abuccts · web-flow · commit 7f607e4f745b · 2022-04-28T15:45:35.000+08:00
__Description__

Upgrade version and release note.

__Major Revision__

- Upgrade package versions
- Add release note for v0.5.0
diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@
 
 __SuperBench__ is a validation and profiling tool for AI infrastructure.
 
-📢 [v0.4.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.4.0) has been released!
+📢 [v0.5.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.5.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.4.0 https://github.com/microsoft/superbenchmark`
+`git clone -b v0.5.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.4.0-cuda11.1.1`
+`sb deploy -f local.ini -i superbench/superbench:v0.5.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.4
+version: v0.5
 superbench:
   enable: benchmark_1
   monitor:
diff --git a/docs/user-tutorial/container-images.mdx b/docs/user-tutorial/container-images.mdx
@@ -28,7 +28,8 @@ available tags are listed below for all stable versions.
 <TabItem value='cuda'>
 
 | Tag               | Description                        |
-| ----------------- | ---------------------------------- |
+|-------------------|------------------------------------|
+| v0.5.0-cuda11.1.1 | SuperBench v0.5.0 with CUDA 11.1.1 |
 | 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 |
@@ -37,12 +38,16 @@ available tags are listed below for all stable versions.
 </TabItem>
 <TabItem value='rocm'>
 
-| 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 |
+| Tag                           | Description                                      |
+|-------------------------------|--------------------------------------------------|
+| v0.5.0-rocm5.0.1-pytorch1.9.0 | SuperBench v0.5.0 with ROCm 5.0.1, PyTorch 1.9.0 |
+| v0.5.0-rocm5.0-pytorch1.9.0   | SuperBench v0.5.0 with ROCm 5.0, PyTorch 1.9.0   |
+| v0.5.0-rocm4.2-pytorch1.7.0   | SuperBench v0.5.0 with ROCm 4.2, PyTorch 1.7.0   |
+| v0.5.0-rocm4.0-pytorch1.7.0   | SuperBench v0.5.0 with ROCm 4.0, PyTorch 1.7.0   |
+| 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   |
 
 </TabItem>
 </Tabs>
diff --git a/docs/user-tutorial/data-diagnosis.md b/docs/user-tutorial/data-diagnosis.md
@@ -65,7 +65,7 @@ superbench:
 example:
 ```yaml
 # SuperBench rules
-version: v0.4
+version: v0.5
 superbench:
   rules:
     failure-rule:
diff --git a/docs/user-tutorial/result-summary.md b/docs/user-tutorial/result-summary.md
@@ -58,7 +58,7 @@ superbench:
 
 ```yaml title="Example"
 # SuperBench rules
-version: v0.4
+version: v0.5
 superbench:
   rules:
     kernel_launch:
diff --git a/superbench/__init__.py b/superbench/__init__.py
@@ -6,5 +6,5 @@
 Provide hardware and software benchmarks for AI systems.
 """
 
-__version__ = '0.4.0'
+__version__ = '0.5.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.4
+version: v0.5
 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.4
+version: v0.5
 superbench:
   enable: null
   var:
diff --git a/superbench/config/azure/inference/nc64as_t4_v3.yaml b/superbench/config/azure/inference/nc64as_t4_v3.yaml
@@ -1,4 +1,4 @@
-version: v0.4
+version: v0.5
 superbench:
   enable: null
   monitor:
diff --git a/superbench/config/azure/inference/nc96ads_a100_v4.yaml b/superbench/config/azure/inference/nc96ads_a100_v4.yaml
@@ -1,4 +1,4 @@
-version: v0.4
+version: v0.5
 superbench:
   enable: null
   monitor:
diff --git a/superbench/config/azure/inference/nv18ads_a10_v5.yaml b/superbench/config/azure/inference/nv18ads_a10_v5.yaml
@@ -1,4 +1,4 @@
-version: v0.4
+version: v0.5
 superbench:
   enable: null
   monitor:
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.4
+version: v0.5
 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.4
+version: v0.5
 superbench:
   enable: null
   monitor:
diff --git a/superbench/config/default.yaml b/superbench/config/default.yaml
@@ -1,5 +1,5 @@
 # SuperBench Config
-version: v0.4
+version: v0.5
 superbench:
   enable: null
   monitor:
diff --git a/website/blog/2022-04-28-release-0-5.md b/website/blog/2022-04-28-release-0-5.md
@@ -0,0 +1,54 @@
+---
+slug: release-sb-v0.5
+title: Releasing SuperBench v0.5
+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.5.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.5.0 Release Notes
+
+### Micro-benchmark Improvements
+
+- Support NIC only NCCL bandwidth benchmark on single node in NCCL/RCCL bandwidth test.
+- Support bi-directional bandwidth benchmark in GPU copy bandwidth test.
+- Support data checking in GPU copy bandwidth test.
+- Update rccl-tests submodule to fix divide by zero error.
+- Add GPU-Burn micro-benchmark.
+
+### Model-benchmark Improvements
+
+- Sync results on root rank for e2e model benchmarks in distributed mode.
+- Support customized `env` in local and torch.distributed mode.
+- Add support for pytorch>=1.9.0.
+- Keep BatchNorm as fp32 for pytorch cnn models cast to fp16.
+- Remove FP16 samples type converting time.
+- Support FAMBench.
+
+### Inference Benchmark Improvements
+
+- Revise the default setting for inference benchmark.
+- Add percentile metrics for inference benchmarks.
+- Support T4 and A10 in GEMM benchmark.
+- Add configuration with inference benchmark.
+
+### Other Improvements
+
+- Add command to support listing all optional parameters for benchmarks.
+- Unify benchmark naming convention and support multiple tests with same benchmark and different parameters/options in one configuration file.
+- Support timeout to detect the benchmark failure and stop the process automatically.
+- Add rocm5.0 dockerfile.
+- Improve output interface.
+
+### Data Diagnosis and Analysis
+
+- Support multi-benchmark check.
+- Support result summary in md, html and excel formats.
+- Support data diagnosis in md and html formats.
+- Support result output for all nodes in data diagnosis.
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.4">v0.4.0</a> has been released! ' +
+        '📢 <a href="https://microsoft.github.io/superbenchmark/blog/release-sb-v0.5">v0.5.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.4.0",
+  "version": "0.5.0",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",
