Skip to content

Commit c8d9b1d

Browse files
authored
cleanup before 0.4.0 release (#83)
1 parent e606268 commit c8d9b1d

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ index, has some limitations:
3535
was compiled with, you can't use any of the GPU features.
3636

3737
To overcome this, PyTorch also hosts _all_ binaries
38-
[themselves](https://download.pytorch.org/whl/torch_stable.html). To access them, you
39-
can still use `pip install` them, but some
38+
[themselves](https://download.pytorch.org/whl). To access them, you can still use
39+
`pip install` them, but some
4040
[additional options](https://pytorch.org/get-started/locally/) are needed:
4141

4242
```shell
@@ -49,12 +49,18 @@ While this is certainly an improvement, it still has a few downsides:
4949
your local machine. This can be quite challenging for new users and at least tedious
5050
for more experienced ones.
5151
2. Besides the stable binaries, PyTorch also offers nightly, test, and long-time support
52-
(LTS) ones. To install them, you need a different `--extra-index-url` for each. For
53-
the nightly and test channel you also need to supply the `--pre` option.
54-
3. If you want to install any package hosted on PyPI that depends on PyTorch, you always
55-
also need to specify all needed PyTorch distributions in the `pip install` command.
56-
Otherwise, the `--extra-index-url` flag is ignored and the PyTorch distributions
57-
hosted on PyPI will be installed.
52+
(LTS) ones. To install them, you need a different `--extra-index-url` for each.
53+
3. For the nightly and test channel you also need to supply the `--pre` option. Failing
54+
to do so, will pull the stable binary from PyPI even if the rest of the installation
55+
command is correct.
56+
4. When installing from the LTS channel, you need to pin the exact version, since `pip`
57+
prefers newer releases from PyPI. Thus, it is not possible to automatically get the
58+
latest LTS release.
59+
60+
In case you only want to install PyTorch distributions, point 3. and 4. above can be
61+
resolved by using `--index-url` instead and completely disabling installing from PyPI.
62+
But of course this means it is not possible to install any package not hosted by
63+
PyTorch, but that depends on it.
5864

5965
If any of these points don't sound appealing to you, and you just want to have the same
6066
user experience as `pip install` for PyTorch distributions, `light-the-torch` was made
@@ -65,15 +71,15 @@ for you.
6571
Installing `light-the-torch` is as easy as
6672

6773
```shell
68-
pip install --pre light-the-torch
74+
pip install light-the-torch
6975
```
7076

7177
Since it depends on `pip` and it might be upgraded during installation,
7278
[Windows users](https://pip.pypa.io/en/stable/installation/#upgrading-pip) should
7379
install it with
7480

7581
```shell
76-
py -m pip install --pre light-the-torch
82+
py -m pip install light-the-torch
7783
```
7884

7985
## How do I use it?

setup.cfg

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ author = Philip Meier
1010
author_email = [email protected]
1111
license = BSD-3-Clause
1212
classifiers =
13-
Development Status :: 3 - Alpha
13+
Development Status :: 4 - Beta
1414
Environment :: Console
1515
Environment :: GPU :: NVIDIA CUDA
1616
Intended Audience :: Developers
@@ -34,6 +34,8 @@ install_requires =
3434

3535
[options.packages.find]
3636
exclude =
37+
.github*
38+
scripts*
3739
tests*
3840

3941
[options.entry_points]

0 commit comments

Comments
 (0)