Skip to content

Commit c3a05ec

Browse files
committed
docs and readme updates
1 parent fac6f07 commit c3a05ec

File tree

8 files changed

+28
-16
lines changed

8 files changed

+28
-16
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ def distributed_function():
2727
```
2828

2929
```python
30-
import torchrunx
30+
import torchrunx as trx
3131

32-
torchrunx.launch(
32+
trx.launch(
3333
func=distributed_function,
3434
func_kwargs={},
3535
hostnames=["node1", "node2"], # or just: ["localhost"]
@@ -40,15 +40,15 @@ torchrunx.launch(
4040
### In a SLURM allocation
4141

4242
```python
43-
torchrunx.launch(
43+
trx.launch(
4444
# ...
45-
hostnames=torchrunx.slurm_hosts(),
46-
workers_per_host=torchrunx.slurm_workers()
45+
hostnames=trx.slurm_hosts(),
46+
workers_per_host=trx.slurm_workers()
4747
)
4848
```
4949

5050
## Compared to other tools
5151

5252
## Contributing
5353

54-
We use the [`pixi`](https://pixi.sh) package manager. Simply [install `pixi`](latest/#installation) and run `pixi shell` in this repository. We use `ruff` for linting and formatting, `pyright` for static type checking, and `pytest` for testing. We build for `PyPI` and `conda-forge`. Our release pipeline is powered by Github Actions.
54+
We use the [`pixi`](https://pixi.sh) package manager. Simply [install `pixi`](https://pixi.sh/latest/#installation) and run `pixi shell` in this repository. We use `ruff` for linting and formatting, `pyright` for static type checking, and `pytest` for testing. We build for `PyPI` and `conda-forge`. Our release pipeline is powered by Github Actions.

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
sphinx==6.2.1
22
furo
3+
myst-parser

docs/source/api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
torchrunx API
2+
=============
3+
4+
.. automodule:: torchrunx
5+
:members:

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
'sphinx.ext.autodoc',
1818
'sphinx.ext.autosummary',
1919
'sphinx.ext.intersphinx',
20+
"myst_parser",
2021
]
2122

2223
autodoc_mock_imports = ['torch', 'fabric', 'cloudpickle', 'typing_extensions']

docs/source/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
Welcome to torchrunx's documentation!
22
=====================================
33

4+
.. include:: ../../README.md
5+
:parser: myst_parser.sphinx_
6+
47
Contents
58
--------
69

710
.. toctree::
811
:maxdepth: 2
912

10-
launcher
11-
utils
13+
api

docs/source/launcher.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/source/old/launcher.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Launcher
2+
========
3+
4+
.. .. currentmodule:: torchrunx
5+
6+
.. The main API of **torchrunx** is :mod:`torchrunx.launch`, allowing users to run their distributed PyTorch functions easily accross an arbitrary cluster.
7+
8+
.. .. autofunction:: launch
9+
10+
.. automodule:: torchrunx
11+
:members: launch
File renamed without changes.

0 commit comments

Comments
 (0)