light-the-torch 0.4.0rc5

Install PyTorch distributions with computation backend auto-detection

light-the-torch

light-the-torch is a small utility that wraps pip to ease the installation process for PyTorch distributions and third-party packages that depend on them. It auto-detects compatible CUDA versions from the local setup and installs the correct PyTorch binaries without user interference.

• Why do I need it?
• How do I install it?
• How do I use it?
• How does it work?

Why do I need it?

PyTorch distributions are fully pip install'able, but PyPI, the default pip search index, has some limitations:

1. PyPI regularly only allows binaries up to a size of approximately 60 MB. One can request a file size limit increase (and the PyTorch team probably does that for every release), but it is still not enough: although PyTorch has pre-built binaries for Windows with CUDA, they cannot be installed through PyPI due to their size.
2. PyTorch uses local version specifiers to indicate for which computation backend the binary was compiled, for example torch==1.11.0+cpu. Unfortunately, local specifiers are not allowed on PyPI. Thus, only the binaries compiled with one CUDA version are uploaded without an indication of the CUDA version. If you do not have a CUDA capable GPU, downloading this is only a waste of bandwidth and disk capacity. If on the other hand your NVIDIA driver version simply doesn't support the CUDA version the binary was compiled with, you can't use any of the GPU features.

To overcome this, PyTorch also hosts all binaries themselves. To access them, you still can pip install them, but have to use some additional options:

pip install torch==1.11.0+cu113 -f https://download.pytorch.org/whl/cu113/torch_stable.html

While this is certainly an improvement, it also has it downside: in addition to the computation backend, the version has to be specified exactly. Without knowing what the latest release is, it is impossible to install it as simple as pip install torch normally would.

At this point you might justifiably ask: why don't you just use conda as PyTorch recommends?

conda install pytorch torchvision torchaudio cudatoolkit=11.3 -c pytorch

This should cover all cases, right? Well, no. Let's first have a look at this from a user perspective: You still have to manually specify the computation backend. Of course, you can drop the =11.3 above, but this would give you the latest cudatoolkit, which might not be compatible with the local setup. Plus, if you don't have access to a GPU, you need to manually swap cudatoolkit for cpuonly.

Now imagine you are the author of a library that depends on PyTorch and targets a broader audience than just experts: the scenario above can be bad, because new users need to jump through additional hoops. In addition, new users might not be familiar with conda, whereas almost every Python tutorial features a short introduction to pip.

If you go conda nonetheless, you'll now have to decide how you want to publish your library. The obvious choice would be to publish on the conda-forge channel to benefit from all their infrastructure. Unfortunately, this is not as easy as it sounds: conda-forge does not allow your package to depend on packages hosted in different channels. PyTorch publishes the binaries to their own channels (-c pytorch) and so you cannot depend on the official binaries. There is a community package, but it only publishes CPU binaries. Additionally, there are a few binaries with CUDA support, but the range is limited with no support for Windows and only selected CUDA versions for Linux. Thus, if you don't want to limit you options, you would have to setup and maintain your own channel.

If any of the stuff doesn't sound appealing to you and you just want to have the same user experience as pip install for PyTorch distributions, light-the-torch was made for you.

How do I install it?

Installing light-the-torch is as easy as

pip install light-the-torch

Since it depends on pip and it might be upgraded during installation, Windows users should install it with

python -m pip install light-the-torch

How do I use it?

After light-the-torch is installed you can use its CLI interface ltt as drop-in replacement for pip:

ltt install torch

In fact, ltt is pip with a few added options:

• By default, ltt uses the local NVIDIA driver version to select the correct binary for you. You can pass the --pytorch-computation-backend option to manually specify the computation backend you want to use:

  ltt install --pytorch-computation-backend=cu102 torch
  

• By default, ltt installs stable PyTorch binaries. In addition, PyTorch provides nightly, test, and long-time support (LTS) binaries. You can switch the channel you want to install from with the --pytorch-channel option:

  ltt install --pytorch-channel=nightly torch
  

  If the channel option is not passed, using pip's builtin --pre option will install PyTorch test binaries.

Of course you are not limited to install only PyTorch distributions. Everything shown above also works if you install packages that depend on PyTorch:

ltt install --pytorch-computation-backend=cpu --pytorch-channel=nightly pystiche

How does it work?

The authors of pip do not condone the use of pip internals as they might break without warning. As a results of this, pip has no capability for plugins to hook into specific tasks.

light-the-torch works by monkey-patching pip internals at runtime:

• While searching for a download link for a PyTorch distribution, light-the-torch replaces the default search index with an official PyTorch download link. This is equivalent to calling pip install with the -f option only for PyTorch distributions.
• While evaluating possible PyTorch installation candidates, light-the-torch culls binaries not compatible with the available hardware.