Skip to content

Commit 73c1965

Browse files
authored
docs: Improve installation steps in CONTRIBUTING.md (#480)
* Fix python version * Explain how to install with older cuda version
1 parent 210a971 commit 73c1965

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,15 @@ mandatory, we only provide installation steps with this tool. You can install it
1919
2) Create a virtual environment and install the project in it. From the root of `torchjd`, run:
2020
```bash
2121
uv venv
22-
CC=gcc uv pip install --python-version=3.13.3 -e '.[full]' --group check --group doc --group test --group plot
22+
CC=gcc uv pip install --python-version=3.14 -e '.[full]' --group check --group doc --group test --group plot
2323
```
24+
If you want to install PyTorch with a different CUDA version (this could be required depending on
25+
your GPU), you'll need to specify and extra index. For instance, for CUDA 12.6, run:
26+
```bash
27+
uv venv
28+
CC=gcc uv pip install --python-version=3.14 -e '.[full]' --group check --group doc --group test --group plot --index-strategy unsafe-best-match --extra-index-url https://download.pytorch.org/whl/cu126
29+
```
30+
2431
We also advise using `UV_NO_SYNC=1` to prevent `uv` from syncing all the time. This is because by
2532
default, it tries to resolve libraries compatible with the whole range of Python versions
2633
supported by TorchJD, but in reality, we just need an installation compatible with the currently
@@ -60,7 +67,7 @@ from the root of `torchjd`:
6067
rm -rf .venv
6168
rm uv.lock
6269
uv venv
63-
CC=gcc uv pip install --python-version=3.13.3 -e '.[full]' --group check --group doc --group test --group plot
70+
CC=gcc uv pip install --python-version=3.14 -e '.[full]' --group check --group doc --group test --group plot
6471
uv run pre-commit install
6572
```
6673

0 commit comments

Comments
 (0)