Skip to content

GitLab

Unverified Commit 3d0fde12 authored by Yifan Xiong's avatar Yifan Xiong Committed by GitHub
Browse files

Docs - Refine document structure (#225) 

__Major Revisions__

* Refine document structure for user tutorial.

__Minor Revisions__

* Add AMD part in installation.
* Change default config file to latest link.
parent 5283bdeb
Hide whitespace changes
Inline Side-by-side
Showing with 85 additions and 159 deletions
docs/cli.md
View file @ 3d0fde12
......@@ -41,23 +41,23 @@ sb deploy [--docker-image]
#### Optional arguments
| Name | Default | Description |
| --- | --- | --- |
| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./tutorial/container-images) listed all images. |
| `--docker-password` | `None` | Docker registry password if authentication is needed. |
| `--docker-username` | `None` | Docker registry username if authentication is needed. |
| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
| `--host-list` `-l` | `None` | Comma separated host list. |
| `--host-password` | `None` | Host password or key passphase if needed. |
| `--host-username` | `None` | Host username if needed. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
| `--private-key` | `None` | Path to private key if needed. |
| Name | Default | Description |
|-----------------------|-------------------------|-------------------------------------------------------------------------------|
| `--docker-image` `-i` | `superbench/superbench` | Docker image URI, [here](./user-tutorial/container-images) listed all images. |
| `--docker-password` | `None` | Docker registry password if authentication is needed. |
| `--docker-username` | `None` | Docker registry username if authentication is needed. |
| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
| `--host-list` `-l` | `None` | Comma separated host list. |
| `--host-password` | `None` | Host password or key passphase if needed. |
| `--host-username` | `None` | Host username if needed. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
| `--private-key` | `None` | Path to private key if needed. |
#### Global arguments
| Name | Default | Description |
| --- | --- | --- |
| `--help` `-h` | N/A | Show help message. |
| Name | Default | Description |
|---------------|---------|--------------------|
| `--help` `-h` | N/A | Show help message. |
#### Examples
......@@ -82,17 +82,17 @@ sb exec [--config-file]
#### Optional arguments
| Name | Default | Description |
| --- | --- | --- |
| `--config-file` `-c` | `None` | Path to SuperBench config file. |
| `--config-override` `-C` | `None` | Extra arguments to override config_file. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
| Name | Default | Description |
|--------------------------|---------|-----------------------------------------------------------------------------|
| `--config-file` `-c` | `None` | Path to SuperBench config file. |
| `--config-override` `-C` | `None` | Extra arguments to override config_file. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
#### Global arguments
| Name | Default | Description |
| --- | --- | --- |
| `--help` `-h` | N/A | Show help message. |
| Name | Default | Description |
|---------------|---------|--------------------|
| `--help` `-h` | N/A | Show help message. |
#### Examples
......@@ -120,25 +120,25 @@ sb run [--config-file]
#### Optional arguments
| Name | Default | Description |
| --- | --- | --- |
| `--config-file` `-c` | `None` | Path to SuperBench config file. |
| `--config-override` `-C` | `None` | Extra arguments to override config_file. |
| `--docker-image` `-i` | `superbench/superbench` | Docker image URI. |
| `--docker-password` | `None` | Docker registry password if authentication is needed. |
| `--docker-username` | `None` | Docker registry username if authentication is needed. |
| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
| `--host-list` `-l` | `None` | Comma separated host list. |
| `--host-password` | `None` | Host password or key passphase if needed. |
| `--host-username` | `None` | Host username if needed. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
| `--private-key` | `None` | Path to private key if needed. |
| Name | Default | Description |
|--------------------------|-------------------------|-----------------------------------------------------------------------------|
| `--config-file` `-c` | `None` | Path to SuperBench config file. |
| `--config-override` `-C` | `None` | Extra arguments to override config_file. |
| `--docker-image` `-i` | `superbench/superbench` | Docker image URI. |
| `--docker-password` | `None` | Docker registry password if authentication is needed. |
| `--docker-username` | `None` | Docker registry username if authentication is needed. |
| `--host-file` `-f` | `None` | Path to Ansible inventory host file. |
| `--host-list` `-l` | `None` | Comma separated host list. |
| `--host-password` | `None` | Host password or key passphase if needed. |
| `--host-username` | `None` | Host username if needed. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
| `--private-key` | `None` | Path to private key if needed. |
#### Global arguments
| Name | Default | Description |
| --- | --- | --- |
| `--help` `-h` | N/A | Show help message. |
| Name | Default | Description |
|---------------|---------|--------------------|
| `--help` `-h` | N/A | Show help message. |
#### Examples
......@@ -162,9 +162,9 @@ sb version
#### Global arguments
| Name | Default | Description |
| --- | --- | --- |
| `--help` `-h` | N/A | Show help message. |
| Name | Default | Description |
|---------------|---------|--------------------|
| `--help` `-h` | N/A | Show help message. |
#### Examples
......
docs/developer-guides/development.md
View file @ 3d0fde12
......@@ -11,7 +11,7 @@ You can also develop online with [GitHub Codespaces](https://github.com/codespac
## Check Environment
Follow [System Requirements](../getting-started/installation.md).
Follow [System Requirements](../getting-started/installation).
## Set Up
......
docs/getting-started/configuration.md
View file @ 3d0fde12
......@@ -9,106 +9,7 @@ id: configuration
SuperBench uses a [YAML](https://yaml.org/spec/1.2/spec.html) config file to configure the details of benchmarkings,
including which benchmark to run, which distributing mode to choose, which parameter to use, etc.
Here's what default config file looks like.
```yaml title="superbench/config/default.yaml"
# SuperBench Config
superbench:
enable: null
var:
default_local_mode: &default_local_mode
enable: true
modes:
- name: local
proc_num: 8
prefix: CUDA_VISIBLE_DEVICES={proc_rank}
parallel: yes
default_pytorch_mode: &default_pytorch_mode
enable: true
modes:
- name: torch.distributed
proc_num: 8
node_num: 1
frameworks:
- pytorch
common_model_config: &common_model_config
duration: 0
num_warmup: 16
num_steps: 128
precision:
- float32
- float16
model_action:
- train
benchmarks:
kernel-launch:
<<: *default_local_mode
gemm-flops:
<<: *default_local_mode
cudnn-function:
<<: *default_local_mode
cublas-function:
<<: *default_local_mode
matmul:
<<: *default_local_mode
frameworks:
- pytorch
sharding-matmul:
<<: *default_pytorch_mode
computation-communication-overlap:
<<: *default_pytorch_mode
gpt_models:
<<: *default_pytorch_mode
models:
- gpt2-small
- gpt2-large
parameters:
<<: *common_model_config
batch_size: 4
bert_models:
<<: *default_pytorch_mode
models:
- bert-base
- bert-large
parameters:
<<: *common_model_config
batch_size: 8
lstm_models:
<<: *default_pytorch_mode
models:
- lstm
parameters:
<<: *common_model_config
batch_size: 128
resnet_models:
<<: *default_pytorch_mode
models:
- resnet50
- resnet101
- resnet152
parameters:
<<: *common_model_config
batch_size: 128
densenet_models:
<<: *default_pytorch_mode
models:
- densenet169
- densenet201
parameters:
<<: *common_model_config
batch_size: 128
vgg_models:
<<: *default_pytorch_mode
models:
- vgg11
- vgg13
- vgg16
- vgg19
parameters:
<<: *common_model_config
batch_size: 128
```
Here's the [default config file](https://github.com/microsoft/superbenchmark/blob/main/superbench/config/default.yaml).
By default, all benchmarks in default configuration will be run if you don't specify customized configuration.
If you want to have a quick try, you can modify this config a little bit. For example, only run resnet101 model.
......
docs/getting-started/installation.md → docs/getting-started/installation.mdx
View file @ 3d0fde12
......@@ -2,6 +2,10 @@
id: installation
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Installation
SuperBench is used to run validations for AI infrastructure,
......@@ -80,10 +84,29 @@ Here're the system requirements for all managed GPU nodes.
### Requirements
<Tabs
groupId='gpu-vendor'
defaultValue='nvidia'
values={[
{label: 'NVIDIA GPU', value: 'nvidia'},
{label: 'AMD GPU', value: 'amd'},
]
}>
<TabItem value='nvidia'>
* Latest version of Linux, you're highly encouraged to use Ubuntu 18.04 or later.
* Compatible GPU drivers should be install correctly.
* For NVIDIA GPUs, driver version can be checked by running `nvidia-smi`.
* Compatible GPU drivers should be installed correctly. Driver version can be checked by running `nvidia-smi`.
* [Docker CE](https://docs.docker.com/engine/install/) version 19.03 or later (which can be checked by running `docker --version`).
* GPU support in Docker.
* For NVIDIA GPUs, install
* NVIDIA GPU support in Docker, install
[nvidia-container-toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html#setting-up-nvidia-container-toolkit).
</TabItem>
<TabItem value='amd'>
* Latest version of Linux, you're highly encouraged to use Ubuntu 18.04 or later.
* Compatible GPU drivers should be installed correctly, and group permission should be set to access GPU resources.
You should be able to run `rocm-smi` and `rocminfo` directly to check GPU usage and information.
* [Docker CE](https://docs.docker.com/engine/install/) version 19.03 or later (which can be checked by running `docker --version`).
</TabItem>
</Tabs>
docs/design-docs/system-config.md → docs/user-tutorial/system-config.md
View file @ 3d0fde12
......@@ -2,7 +2,8 @@
id: system-config
---
# System Configuration Information
# System Config Info
- [System](#system)
- [Memory](#memory)
- [CPU](#cpu)
......@@ -626,4 +627,4 @@ id: system-config
<td>00:00.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Starship/Matisse Root Complex...</td>
</tr>
</tbody>
</table>
\ No newline at end of file
</table>
website/sidebars.js
View file @ 3d0fde12
......@@ -17,18 +17,20 @@ module.exports = {
},
{
type: 'category',
label: 'Tutorial',
label: 'User Tutorial',
collapsed: false,
items: [
'tutorial/container-images',
],
},
{
type: 'category',
label: 'Benchmarks',
items: [
'benchmarks/micro-benchmarks',
'benchmarks/model-benchmarks',
{
type: 'category',
label: 'Benchmarks',
collapsed: false,
items: [
'user-tutorial/benchmarks/micro-benchmarks',
'user-tutorial/benchmarks/model-benchmarks',
],
},
'user-tutorial/system-config',
'user-tutorial/container-images',
],
},
{
......@@ -46,7 +48,6 @@ module.exports = {
items: [
'design-docs/overview',
'design-docs/benchmarks',
'design-docs/system-config'
],
},
],
......
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