Skip to content

Commit fbd9f3f

Browse files
committed
README: update readme docs and requirement links
1 parent 1f1a50f commit fbd9f3f

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.md

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,30 @@ TorchX is a universal job launcher for PyTorch applications.
1212
TorchX is designed to have fast iteration time for training/research and support
1313
for E2E production ML pipelines when you're ready.
1414

15-
For the latest documentation, please refer to our [website](https://pytorch.org/torchx).
1615

1716
## Quickstart
1817

1918
See the [quickstart guide](https://pytorch.org/torchx/latest/quickstart.html).
2019

20+
## Documentation
21+
22+
* [Stable Documentation](https://pytorch.org/torchx/latest/)
23+
* [Nightly Documentation](https://pytorch.org/torchx/main/)
2124

2225
## Requirements
23-
TorchX SDK (torchx):
26+
27+
torchx:
28+
2429
* python3 (3.8+)
25-
* torch
30+
* [PyTorch](https://pytorch.org/get-started/locally/)
31+
* optional: [Docker](https://docs.docker.com/get-docker/) (needed for docker based schedulers)
2632

27-
TorchX Kubeflow Pipelines Support (torchx-kfp):
28-
* torchx
29-
* kfp
33+
Certain schedulers may require scheduler specific requirements. See installation
34+
for info.
3035

3136
## Installation
3237

33-
### Release
38+
### Stable
3439

3540
```bash
3641
# install torchx sdk and CLI -- minimum dependencies
@@ -44,13 +49,16 @@ pip install "torchx[kfp]"
4449

4550
# install torchx Kubernetes / Volcano support
4651
pip install "torchx[kubernetes]"
52+
53+
# install torchx Ray support
54+
pip install "torchx[ray]"
4755
```
4856

4957
### Nightly
5058

5159
```bash
5260
# install torchx sdk and CLI
53-
pip install torchx-nightly
61+
pip install torchx-nightly[dev]
5462
```
5563

5664
### Source
@@ -60,9 +68,15 @@ pip install torchx-nightly
6068
$ pip install -e git+https://github.com/pytorch/torchx.git#egg=torchx
6169

6270
# install extra dependencies
63-
$ pip install -e git+https://github.com/pytorch/torchx.git#egg=torchx[kubernetes]
71+
$ pip install -e git+https://github.com/pytorch/torchx.git#egg=torchx[dev]
6472
```
6573

74+
### Docker
75+
76+
TorchX provides a docker container for using as as part of a TorchX role.
77+
78+
See: https://github.com/pytorch/torchx/pkgs/container/torchx
79+
6680
## Contributing
6781

6882
We welcome PRs! See the [CONTRIBUTING](CONTRIBUTING.md) file.

0 commit comments

Comments
 (0)