Merge branch 'main' into dev-new-engine

Author: ValerianRey

.github/workflows/build-deploy-docs.yml

@@ -27,7 +27,7 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Install dependencies (default with full options & doc)
-        run: uv pip install --python-version=${{ env.PYTHON_VERSION }} '.[full]' --group doc
+        run: uv pip install --python-version=${{ env.PYTHON_VERSION }} -e '.[full]' --group doc
 
       - name: Determine deployment folder
         id: deploy_folder

.github/workflows/tests.yml

@@ -27,7 +27,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install default (with full options) and test dependencies
-        run: uv pip install --python-version=${{ matrix.python-version }} '.[full]' --group test
+        run: uv pip install --python-version=${{ matrix.python-version }} -e '.[full]' --group test
       - name: Run unit and doc tests with coverage report
         run: uv run pytest -W error tests/unit tests/doc --cov=src --cov-report=xml
       - name: Upload results to Codecov
@@ -45,7 +45,7 @@ jobs:
         with:
           python-version: ${{ env.PYTHON_VERSION }}
       - name: Install default (without any option) and test dependencies
-        run: uv pip install --python-version=${{ env.PYTHON_VERSION }} . --group test
+        run: uv pip install --python-version=${{ env.PYTHON_VERSION }} -e . --group test
       - name: Run unit and doc tests with coverage report
         run: |
           uv run pytest -W error tests/unit tests/doc \
@@ -71,7 +71,7 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Install dependencies (default with full options & doc)
-        run: uv pip install --python-version=${{ env.PYTHON_VERSION }} '.[full]' --group doc
+        run: uv pip install --python-version=${{ env.PYTHON_VERSION }} -e '.[full]' --group doc
 
       - name: Build Documentation
         working-directory: docs
@@ -90,7 +90,7 @@ jobs:
         python-version: ${{ env.PYTHON_VERSION }}
 
     - name: Install dependencies (default with full options & check)
-      run: uv pip install --python-version=${{ env.PYTHON_VERSION }} '.[full]' --group check
+      run: uv pip install --python-version=${{ env.PYTHON_VERSION }} -e '.[full]' --group check
 
     - name: Run mypy
       run: uv run mypy src/torchjd

CONTRIBUTING.md

@@ -19,8 +19,15 @@ mandatory, we only provide installation steps with this tool. You can install it
 2) Create a virtual environment and install the project in it. From the root of `torchjd`, run:
    ```bash
    uv venv
-   CC=gcc uv pip install --python-version=3.13.3 -e '.[full]' --group check --group doc --group test --group plot
+   CC=gcc uv pip install --python-version=3.14 -e '.[full]' --group check --group doc --group test --group plot
    ```
+   If you want to install PyTorch with a different CUDA version (this could be required depending on
+   your GPU), you'll need to specify and extra index. For instance, for CUDA 12.6, run:
+      ```bash
+   uv venv
+   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
+   ```
+
    We also advise using `UV_NO_SYNC=1` to prevent `uv` from syncing all the time. This is because by
    default, it tries to resolve libraries compatible with the whole range of Python versions
    supported by TorchJD, but in reality, we just need an installation compatible with the currently
@@ -60,7 +67,7 @@ from the root of `torchjd`:
 rm -rf .venv
 rm uv.lock
 uv venv
-CC=gcc uv pip install --python-version=3.13.3 -e '.[full]' --group check --group doc --group test --group plot
+CC=gcc uv pip install --python-version=3.14 -e '.[full]' --group check --group doc --group test --group plot
 uv run pre-commit install
 ```