superbenchmark/README.md

# SuperBench

[![Build Image](https://github.com/microsoft/superbenchmark/workflows/Build%20Image/badge.svg)](https://github.com/microsoft/superbenchmark/actions/workflows/build-image.yml)
[![Codecov](https://codecov.io/gh/microsoft/superbenchmark/branch/main/graph/badge.svg?token=DDiDLW7pSd)](https://codecov.io/gh/microsoft/superbenchmark)
[![Website](https://img.shields.io/website?down_color=lightgrey&url=https%3A%2F%2Faka.ms%2Fsuperbench)](https://aka.ms/superbench)
[![Latest Release](https://img.shields.io/github/release/microsoft/superbenchmark.svg)](https://github.com/microsoft/superbenchmark/releases/latest)
[![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)           |
| 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.9.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.9.0) has been released!

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

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
trademarks or logos is subject to and must follow
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.
Docs - Update SuperBench documents (#101) Update SuperBench documents. 2021-06-25 08:40:14 +03:00			`# SuperBench`
Updating README.md to template content 2020-12-17 05:22:27 +03:00
Docs - Update README and version for v0.2.0 release (#111) Update README and version for v0.2 release. 2021-07-02 19:18:30 +03:00			`[![Build Image](https://github.com/microsoft/superbenchmark/workflows/Build%20Image/badge.svg)](https://github.com/microsoft/superbenchmark/actions/workflows/build-image.yml)`
Setup: Code Revision - Rename dev branch to main in config and readme (#55) * Rename dev branch to main and set it as default. 2021-04-14 12:40:34 +03:00			`[![Codecov](https://codecov.io/gh/microsoft/superbenchmark/branch/main/graph/badge.svg?token=DDiDLW7pSd)](https://codecov.io/gh/microsoft/superbenchmark)`
Docs - Update README and version for v0.2.0 release (#111) Update README and version for v0.2 release. 2021-07-02 19:18:30 +03:00			`[![Website](https://img.shields.io/website?down_color=lightgrey&url=https%3A%2F%2Faka.ms%2Fsuperbench)](https://aka.ms/superbench)`
			`[![Latest Release](https://img.shields.io/github/release/microsoft/superbenchmark.svg)](https://github.com/microsoft/superbenchmark/releases/latest)`
			`[![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)`
Setup: Code Revision - Rename dev branch to main in config and readme (#55) * Rename dev branch to main and set it as default. 2021-04-14 12:40:34 +03:00
Release - SuperBench v0.4.0 (#278) __Description__ Cherry-pick bug fixes from v0.4.0 to main. __Major Revisions__ * Bug - Fix issues for Ansible and benchmarks (#267) * Tests - Refine test cases for microbenchmark (#268) * Bug - Build openmpi with ucx support in rocm dockerfiles (#269) * Benchmarks: Fix Bug - Fix fio build issue (#272) * Docs - Unify metric and add doc for cublas and cudnn functions (#271) * Monitor: Revision - Add 'monitor/' prefix to monitor metrics in result summary (#274) * Bug - Fix bug of detecting if gpu_index is none (#275) * Bug - Fix bugs in data diagnosis (#273) * Bug - Fix issue that the root mpi rank may not be the first in the hostfile (#270) * Benchmarks: Configuration - Update inference and network benchmarks in configs (#276) * Docs - Upgrade version and release note (#277) Co-authored-by: Yuting Jiang <v-yutjiang@microsoft.com> 2021-12-30 11:24:00 +03:00			`\| 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) \|`
Docs - Update README and version for v0.2.0 release (#111) Update README and version for v0.2 release. 2021-07-02 19:18:30 +03:00			`\| 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) \|`
Updating README.md to template content 2020-12-17 05:22:27 +03:00
Docs - Update SuperBench documents (#101) Update SuperBench documents. 2021-06-25 08:40:14 +03:00			`__SuperBench__ is a validation and profiling tool for AI infrastructure.`
Updating README.md to template content 2020-12-17 05:22:27 +03:00
Release - SuperBench v0.9.0 (#558) Description Cherry-pick bug fixes from v0.9.0 to main. Major Revision - CI/CD: pipeline - clean more disk space to fix rocm building image pipeline(#555 ) - Benchmarks: bug fix - use absolute path for input file in DirectXEncodingLatency(#554) - CI/CD - add push win docker image on release branch in pipeline (#552) - Docs - Upgrade version and release note(#557) 2023-07-27 05:42:31 +03:00			`📢 [v0.9.0](https://github.com/microsoft/superbenchmark/releases/tag/v0.9.0) has been released!`
Docs - Update README and version for v0.2.0 release (#111) Update README and version for v0.2 release. 2021-07-02 19:18:30 +03:00
			`## _Check [aka.ms/superbench](https://aka.ms/superbench) for more details._`
Setup: Add Feature - Add contribute rules (#8) * Setup: Add contribute rules 2021-02-03 06:05:51 +03:00
Updating README.md to template content 2020-12-17 05:22:27 +03:00			`## Trademarks`

Setup: Init - Initialize setup.py and basic configs (#4) Initialize setup.py and basic configurations for this project. Major revisions: - initialize setup.py for Python package - add gitignore and dockerignore - add editorconfig for editors - configure yapf for auto formating - configure mypy for type hint - configure flake8 for lint, including quotes and docstrings - add pre-commit check for `git commit` - add spelling check in GitHub Actions - format existing files according to configured rules Example usage: # install dependencies $ python3 -m pip install -e .[dev,test] $ pre-commit install # format code automatically $ python3 setup.py format # lint code $ python3 setup.py lint # test code $ python3 setup.py test 2021-01-28 16:01:28 +03:00			`This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft`
			`trademarks or logos is subject to and must follow`
Updating README.md to template content 2020-12-17 05:22:27 +03:00			`[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).`
			`Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.`
			`Any use of third-party trademarks or logos are subject to those third-party's policies.`