Skip to content

Commit c295819

Browse files
committed
moved docs artifacts again
1 parent 120e1e8 commit c295819

File tree

11 files changed

+52
-28
lines changed

11 files changed

+52
-28
lines changed

docs/source/artifacts/cli_help.txt

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
usage: -c [-h] [OPTIONS]
2+
3+
For configuring the function launch environment.
4+
5+
╭─ options ──────────────────────────────────────────────────────────────────╮
6+
│ -h, --help │
7+
│ show this help message and exit │
8+
│ --hostnames {[STR [STR ...]]}|{auto,slurm} │
9+
│ Nodes on which to launch the function. By default, infer from │
10+
│ localhost or SLURM. (default: auto) │
11+
│ --workers-per-host INT|{[INT [INT ...]]}|{auto} │
12+
│ Number of processes to run per node. By default, number of GPUs per │
13+
│ host. (default: auto) │
14+
│ --ssh-config-file {None}|STR|PATHLIKE │
15+
│ For connecting to nodes. By default, ``"~/.ssh/config"`` or │
16+
│ ``"/etc/ssh/ssh_config"``. (default: None) │
17+
│ --backend {None,nccl,gloo,mpi,ucc,auto} │
18+
│ `Backend │
19+
│ <https://pytorch.org/docs/stable/distributed.html#torch.distributed.B… │
20+
│ for worker process group or ``None``. By default, NCCL if GPUs │
21+
│ detected, else GLOO. (default: auto) │
22+
│ --timeout INT │
23+
│ Worker process group timeout (seconds). (default: 600) │
24+
│ --copy-env-vars [STR [STR ...]] │
25+
│ Environment variables to copy from the launcher process to workers. │
26+
│ Supports Unix pattern matching syntax. (default: PATH LD_LIBRARY │
27+
│ LIBRARY_PATH 'PYTHON*' 'CUDA*' 'TORCH*' 'PYTORCH*' 'NCCL*') │
28+
│ --extra-env-vars {None}|{[STR STR [STR STR ...]]} │
29+
│ Additional environment variables to load onto workers. (default: None) │
30+
│ --env-file {None}|STR|PATHLIKE │
31+
│ Path to a ``.env`` file, containing environment variables to load onto │
32+
│ workers. (default: None) │
33+
│ --propagate-exceptions, --no-propagate-exceptions │
34+
│ Whether to raise specific worker exceptions or │
35+
│ :exc:`torchrunx.WorkerFailedError`. (default: True) │
36+
╰────────────────────────────────────────────────────────────────────────────╯

docs/source/examples/accelerate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here's an example script that uses `torchrunx` with [Accelerate](https://hugging
88
<summary><p style="display: inline-block;"><code class="docutils literal notranslate"><span class="pre">python accelerate_train.py --help</span></code></p> (expand)</summary>
99

1010
```{eval-rst}
11-
.. literalinclude:: ./artifacts/accelerate_help.txt
11+
.. literalinclude:: ../artifacts/accelerate_help.txt
1212
```
1313
</details>
1414

docs/source/examples/deepspeed.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here's an example script that uses `torchrunx` with [DeepSpeed](https://www.deep
88
<summary><p style="display: inline-block;"><code class="docutils literal notranslate"><span class="pre">python deepspeed_train.py --help</span></code></p> (expand)</summary>
99

1010
```{eval-rst}
11-
.. literalinclude:: ./artifacts/deepspeed_help.txt
11+
.. literalinclude:: ../artifacts/deepspeed_help.txt
1212
```
1313
</details>
1414

docs/source/examples/lightning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here's an example script that uses `torchrunx` with [PyTorch Lightning](https://
88
<summary><p style="display: inline-block;"><code class="docutils literal notranslate"><span class="pre">python lightning_train.py --help</span></code></p> (expand)</summary>
99

1010
```{eval-rst}
11-
.. literalinclude:: ./artifacts/lightning_help.txt
11+
.. literalinclude:: ../artifacts/lightning_help.txt
1212
```
1313
</details>
1414

docs/source/examples/transformers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Here's an example script that uses `torchrunx` with [`transformers.Trainer`](htt
88
<summary><p style="display: inline-block;"><code class="docutils literal notranslate"><span class="pre">python transformers_train.py --help</span></code></p> (expand)</summary>
99

1010
```{eval-rst}
11-
.. literalinclude:: ./artifacts/transformers_help.txt
11+
.. literalinclude:: ../artifacts/transformers_help.txt
1212
```
1313
</details>
1414

docs/source/features/cli.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CLI Integration
22

3-
We can automatically populate {mod}`torchrunx.Launcher` arguments using most CLI tools (those that generate interfaces from Data Classes, e.g. [tyro](https://brentyi.github.io/tyro/)):
3+
We can automatically populate {mod}`torchrunx.Launcher` arguments using most CLI tools, e.g. [`tyro`](https://brentyi.github.io/tyro/) or any that [generate interfaces from dataclasses](https://brentyi.github.io/tyro/goals_and_alternatives).
44

55
```python
66
import torchrunx
@@ -16,23 +16,7 @@ if __name__ == "__main__":
1616

1717
`python ... --help` then results in:
1818

19-
```bash
20-
╭─ options ─────────────────────────────────────────────╮
21-
│ -h, --help show this help message and exit
22-
│ --hostnames {[STR [STR ...]]}|{auto,slurm} │
23-
│ (default: auto) │
24-
│ --workers-per-host INT|{[INT [INT ...]]}|{auto,slurm} │
25-
│ (default: auto) │
26-
│ --ssh-config-file {None}|STR|PATH │
27-
│ (default: None) │
28-
│ --backend {None,nccl,gloo,mpi,ucc,auto} │
29-
│ (default: auto) │
30-
│ --timeout INT (default: 600) │
31-
│ --default-env-vars [STR [STR ...]] │
32-
│ (default: PATH LD_LIBRARY ...) │
33-
│ --extra-env-vars [STR [STR ...]] │
34-
│ (default: ) │
35-
│ --env-file {None}|STR|PATH │
36-
│ (default: None) │
37-
╰───────────────────────────────────────────────────────╯
19+
```{eval-rst}
20+
.. literalinclude:: ../artifacts/cli_help.txt
21+
:lines: 3-
3822
```

0 commit comments

Comments
 (0)