Please find more benchmark examples [here](examples/benchmarks/).
## Developer Guide
## Developer Guide
...
@@ -146,16 +185,16 @@ SuperBenchmark is an open-source project. Your participation and contribution ar
...
@@ -146,16 +185,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.
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).
#### 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 for feature development.
2. Check out from [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev) 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.
4. Submit pull request to origin [`dev` branch](https://github.com/microsoft/superbenchmark/tree/dev).
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.