Skip to content

Commit

Permalink
Docs - Upgrade version and release note (#467)
Browse files Browse the repository at this point in the history
__Description__

Upgrade version and release note.

__Major Revision__

- Upgrade package versions
- Add release note for v0.7.0
  • Loading branch information
abuccts committed Jan 20, 2023
1 parent 5a93ed4 commit d76e4e1
Show file tree
Hide file tree
Showing 20 changed files with 68 additions and 19 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

__SuperBench__ is a validation and profiling tool for AI infrastructure.

📢 [v0.6.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.6.0) has been released!
📢 [v0.7.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.7.0) has been released!

## _Check [aka.ms/superbench](https://aka.ms/superbench) for more details._

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0 https://github.com/microsoft/superbenchmark`
`git clone -b v0.7.0 https://github.com/microsoft/superbenchmark`
:::

```bash
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/run-superbench.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.6.0-cuda11.1.1`
`sb deploy -f local.ini -i superbench/superbench:v0.7.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.

Expand Down
3 changes: 1 addition & 2 deletions docs/superbench-config.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ superbench:
<TabItem value='example'>

```yaml
version: v0.6
version: v0.7
superbench:
enable: benchmark_1
monitor:
Expand Down Expand Up @@ -471,4 +471,3 @@ Available variables in formatted string includes:
+ `ibnetdiscover(str)`: the path of ibnetdiscover output `ibnetdiscover_file.txt`, required in `topo-aware` pattern.
+ `min_dist(int)`: minimum distance of VM pair, required in `topo-aware` pattern.
+ `max_dist(int)`: maximum distance of VM pair, required in `topo-aware` pattern.

6 changes: 6 additions & 0 deletions docs/user-tutorial/container-images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ available tags are listed below for all stable versions.

| Tag | Description |
|-------------------|------------------------------------|
| v0.7.0-cuda11.8 | SuperBench v0.7.0 with CUDA 11.8 |
| v0.7.0-cuda11.1.1 | SuperBench v0.7.0 with CUDA 11.1.1 |
| v0.6.0-cuda11.1.1 | SuperBench v0.6.0 with CUDA 11.1.1 |
| 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 |
Expand All @@ -41,6 +43,10 @@ available tags are listed below for all stable versions.

| Tag | Description |
|-------------------------------|--------------------------------------------------|
| v0.7.0-rocm5.1.3 | SuperBench v0.7.0 with ROCm 5.1.3 |
| v0.7.0-rocm5.1.1 | SuperBench v0.7.0 with ROCm 5.1.1 |
| v0.7.0-rocm5.0.1 | SuperBench v0.7.0 with ROCm 5.0.1 |
| v0.7.0-rocm5.0 | SuperBench v0.7.0 with ROCm 5.0 |
| v0.6.0-rocm5.1.3 | SuperBench v0.6.0 with ROCm 5.1.3 |
| v0.6.0-rocm5.1.1 | SuperBench v0.6.0 with ROCm 5.1.1 |
| v0.6.0-rocm5.0.1 | SuperBench v0.6.0 with ROCm 5.0.1 |
Expand Down
2 changes: 1 addition & 1 deletion docs/user-tutorial/data-diagnosis.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ superbench:
example:
```yaml
# SuperBench rules
version: v0.6
version: v0.7
superbench:
rules:
failure-rule:
Expand Down
2 changes: 1 addition & 1 deletion docs/user-tutorial/result-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ superbench:

```yaml title="Example"
# SuperBench rules
version: v0.6
version: v0.7
superbench:
rules:
kernel_launch:
Expand Down
2 changes: 1 addition & 1 deletion superbench/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@
Provide hardware and software benchmarks for AI systems.
"""

__version__ = '0.6.0'
__version__ = '0.7.0'
__author__ = 'Microsoft'
2 changes: 1 addition & 1 deletion superbench/config/amd_mi100_hpe.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Server:
# - Product: HPE Apollo 6500

version: v0.6
version: v0.7
superbench:
enable: null
var:
Expand Down
2 changes: 1 addition & 1 deletion superbench/config/amd_mi100_z53.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# - Product: G482-Z53
# - Link: https://www.gigabyte.cn/FileUpload/Global/MicroSite/553/G482-Z53.html

version: v0.6
version: v0.7
superbench:
enable: null
var:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: v0.6
version: v0.7
superbench:
enable: null
monitor:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: v0.6
version: v0.7
superbench:
enable: null
monitor:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: v0.6
version: v0.7
superbench:
enable: null
monitor:
Expand Down
2 changes: 1 addition & 1 deletion superbench/config/azure_ndmv4.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Azure NDm A100 v4
# reference: https://docs.microsoft.com/en-us/azure/virtual-machines/ndm-a100-v4-series

version: v0.6
version: v0.7
superbench:
enable: null
monitor:
Expand Down
2 changes: 1 addition & 1 deletion superbench/config/azure_ndv4.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SuperBench Config
version: v0.6
version: v0.7
superbench:
enable: null
monitor:
Expand Down
2 changes: 1 addition & 1 deletion superbench/config/default.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# SuperBench Config
version: v0.6
version: v0.7
superbench:
enable: null
monitor:
Expand Down
44 changes: 44 additions & 0 deletions website/blog/2023-01-20-release-0-7.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
slug: release-sb-v0.7
title: Releasing SuperBench v0.7
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.7.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.7.0 Release Notes

### SuperBench Improvement

- Support non-zero return code when "sb deploy" or "sb run" fails in Ansible.
- Support log flushing to the result file during runtime.
- Update version to include revision hash and date.
- Support "pattern" in mpi mode to run tasks in parallel.
- Support topo-aware, all-pair, and K-batch pattern in mpi mode.
- Fix Transformers version to avoid Tensorrt failure.
- Add CUDA11.8 Docker image for NVIDIA arch90 GPUs.
- Support "sb deploy" without pulling image.

### Micro-benchmark Improvements

- Support list of custom config string in cudnn-functions and cublas-functions.
- Support correctness check in cublas-functions.
- Support GEMM-FLOPS for NVIDIA arch90 GPUs.
- Support cuBLASLt FP16 and FP8 GEMM.
- Add wait time option to resolve mem-bw unstable issue.
- Fix bug for incorrect datatype judgement in cublas-function source code.

### Model Benchmark Improvements

- Support FP8 in BERT model training.

### Distributed Benchmark Improvements

- Support pair-wise pattern in IB validation benchmark.
- Support topo-aware, pair-wise, and K-batch pattern in nccl-bw benchmark.
2 changes: 1 addition & 1 deletion website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ module.exports = {
announcementBar: {
id: 'supportus',
content:
'📢 <a href="https://microsoft.github.io/superbenchmark/blog/release-sb-v0.6">v0.6.0</a> has been released! ' +
'📢 <a href="https://microsoft.github.io/superbenchmark/blog/release-sb-v0.7">v0.7.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: {
Expand Down
2 changes: 1 addition & 1 deletion website/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion website/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "superbench-website",
"version": "0.6.0",
"version": "0.7.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
Expand Down

0 comments on commit d76e4e1

Please sign in to comment.