Docs - Initialize README (#6)
Initialize README.md and update SUPPORT.md, update * project description * installation * usage * developer guide * add dependencies version requirement
This commit is contained in:
Yifan Xiong
GitHub
Родитель
a897738699
Коммит
3f19685fd9
126
README.md
126
README.md
|
|
@ -1,14 +1,124 @@
|
|||
# Project
|
||||
# SuperBenchmark
|
||||
|
||||
> This repo has been populated by an initial template to help get you started. Please
|
||||
> make sure to update the content to build a great experience for community-building.
|
||||
[](https://dev.azure.com/msrasrg/SuperBenchmark/_build?definitionId=77)
|
||||
[](https://github.com/microsoft/superbenchmark/actions?query=workflow%3ALint)
|
||||
|
||||
As the maintainer of this project, please make a few updates:
|
||||
|
||||
- Improving this README.MD file to provide a great experience
|
||||
- Updating SUPPORT.MD with content about this project's support experience
|
||||
- Understanding the security reporting process in SECURITY.MD
|
||||
- Remove this section from the README
|
||||
SuperBench is a benchmarking and diagnosis tool for AI infrastructure,
|
||||
which supports:
|
||||
* Comprehensive AI infrastructure validation
|
||||
* Distributed validation tools to validate hundreds or thousands of servers automatically
|
||||
* Consider both raw hardware and E2E model performance with ML workload patterns
|
||||
* Provide a fast and accurate way to detect and locate hardware problems
|
||||
* Performance/Quality Gates for hardware and system release
|
||||
* Benchmarking with typical AI workload patterns
|
||||
* Provide comprehensive performance comparison between different existing hardware
|
||||
* Give a better understanding for new DL software & hardware
|
||||
* Detailed performance analysis and diagnosis
|
||||
* Provide detailed performance report and advanced analysis tool
|
||||
|
||||
It includes micro-benchmark for primitive computation and communication benchmarking,
|
||||
and model-benchmark to measure domain-aware end-to-end deep learning workloads.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
### Using Python
|
||||
|
||||
System requirements:
|
||||
* Python: Python 3.6 or later, pip 18.0 or later
|
||||
* Platform: Ubuntu 16.04 or later (64-bit), Windows 10 (64-bit) with WSL2
|
||||
|
||||
Check whether Python environment is already configured:
|
||||
```sh
|
||||
# check Python version
|
||||
python3 --version
|
||||
# check pip version
|
||||
python3 -m pip --version
|
||||
```
|
||||
If not, install the followings:
|
||||
* [Python](https://www.python.org/)
|
||||
* [pip](https://pip.pypa.io/en/stable/installing/)
|
||||
* [venv](https://docs.python.org/3/library/venv.html)
|
||||
|
||||
It's recommended to use a virtual environment (optional):
|
||||
```sh
|
||||
# create a new virtual environment
|
||||
python3 -m venv --system-site-packages ./venv
|
||||
# activate the virtual environment
|
||||
source ./venv/bin/activate
|
||||
|
||||
# exit the virtual environment later
|
||||
# after you finish running superbench
|
||||
deactivate
|
||||
```
|
||||
|
||||
Then install superbench through either PyPI binary or from source:
|
||||
|
||||
1. PyPI Binary
|
||||
|
||||
TODO
|
||||
|
||||
2. From Source
|
||||
|
||||
```sh
|
||||
# get source code
|
||||
git clone https://github.com/microsoft/superbenchmark
|
||||
cd superbenchmark
|
||||
|
||||
# install superbench
|
||||
python3 -m pip install .
|
||||
```
|
||||
|
||||
### Using Docker
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
TODO
|
||||
|
||||
|
||||
## Developer Guide
|
||||
|
||||
Follow [Installation using Python](#using-python) and
|
||||
use [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
|
||||
|
||||
### Set Up
|
||||
|
||||
```sh
|
||||
# get dev branch code
|
||||
git clone -b dev https://github.com/microsoft/superbenchmark
|
||||
cd superbenchmark
|
||||
|
||||
# install superbench
|
||||
python3 -m pip install -e .[dev,test]
|
||||
```
|
||||
|
||||
### Lint and Test
|
||||
|
||||
```sh
|
||||
# format code using yapf
|
||||
python3 setup.py format
|
||||
|
||||
# check code style with mypy and flake8
|
||||
python3 setup.py lint
|
||||
|
||||
# run all unit tests
|
||||
python3 setup.py test
|
||||
```
|
||||
|
||||
### Submit a Pull Request
|
||||
|
||||
Please install `pre-commit` before `git commit` to run all pre-checks.
|
||||
|
||||
```sh
|
||||
pre-commit install
|
||||
```
|
||||
|
||||
Pull requests should be submitted to [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
|
|||
23
SUPPORT.md
23
SUPPORT.md
|
|
@ -1,25 +1,16 @@
|
|||
# TODO: The maintainer of this repo has not yet edited this file
|
||||
|
||||
**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
|
||||
|
||||
- **No CSS support:** Fill out this template with information about how to file issues and get help.
|
||||
- **Yes CSS support:** Fill out an intake form at [aka.ms/spot](https://aka.ms/spot). CSS will work with/help you to determine next steps. More details also available at [aka.ms/onboardsupport](https://aka.ms/onboardsupport).
|
||||
- **Not sure?** Fill out a SPOT intake as though the answer were "Yes". CSS will help you decide.
|
||||
|
||||
*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
|
||||
|
||||
# Support
|
||||
|
||||
## How to file issues and get help
|
||||
|
||||
This project uses GitHub Issues to track bugs and feature requests. Please search the existing
|
||||
issues before filing new issues to avoid duplicates. For new issues, file your bug or
|
||||
feature request as a new Issue.
|
||||
This project uses [GitHub Issues] to track bugs and feature requests. Please search the existing
|
||||
issues before filing new issues to avoid duplicates. For new issues, file your bug or
|
||||
feature request as a new issue.
|
||||
|
||||
For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
|
||||
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
|
||||
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
|
||||
For help and questions about using this project, please create a new post in [GitHub Discussions].
|
||||
|
||||
## Microsoft Support Policy
|
||||
|
||||
Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
|
||||
|
||||
[GitHub Issues]: https://github.com/microsoft/superbenchmark/issues
|
||||
[GitHub Discussions]: https://github.com/microsoft/superbenchmark/discussions
|
||||
|
|
|
|||
19
setup.py
19
setup.py
|
|
@ -134,14 +134,15 @@ setup(
|
|||
python_requires='>=3.6, <4',
|
||||
install_requires=[],
|
||||
extras_require={
|
||||
'dev': ['pre-commit'],
|
||||
'dev': ['pre-commit>=2.10.0'],
|
||||
'test': [
|
||||
'yapf',
|
||||
'mypy',
|
||||
'flake8',
|
||||
'flake8-quotes',
|
||||
'flake8-docstrings',
|
||||
'pytest',
|
||||
'yapf>=0.30.0',
|
||||
'mypy>=0.800',
|
||||
'flake8>=3.8.4',
|
||||
'flake8-quotes>=3.2.0',
|
||||
'flake8-docstrings>=1.5.0',
|
||||
'pydocstyle>=5.1.1',
|
||||
'pytest>=6.2.2',
|
||||
],
|
||||
},
|
||||
package_data={},
|
||||
|
|
@ -153,4 +154,8 @@ setup(
|
|||
'lint': Linter,
|
||||
'test': Tester,
|
||||
},
|
||||
project_urls={
|
||||
'Source': 'https://github.com/microsoft/superbenchmark',
|
||||
'Tracker': 'https://github.com/microsoft/superbenchmark/issues',
|
||||
},
|
||||
)
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче