Unverified Commit de481cb0 authored by TobeyQin's avatar TobeyQin Committed by GitHub
Browse files

Docs: Revision - Revise results contributing rule (#174)

**Description**
Revise results contributing rule.

- Change the results uploading path to [superbench-results](https://github.com/microsoft/superbench-results

) repo.
- Add description of how to get system info by command.
Co-authored-by: default avatarPeng Cheng <chengpeng5555@outlook.com>
parent 0b74b2aa
...@@ -48,41 +48,46 @@ If you want to contribute benchmark results run by specified SuperBench version, ...@@ -48,41 +48,46 @@ If you want to contribute benchmark results run by specified SuperBench version,
#### Where to submit #### Where to submit
All the results are stored under `results` folder. The directory structure is as follows. Please create `<your-benchmark-folder>` to submit results. All the results are stored under [superbench-results](https://github.com/microsoft/superbench-results) repository. The directory structure is as follows. Please create `<your-benchmark-folder>` to submit results.
``` ```
└── results superbench-results
├── v0.2 ├── v0.2
│   └── your-benchmark-foldername │   └── your-benchmark-foldername
│   ├── LICENSE.md │   ├── LICENSE.md
│   ├── README.md │   ├── README.md
│   ├── configs │   ├── configs
│   │   ├── config1.yaml │   │   ├── config1.yaml
│   │   └── config2.yaml │   │   └── config2.yaml
│   ├── results │   ├── results
│   │   ├── result1.json │   │   ├── result1.json
│   │   └── result2.json │   │   └── result2.json
│   └── systems │   └── systems
│   ├── system1.json │   ├── system1.json
│   └── system2.json │   └── system2.json
└── v0.3 └── v0.3
└── your-benchmark-foldername └── your-benchmark-foldername
├── LICENSE.md ├── LICENSE.md
├── README.md ├── README.md
├── configs ├── configs
│   ├── config1.yaml │   ├── config1.yaml
│   └── config2.yaml │   └── config2.yaml
├── results ├── results
│   ├── result1.json │   ├── result1.json
│   └── result2.json │   └── result2.json
└── systems └── systems
├── system1.json ├── system1.json
└── system2.json └── system2.json
``` ```
#### Files to provide #### Files to provide
Besides `README` and `LICENSE` file, you should provide at least three benchmarking related files. Besides `README` and `LICENSE` file, you should provide at least three benchmarking related files.
* `system.json`: This file lists all the system configurations in json format. * `system.json`: This file lists all the system configurations in json format.
You can get the system info automatically by executing `system_info.py` using below command. The file is under `superbench/tools` folder.
```
python system_info.py
```
* `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration) to learn the details. * `config.yaml`: This file is the config file to run benchmarks. Click [here](../getting-started/configuration) to learn the details.
* `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file. * `result.json`: This file contains the results run by SuperBench with system configuations listed in `system.json` file.
\ No newline at end of file
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