Unverified Commit 74c4d1b2 authored by Yifan Xiong's avatar Yifan Xiong Committed by GitHub
Browse files

Setup: Code Revision - Rename dev branch to main in config and readme (#55)

* Rename dev branch to main and set it as default.
parent 5e689720
...@@ -2,8 +2,7 @@ ...@@ -2,8 +2,7 @@
# Licensed under the MIT license. # Licensed under the MIT license.
trigger: trigger:
- master - main
- dev
pool: pool:
name: SuperBench CI name: SuperBench CI
......
...@@ -18,7 +18,6 @@ coverage: ...@@ -18,7 +18,6 @@ coverage:
- cuda-unit-test - cuda-unit-test
branches: branches:
- main - main
- dev
patch: patch:
default: default:
target: 80% target: 80%
...@@ -28,4 +27,3 @@ coverage: ...@@ -28,4 +27,3 @@ coverage:
- cuda-unit-test - cuda-unit-test
branches: branches:
- main - main
- dev
...@@ -4,7 +4,6 @@ on: ...@@ -4,7 +4,6 @@ on:
pull_request: pull_request:
branches: branches:
- main - main
- dev
jobs: jobs:
spelling: spelling:
......
# SuperBenchmark # SuperBenchmark
[![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/cuda-unit-test?branchName=dev)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=80&branchName=dev)
[![Lint](https://github.com/microsoft/superbenchmark/workflows/Lint/badge.svg)](https://github.com/microsoft/superbenchmark/actions?query=workflow%3ALint) [![Lint](https://github.com/microsoft/superbenchmark/workflows/Lint/badge.svg)](https://github.com/microsoft/superbenchmark/actions?query=workflow%3ALint)
[![Codecov](https://codecov.io/gh/microsoft/superbenchmark/branch/dev/graph/badge.svg?token=DDiDLW7pSd)](https://codecov.io/gh/microsoft/superbenchmark/branch/dev) [![Codecov](https://codecov.io/gh/microsoft/superbenchmark/branch/main/graph/badge.svg?token=DDiDLW7pSd)](https://codecov.io/gh/microsoft/superbenchmark)
| Azure Pipelines | Build Status |
| :---: | :---: |
| cpu-unit-test | [![Build Status](https://dev.azure.com/msrasrg/SuperBenchmark/_apis/build/status/microsoft.superbenchmark?branchName=main)](https://dev.azure.com/msrasrg/SuperBenchmark/_build/latest?definitionId=77&branchName=main) |
| gpu-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) |
SuperBench is a benchmarking and diagnosis tool for AI infrastructure, SuperBench is a benchmarking and diagnosis tool for AI infrastructure,
...@@ -23,7 +27,7 @@ and model-benchmark to measure domain-aware end-to-end deep learning workloads. ...@@ -23,7 +27,7 @@ and model-benchmark to measure domain-aware end-to-end deep learning workloads.
> 🔴 __Note__: > 🔴 __Note__:
SuperBench is in the early pre-alpha stage for open source, and not ready for general public yet. SuperBench is in the early pre-alpha stage for open source, and not ready for general public yet.
If you want to jump in early, you can try building [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev) yourself. If you want to jump in early, you can try building latest code yourself.
## Installation ## Installation
...@@ -122,14 +126,13 @@ Please find more benchmark examples [here](examples/benchmarks/). ...@@ -122,14 +126,13 @@ Please find more benchmark examples [here](examples/benchmarks/).
## Developer Guide ## Developer Guide
Follow [Installation using Python](#using-python) and Follow [Installation using Python](#using-python).
use [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
### Set Up ### Set Up
```sh ```sh
# get dev branch code # get latest code
git clone -b dev https://github.com/microsoft/superbenchmark git clone https://github.com/microsoft/superbenchmark
cd superbenchmark cd superbenchmark
# install superbench # install superbench
...@@ -157,7 +160,7 @@ Please install `pre-commit` before `git commit` to run all pre-checks. ...@@ -157,7 +160,7 @@ Please install `pre-commit` before `git commit` to run all pre-checks.
pre-commit install pre-commit install
``` ```
Pull requests should be submitted to [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev). Open a pull request to main branch on GitHub.
## Contributing ## Contributing
...@@ -185,16 +188,16 @@ SuperBenchmark is an open-source project. Your participation and contribution ar ...@@ -185,16 +188,16 @@ SuperBenchmark is an open-source project. Your participation and contribution ar
1. Bug fixes for existing features. 1. Bug fixes for existing features.
2. New features for benchmark module (micro-benchmark, model-benchmark, etc.) 2. New features for benchmark module (micro-benchmark, model-benchmark, etc.)
If you would like to contribute a new feature on SuperBenchmark, please submit your proposal first. In [GitHub Issues](https://github.com/microsoft/superbenchmark/issues) module, choose `Enhancement Request` to finish the submission. If the proposal is accepted, you can submit pull request to origin [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev). If you would like to contribute a new feature on SuperBenchmark, please submit your proposal first. In [GitHub Issues](https://github.com/microsoft/superbenchmark/issues) module, choose `Enhancement Request` to finish the submission. If the proposal is accepted, you can submit pull requests to origin main branch.
#### Contribution steps #### Contribution steps
If you would like to contribute to the project, please follow below steps of joint development on GitHub. If you would like to contribute to the project, please follow below steps of joint development on GitHub.
1. `Fork` the repo first to your personal GitHub account. 1. `Fork` the repo first to your personal GitHub account.
2. Check out from [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev) for feature development. 2. Checkout from main branch for feature development.
3. When you finish the feature, please fetch the latest code from origin repo, merge to your branch and resolve conflict. 3. When you finish the feature, please fetch the latest code from origin repo, merge to your branch and resolve conflict.
4. Submit pull request to origin [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev). 4. Submit pull requests to origin main branch.
5. Please note that there might be comments or questions from reviewers. It will need your help to update the pull request. 5. Please note that there might be comments or questions from reviewers. It will need your help to update the pull request.
## Trademarks ## Trademarks
......
...@@ -7,8 +7,7 @@ ...@@ -7,8 +7,7 @@
# https://aka.ms/yaml # https://aka.ms/yaml
trigger: trigger:
- master - main
- dev
resources: resources:
- repo: self - repo: self
......
...@@ -83,7 +83,7 @@ ENV PATH="${PATH}:/usr/local/cmake/bin:/usr/local/nccl-tests/build" \ ...@@ -83,7 +83,7 @@ ENV PATH="${PATH}:/usr/local/cmake/bin:/usr/local/nccl-tests/build" \
LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:/usr/local/lib" \ LD_LIBRARY_PATH="${LD_LIBRARY_PATH}:/usr/local/lib" \
SB_HOME="/opt/superbench" SB_HOME="/opt/superbench"
ARG SB_VERSION="dev" ARG SB_VERSION="main"
RUN git clone -b ${SB_VERSION} https://github.com/microsoft/superbenchmark ${SB_HOME} && \ RUN git clone -b ${SB_VERSION} https://github.com/microsoft/superbenchmark ${SB_HOME} && \
cd ${SB_HOME} && \ cd ${SB_HOME} && \
python3 -m pip install .[torch] python3 -m pip install .[torch]
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment