Skip to content

Commit 8e37c9b

Browse files
authored
make it more clear that ltt helps install *all* PyTorch distributions (#103)
1 parent a296a8a commit 8e37c9b

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@
55
[![Code coverage via codecov.io](https://codecov.io/gh/pmeier/light-the-torch/branch/main/graph/badge.svg)](https://codecov.io/gh/pmeier/light-the-torch)
66

77
`light-the-torch` is a small utility that wraps `pip` to ease the installation process
8-
for PyTorch distributions and third-party packages that depend on them. It auto-detects
9-
compatible CUDA versions from the local setup and installs the correct PyTorch binaries
10-
without user interference.
8+
for PyTorch distributions like `torch`, `torchvision`, `torchaudio`, and so on as well
9+
as third-party packages that depend on them. It auto-detects compatible CUDA versions
10+
from the local setup and installs the correct PyTorch binaries without user
11+
interference.
1112

1213
- [Why do I need it?](#why-do-i-need-it)
1314
- [How do I install it?](#how-do-i-install-it)
@@ -17,8 +18,8 @@ without user interference.
1718

1819
## Why do I need it?
1920

20-
PyTorch distributions are fully `pip install`'able, but PyPI, the default `pip` search
21-
index, has some limitations:
21+
PyTorch distributions like `torch`, `torchvision`, `torchaudio`, and so on are fully
22+
`pip install`'able, but PyPI, the default `pip` search index, has some limitations:
2223

2324
1. PyPI regularly only allows binaries up to a size of
2425
[approximately 60 MB](https://github.com/pypa/packaging-problems/issues/86). One can
@@ -34,17 +35,19 @@ index, has some limitations:
3435
hand your NVIDIA driver version simply doesn't support the CUDA version the binary
3536
was compiled with, you can't use any of the GPU features.
3637

37-
To overcome this, PyTorch also hosts _most_ binaries
38-
[on their own package indices](https://download.pytorch.org/whl). Some distributions are
39-
not compiled against a specific computation backend and thus hosting them on PyPI is
40-
sufficient since they work in every environment. To access PyTorch's package indices,
41-
you can still use `pip install`, but some
38+
To overcome this, PyTorch also hosts _most_[^1] binaries
39+
[on their own package indices](https://download.pytorch.org/whl). To access PyTorch's
40+
package indices, you can still use `pip install`, but some
4241
[additional options](https://pytorch.org/get-started/locally/) are needed:
4342

4443
```shell
4544
pip install torch --extra-index-url https://download.pytorch.org/whl/cu113
4645
```
4746

47+
[^1]:
48+
Some distributions are not compiled against a specific computation backend and thus
49+
hosting them on PyPI is sufficient since they work in every environment.
50+
4851
While this is certainly an improvement, it still has a few downsides:
4952

5053
1. You need to know what computation backend, e.g. CUDA 11.3 (`cu113`), is supported on
@@ -100,7 +103,7 @@ In fact, `ltt` is `pip` with a few added options:
100103
the computation backend you want to use:
101104

102105
```shell
103-
ltt install --pytorch-computation-backend=cu102 torch
106+
ltt install --pytorch-computation-backend=cu102 torch torchvision torchaudio
104107
```
105108

106109
Borrowing from the mutex packages that PyTorch provides for `conda` installations,
@@ -114,7 +117,7 @@ In fact, `ltt` is `pip` with a few added options:
114117
nightly, test, or LTS channels pass the `--pytorch-channel` option:
115118

116119
```shell
117-
ltt install --pytorch-channel=nightly torch
120+
ltt install --pytorch-channel=nightly torch torchvision torchaudio
118121
```
119122

120123
If `--pytorch-channel` is not passed, using `pip`'s builtin `--pre` option will

0 commit comments

Comments
 (0)