From ee895b969fa04f8e5cbcb14c3e4c2799ba798b4b Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Mon, 18 Nov 2024 14:20:23 -0500 Subject: [PATCH] Add documentation for using uv with PyTorch --- docs/guides/index.md | 1 + docs/guides/integration/index.md | 1 + docs/guides/integration/pytorch.md | 248 ++++++++++++++++++++++------- mkdocs.template.yml | 1 + 4 files changed, 193 insertions(+), 58 deletions(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 2becfa315b8d..85a20b26ed75 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -15,6 +15,7 @@ Learn how to integrate uv with other software: - [Using in GitHub Actions](./integration/github.md) - [Using in GitLab CI/CD](./integration/gitlab.md) - [Using with alternative package indexes](./integration/alternative-indexes.md) +- [Installing PyTorch](./integration/pytorch.md) - [Building a FastAPI application](./integration/fastapi.md) Or, explore the [concept documentation](../concepts/index.md) for comprehensive breakdown of each diff --git a/docs/guides/integration/index.md b/docs/guides/integration/index.md index 8a3da368ecb6..78b4b5c21947 100644 --- a/docs/guides/integration/index.md +++ b/docs/guides/integration/index.md @@ -8,4 +8,5 @@ Learn how to integrate uv with other software: - [Using in GitHub Actions](./github.md) - [Using in GitLab CI/CD](./gitlab.md) - [Using with alternative package indexes](./alternative-indexes.md) +- [Installing PyTorch](./pytorch.md) - [Building a FastAPI application](./fastapi.md) diff --git a/docs/guides/integration/pytorch.md b/docs/guides/integration/pytorch.md index 1dcc78ffa000..42ae56ea9328 100644 --- a/docs/guides/integration/pytorch.md +++ b/docs/guides/integration/pytorch.md @@ -1,47 +1,60 @@ -# Installing PyTorch with uv +# Using uv with PyTorch -[PyTorch](https://pytorch.org/) is a popular open-source deep learning framework that has -first-class support for acceleration via GPUs. Installation, however, can be complex, as you won't -find all the wheels for PyTorch on PyPI and you have to manage this through external indexes. This -guide aims to help you set up a `pyproject.toml` file using `uv` -[indexes features](../../configuration/indexes.md). +The [PyTorch](https://pytorch.org/) ecosystem is a popular choice for deep learning research and +development. You can use uv to manage PyTorch projects and PyTorch dependencies across different +Python versions and environments, even controlling for the choice of accelerator (e.g., CPU-only vs. +CUDA). -!!! info "Available PyTorch indexes" +## Installing PyTorch - By default, from PyPI you will download: - * CPU-only wheels on Windows and macOS. - * CUDA (i.e. GPU) on Linux. At the time of writing, for PyTorch stable version (2.5.0) this defaults to CUDA 12.4. On older versions, this might be different. +From a packaging perspective, PyTorch has a few uncommon characteristics: - If you want to install CPU-only PyTorch wheels on Linux, or a PyTorch version that supports a different CUDA version, you need to resort to external indexes: +- Many PyTorch wheels are hosted on a dedicated index, rather than the Python Package Index (PyPI). + As such, installing PyTorch typically often configuring a project to use the PyTorch index. +- PyTorch includes distinct builds for each accelerator (e.g., CPU-only, CUDA). Since there's no + standardized mechanism for specifying these accelerators when publishing or installing, PyTorch + encodes them in the local version specifier. As such, PyTorch versions will often look like + `2.5.1+cpu`, `2.5.1+cu121`, etc. +- Builds for different accelerators are published to different indexes. For example, the `+cpu` + builds are published on https://download.pytorch.org/whl/cpu, while the `+cu121` builds are + published on https://download.pytorch.org/whl/cu121. - * https://download.pytorch.org/whl/cu118 - * https://download.pytorch.org/whl/cu121 - * https://download.pytorch.org/whl/cu124 - * https://download.pytorch.org/whl/cpu - * https://download.pytorch.org/whl/rocm6.2 (AMD GPUs, only available on Linux) +As such, the necessary packaging configuration will vary depending on both the platforms you need to +support and the accelerators you want to enable. -The [PyTorch website](https://pytorch.org/get-started/locally/) offers a simple interface to -determine what `pip` command you should run to install PyTorch. This guide should help you do the -same with `uv`. If the following instructions fail, you might want to check the link for any -difference, and open an issue to report the discrepancy. In this case, or if you run into any other -issue, please refer to [Getting Help](../../getting-started/help.md). +To start, consider the following (default) configuration, which would be generated by running +`uv init --python 3.12` followed by `uv add torch torchvision`. -## Initialise a project +In this case, PyTorch would be installed from PyPI, which hosts CPU-only wheels for Windows and +macOS, and GPU-accelerated wheels on Linux (targeting CUDA 12.4): -Create a new project with `uv init`: - -```sh -uv init +```toml +[project] +name = "project" +version = "0.1.0" +requires-python = ">=3.12" +dependencies = [ + "torch>=2.5.1", + "torchvision>=0.20.1", +] ``` !!! tip "Supported Python versions" - Make sure to use a Python version that is supported by PyTorch. You can find the compatibility matrix [here](https://github.com/pytorch/pytorch/blob/main/RELEASE.md#release-compatibility-matrix). + At time of writing, PyTorch does not yet publish wheels for Python 3.13; as such projects with + `requires-python = ">=3.13"` may fail to resolve. See the + [compatibility matrix](https://github.com/pytorch/pytorch/blob/main/RELEASE.md#release-compatibility-matrix). + +This is a valid configuration for projects that want to use CPU builds on Windows and macOS, and +CUDA-enabled builds on Linux. However, if you need to support different platforms or accelerators, +you'll need to configure the project accordingly. -## Add PyTorch indexes +## Using a PyTorch index -Open the `pyproject.toml` file, and create a custom index matching the channel you want to use (CPU, -NVIDIA or AMD), to instruct `uv` where to find the PyTorch wheels. +In some cases, you may want to use a specific PyTorch variant across all platforms. For example, you +may want to use the CPU-only builds on Linux too. + +In such cases, the first step is to add the relevant PyTorch index to your `pyproject.toml`: === "CPU-only" @@ -88,20 +101,16 @@ NVIDIA or AMD), to instruct `uv` where to find the PyTorch wheels. explicit = true ``` -Note the `explicit` option: this prevents packages from being installed from that index unless -explicitly pinned to it (see the step below). This means that only PyTorch will be installed from -this index, while all other packages will be looked up on PyPI (the default index). - -## Pin PyTorch to the custom index +We recommend the use of `explicit = true` to ensure that the index is _only_ used for `torch`, +`torchvision`, and other PyTorch-related packages, as opposed to generic dependencies like `jinja2`, +which should continue to be sourced from the default index (PyPI). -Now you need to pin specific PyTorch versions to the appropriate indexes. The `tool.uv.sources` -table in the `pyproject.toml` is a mapping that matches a package to a list of indexes inside of -which to look. Note that you need to create a new entry for every library you want to install. In -other words, if your project depends on both PyTorch and torchvision, you need to do as follows: +Next, update the `pyproject.toml` to point `torch` and `torchvision` to the desired index: === "CPU-only" - Note that we use the `platform_system` marker to instruct `uv` to look into this index on Linux and Windows. + PyTorch doesn't publish CPU-only builds for macOS, since macOS builds are always considered CPU-only. + As such, we gate on `platform_system` to instruct uv to ignore the PyTorch index when resolving for macOS. ```toml [tool.uv.sources] @@ -115,7 +124,8 @@ other words, if your project depends on both PyTorch and torchvision, you need t === "CUDA 11.8" - Note that we use the `platform_system` marker to instruct `uv` to look into this index on Linux and Windows. + PyTorch doesn't publish CUDA builds for macOS. As such, we gate on `platform_system` to instruct uv to ignore + the PyTorch index when resolving for macOS. ```toml [tool.uv.sources] @@ -129,7 +139,8 @@ other words, if your project depends on both PyTorch and torchvision, you need t === "CUDA 12.1" - Note that we use the `platform_system` marker to instruct `uv` to look into this index on Linux and Windows. + PyTorch doesn't publish CUDA builds for macOS. As such, we gate on `platform_system` to instruct uv to ignore + the PyTorch index when resolving for macOS. ```toml [tool.uv.sources] @@ -143,7 +154,8 @@ other words, if your project depends on both PyTorch and torchvision, you need t === "CUDA 12.4" - Note that we use the `platform_system` marker to instruct `uv` to look into this index on Linux and Windows. + PyTorch doesn't publish CUDA builds for macOS. As such, we gate on `platform_system` to instruct uv to ignore + the PyTorch index when resolving for macOS. ```toml [tool.uv.sources] @@ -157,7 +169,8 @@ other words, if your project depends on both PyTorch and torchvision, you need t === "ROCm6" - Note that we use the `platform_system` marker to instruct `uv` to look into this index when on Linux only. + PyTorch doesn't publish ROCm6 builds for macOS or Windows. As such, we gate on `platform_system` to instruct uv to + ignore the PyTorch index when resolving for those platforms. ```toml [tool.uv.sources] @@ -169,30 +182,149 @@ other words, if your project depends on both PyTorch and torchvision, you need t ] ``` -## Add PyTorch to your dependencies +As a complete example, the following project would use PyTorch's CPU-only builds on all platforms: -Finally, we can add PyTorch to the `project.dependencies` section of the `pyproject.toml`. To -install PyTorch and torchvision, run: +```toml +[project] +name = "project" +version = "0.1.0" +requires-python = ">=3.12.0" +dependencies = [ + "torch>=2.5.1", + "torchvision>=0.20.1", +] -```sh -uv add torch torchvision +[tool.uv.sources] +torch = [ + { index = "pytorch-cpu", marker = "platform_system != 'Darwin'" }, +] +torchvision = [ + { index = "pytorch-cpu", marker = "platform_system != 'Darwin'" }, +] + +[[tool.uv.index]] +name = "pytorch-cpu" +url = "https://download.pytorch.org/whl/cpu" +explicit = true ``` -However, if you want to be more explicit, you could also: +## Configuring accelerators with environment markers + +In some cases, you may want to use CPU-only builds in one environment (e.g., macOS and Windows), and +CUDA-enabled builds in another (e.g., Linux). + +With `tool.uv.sources`, you can use environment markers to specify the desired index for each +platform. For example, the following configuration would use PyTorch's CPU-only builds on Windows +(and macOS, by way of falling back to PyPI), and CUDA-enabled builds on Linux: ```toml [project] +name = "project" +version = "0.1.0" +requires-python = ">=3.12.0" dependencies = [ - "torch==2.5.0 ; platform_system == 'Darwin'", - "torch==2.5.0+cu124 ; platform_system != 'Darwin'", - "torchvision==0.20.0 ; platform_system == 'Darwin'", - "torchvision==0.20.0+cu124 ; platform_system != 'Darwin'", + "torch>=2.5.1", + "torchvision>=0.20.1", ] + +[tool.uv.sources] +torch = [ + { index = "pytorch-cpu", marker = "platform_system == 'Windows'" }, + { index = "pytorch-cu124", marker = "platform_system == 'Linux'" }, +] +torchvision = [ + { index = "pytorch-cpu", marker = "platform_system == 'Windows'" }, + { index = "pytorch-cu124", marker = "platform_system == 'Linux'" }, +] + +[[tool.uv.index]] +name = "pytorch-cpu" +url = "https://download.pytorch.org/whl/cpu" +explicit = true + +[[tool.uv.index]] +name = "pytorch-cu124" +url = "https://download.pytorch.org/whl/cu124" +explicit = true ``` -This will install PyTorch 2.5.0 and torchvision 0.19 on macOS, and PyTorch 2.5.0+cu124 with -torchvision 0.20.0+cu124 on Linux and Windows. +## Configuring accelerators with optional dependencies + +In some cases, you may want to use CPU-only builds in some cases, but CUDA-enabled builds in others, +with the choice toggled by a user-provided extra (e.g., `uv sync --extra cpu` vs. +`uv sync --extra cu124`). -!!! warning "PyTorch on Intel Macs" +With `tool.uv.sources`, you can use extra markers to specify the desired index for each enabled +extra. For example, the following configuration would use PyTorch's CPU-only for +`uv sync --extra cpu` and CUDA-enabled builds for `uv sync --extra cu124`: - Note that the last minor version to support Intel Macs is PyTorch 2.2. In other words, if you try to install PyTorch 2.3.0 or more on an Intel Mac, you will get an error. Alternatively, you can install PyTorch with conda +```toml +[project] +name = "project" +version = "0.1.0" +requires-python = ">=3.12.0" +dependencies = [] + +[project.optional-dependencies] +cpu = [ + "torch>=2.5.1", + "torchvision>=0.20.1", +] +cu124 = [ + "torch>=2.5.1", + "torchvision>=0.20.1", +] + +[tool.uv] +conflicts = [ + [ + { extra = "cpu" }, + { extra = "cu124" }, + ], +] + +[tool.uv.sources] +torch = [ + { index = "pytorch-cpu", extra = "cpu", marker = "platform_system != 'Darwin'" }, + { index = "pytorch-cu124", extra = "cu124" }, +] +torchvision = [ + { index = "pytorch-cpu", extra = "cpu", marker = "platform_system != 'Darwin'" }, + { index = "pytorch-cu124", extra = "cu124" }, +] + +[[tool.uv.index]] +name = "pytorch-cpu" +url = "https://download.pytorch.org/whl/cpu" +explicit = true + +[[tool.uv.index]] +name = "pytorch-cu124" +url = "https://download.pytorch.org/whl/cu124" +explicit = true +``` + +!!! note + + Since GPU-accelerated builds aren't available on macOS, the above configuration will continue to use + the CPU-only builds on macOS via the `"platform_system != 'Darwin'"` marker, regardless of the extra + provided. + +## The `uv pip` interface + +While the above examples are focused on uv's project interface (`uv lock`, `uv sync`, `uv run`, +etc.), PyTorch can also be installed via the `uv pip` interface. + +PyTorch itself offers a [dedicated interface](https://pytorch.org/get-started/locally/) to determine +the appropriate pip command to run for a given target configuration. For example, you can install +stable, CPU-only PyTorch on Linux with: + +```shell +$ pip3 install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu +``` + +To use the same workflow with uv, replace `pip3` with `uv pip`: + +```shell +$ uv pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/cpu +``` diff --git a/mkdocs.template.yml b/mkdocs.template.yml index 2e76518d4079..27303e94bb7c 100644 --- a/mkdocs.template.yml +++ b/mkdocs.template.yml @@ -115,6 +115,7 @@ nav: - GitHub Actions: guides/integration/github.md - GitLab CI/CD: guides/integration/gitlab.md - Pre-commit: guides/integration/pre-commit.md + - PyTorch: guides/integration/pytorch.md - FastAPI: guides/integration/fastapi.md - PyTorch: guides/integration/pytorch.md - Alternative indexes: guides/integration/alternative-indexes.md