docs and readme updates

pmcurtin · pmcurtin · commit c3a05ec7b4fe · 2024-07-12T12:21:37.000-04:00
diff --git a/README.md b/README.md
@@ -27,9 +27,9 @@ def distributed_function():
 ```
 
 ```python
-import torchrunx
+import torchrunx as trx
 
-torchrunx.launch(
+trx.launch(
     func=distributed_function,
     func_kwargs={},
     hostnames=["node1", "node2"],  # or just: ["localhost"]
@@ -40,15 +40,15 @@ torchrunx.launch(
 ### In a SLURM allocation
 
 ```python
-torchrunx.launch(
+trx.launch(
     # ...
-    hostnames=torchrunx.slurm_hosts(),
-    workers_per_host=torchrunx.slurm_workers()
+    hostnames=trx.slurm_hosts(),
+    workers_per_host=trx.slurm_workers()
 )
 ```
 
 ## Compared to other tools
 
 ## Contributing
 
-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.
+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.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx==6.2.1
 furo
+myst-parser
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -0,0 +1,5 @@
+torchrunx API
+=============
+
+.. automodule:: torchrunx
+    :members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -17,6 +17,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    "myst_parser",
 ]
 
 autodoc_mock_imports = ['torch', 'fabric', 'cloudpickle', 'typing_extensions']
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,11 +1,13 @@
 Welcome to torchrunx's documentation!
 =====================================
 
+.. include:: ../../README.md
+   :parser: myst_parser.sphinx_
+
 Contents
 --------
 
 .. toctree::
    :maxdepth: 2
 
-   launcher
-   utils
+   api
diff --git a/docs/source/launcher.rst b/docs/source/launcher.rst
diff --git a/docs/source/old/launcher.rst b/docs/source/old/launcher.rst
@@ -0,0 +1,11 @@
+Launcher
+========
+
+.. .. currentmodule:: torchrunx
+
+.. The main API of **torchrunx** is :mod:`torchrunx.launch`, allowing users to run their distributed PyTorch functions easily accross an arbitrary cluster.
+
+.. .. autofunction:: launch
+
+.. automodule:: torchrunx
+    :members: launch
diff --git a/docs/source/old/utils.rst b/docs/source/old/utils.rst

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`sphinx==6.2.1`
`2`	`2`	`furo`
	`3`	`+myst-parser`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`'sphinx.ext.autodoc',`
`18`	`18`	`'sphinx.ext.autosummary',`
`19`	`19`	`'sphinx.ext.intersphinx',`
	`20`	`+ "myst_parser",`
`20`	`21`	`]`
`21`	`22`
`22`	`23`	`autodoc_mock_imports = ['torch', 'fabric', 'cloudpickle', 'typing_extensions']`