Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs - fix typos #628

Merged
merged 5 commits into from
Jul 25, 2024
Merged

Docs - fix typos #628

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
16037e2
fix typos
omahs Jun 16, 2024
98a970e
fix typos
omahs Jun 16, 2024
3cdbe32
Merge branch 'main' into patch-1
yukirora Jul 24, 2024
2732e85
Merge branch 'main' into patch-1
yukirora Jul 25, 2024
41fdbba
Merge branch 'main' into patch-1
yukirora Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ sb deploy [--docker-image]
| `--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-password` | `None` | Host password or key passphrase if needed. |
| `--host-username` | `None` | Host username if needed. |
| `--no-image-pull` | `False` | Skip pull and use local Docker image. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
Expand Down Expand Up @@ -373,7 +373,7 @@ sb run [--config-file]
| `--get-info` | `False` | Collect system info. |
| `--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-password` | `None` | Host password or key passphrase if needed. |
| `--host-username` | `None` | Host username if needed. |
| `--no-docker` | `False` | Run on host directly without Docker. |
| `--output-dir` | `None` | Path to output directory, outputs/{datetime} will be used if not specified. |
Expand Down
14 changes: 7 additions & 7 deletions docs/superbench-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Enable current benchmark or not, can be overwritten by [`superbench.enable`](#su

### `timeout`

Set the timeout value in seconds, the benchmarking will stop early if timeout is triggerred.
Set the timeout value in seconds, the benchmarking will stop early if timeout is triggered.

* default value: none

Expand Down Expand Up @@ -336,16 +336,16 @@ A list of models to run, only supported in model-benchmark.

Parameters for benchmark to use, varying for different benchmarks.

There have four common parameters for all benchmarks:
* run_count: how many times do user want to run this benchmark, default value is 1.
There are four common parameters for all benchmarks:
* run_count: how many times does user want to run this benchmark, default value is 1.
* duration: the elapsed time of benchmark in seconds. It can work for all model-benchmark. But for micro-benchmark, benchmark authors should consume it by themselves.
* log_raw_data: log raw data into file instead of saving it into result object, default value is `False`. Benchmarks who have large raw output may want to set it as `True`, such as `nccl-bw`/`rccl-bw`.
* log_flushing: real-time log flushing, default value is `False`.

For Model-Benchmark, there have some parameters that can control the elapsed time.
For Model-Benchmark, there are some parameters that can control the elapsed time.
* duration: the elapsed time of benchmark in seconds.
* num_warmup: the number of warmup step, should be positive integer.
* num_steps: the number of test step.
* num_warmup: the number of warmup steps, should be positive integer.
* num_steps: the number of test steps.

If `duration > 0` and `num_steps > 0`, then benchmark will take the least as the elapsed time. Otherwise only one of them will take effect.

Expand Down Expand Up @@ -429,7 +429,7 @@ while `proc_num: 8, node_num: null` will run 32-GPU distributed training on all

Command prefix to use in the mode, in Python formatted string.

Available variables in formatted string includes:
Available variables in formatted string include:
+ `proc_rank`
+ `proc_num`

Expand Down
Loading