ci: Migrate from pdm to uv (#331)

* Add uv.lock to .gitignore and remove .pdm-python from it 
* Change pdm to uv in CONTRIBUTING.md
* Change pdm to uv in tests.yml, build-deploy-docs.yml and release.yml
* Change build-system to setuptools
* Change license classifier to a license field in pyproject.toml

Theoretically, this should only affect contributors and CI.

Author: ValerianRey

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

@@ -17,13 +17,13 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: '3.13'
 
       - name: Install dependencies (default with full options & doc)
-        run: pdm install --group full --group doc --frozen-lockfile
+        run: uv pip install '.[full]' --group doc
 
       - name: Determine deployment folder
         id: deploy_folder
@@ -41,7 +41,7 @@ jobs:
 
       - name: Build Documentation
         working-directory: docs
-        run: pdm run make dirhtml
+        run: uv run make dirhtml
         env:
           TORCHJD_VERSION: ${{ steps.deploy_folder.outputs.TORCHJD_VERSION }}
 

.github/workflows/release.yml

@@ -1,6 +1,5 @@
 name: Release
 
-# Adapted from https://pdm-project.org/latest/usage/publish/
 on:
   release:
     types: [published]
@@ -14,7 +13,16 @@ jobs:
       # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
     steps:
-      - uses: actions/checkout@v4
-      - uses: pdm-project/setup-pdm@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: '3.13'
+
+      - name: Build
+        run: uv build
+
       - name: Publish package distributions to PyPI
-        run: pdm publish
+        run: uv publish -v

.github/workflows/tests.yml

@@ -18,14 +18,14 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - name: Set up PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install default (with full options) and test dependencies
-        run: pdm install --group full --group test --frozen-lockfile
+        run: uv pip install '.[full]' --group test
       - name: Run unit and doc tests with coverage report
-        run: pdm run pytest tests/unit tests/doc --cov=src --cov-report=xml
+        run: uv run pytest tests/unit tests/doc --cov=src --cov-report=xml
       - name: Upload results to Codecov
         uses: codecov/codecov-action@v4
         with:
@@ -36,15 +36,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Set up PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: '3.13'
       - name: Install default (without any option) and test dependencies
-        run: pdm install --group test --frozen-lockfile
+        run: uv pip install . --group test
       - name: Run unit and doc tests with coverage report
         run: |
-          pdm run pytest tests/unit tests/doc \
+          uv run pytest tests/unit tests/doc \
           --ignore tests/unit/aggregation/test_cagrad.py \
           --ignore tests/unit/aggregation/test_nash_mtl.py \
           --ignore tests/doc/test_aggregation.py \
@@ -61,14 +61,14 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Setup PDM
-        uses: pdm-project/setup-pdm@v4
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: '3.13'
 
       - name: Install dependencies (default with full options & doc)
-        run: pdm install --group full --group doc --frozen-lockfile
+        run: uv pip install '.[full]' --group doc
 
       - name: Build Documentation
         working-directory: docs
-        run: pdm run make dirhtml
+        run: uv run make dirhtml

.gitignore

@@ -1,5 +1,5 @@
-# pdm
-.pdm-python
+# uv
+uv.lock
 
 # PyCharm
 .idea/

CONTRIBUTING.md

@@ -5,58 +5,71 @@ with maintainers before implementing major changes.
 
 ## Installation
 
-1) Pre-requisites: To work with TorchJD, you need Python to be installed. In the following, we
-   suggest to use Python 3.13.1, but you can work with any python version supported by `torchjd`. We
-   use [pyenv](https://github.com/pyenv/pyenv) to install Python and
-   [pdm](https://pdm-project.org/en/latest/) to manage dependencies. While the desired Python
-   version can also be installed without pyenv, the installation of `torchjd` for development
-   purposes requires `pdm`. To install it, follow their
-   [installation steps](https://pdm-project.org/en/latest/#installation).
+To work with TorchJD, we suggest you to use [uv](https://docs.astral.sh/uv/). While this is not
+mandatory, we only provide installation steps with this tool. You can install it by following their
+[installation documentation](https://docs.astral.sh/uv/getting-started/installation/).
+
+1) Pre-requisites: Use `uv` to install a Python version compatible with TorchJD and to pin it to the
+  `torchjd` folder. From the root of the `torchjd` repo, run:
+   ```bash
+   uv python install 3.13.3
+   uv python pin 3.13.3
+   ```
 
 2) Create a virtual environment and install the project in it. From the root of `torchjd`, run:
    ```bash
-   pdm venv create 3.13.1  # Requires Python 3.13.1 to be installed
-   pdm use -i .venv/bin/python
-   pdm install --group full --frozen-lockfile
-   pdm run pre-commit install
+   uv venv
+   CC=gcc uv pip install '.[full]' --group check --group doc --group test --group plot
+   uv run pre-commit install
    ```
 
+> [!TIP]
+> If you're running into issues when `uv` tries to compile `ecos`, make sure that `gcc` is
+> installed. Alternatively, you can try to install `clang` or try to use some older Python version
+> (3.12) for which `ecos` has provided compiled packages (the list is accessible
+> [here](https://pypi.org/project/ecos/#files)).
+
 > [!TIP]
 > The Python version that you should specify in your IDE is `<path-to-torchjd>/.venv/bin/python`.
 
+> [!TIP]
+> In the following commands, you can get rid of the `uv run` prefix if you activate the `venv`
+> created by `uv`, using `source .venv/bin/activate` from the root of `torchjd`. This will, however,
+> only work in the current terminal until it is closed.
+
 ## Running tests
    - To verify that your installation was successful, and that all unit tests pass, run:
      ```bash
-     pdm run pytest tests/unit
+     uv run pytest tests/unit
      ```
 
    - If you have access to a cuda-enabled GPU, you should also check that the unit tests pass on it:
      ```bash
-     CUBLAS_WORKSPACE_CONFIG=:4096:8 PYTEST_TORCH_DEVICE=cuda:0 pdm run pytest tests/unit
+     CUBLAS_WORKSPACE_CONFIG=:4096:8 PYTEST_TORCH_DEVICE=cuda:0 uv run pytest tests/unit
      ```
 
    - To check that the usage examples from docstrings and `.rst` files are correct, we test their
    behavior in `tests/doc`. To run these tests, do:
      ```bash
-     pdm run pytest tests/doc
+     uv run pytest tests/doc
      ```
 
   - To compute the code coverage locally, you should run the unit tests and the doc tests together,
   with the `--cov` flag:
     ```bash
-    pdm run pytest tests/unit tests/doc --cov=src
+    uv run pytest tests/unit tests/doc --cov=src
     ```
 
 ## Building the documentation locally
    - From the `docs` folder, run:
      ```bash
-     pdm run make html
+     uv run make html
      ```
    - You can then open `docs/build/html/index.html` with a web browser.
    - Sometimes, you need to manually delete the built documentation before generating it. To do
    this, from the `docs` folder, run:
      ```bash
-     pdm run make clean
+     uv run make clean
      ```
 
 ## Development guidelines

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
-requires = ["pdm-backend"]
-build-backend = "pdm.backend"
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
 
 [project]
 name = "torchjd"
@@ -22,7 +22,6 @@ classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
     "Intended Audience :: Science/Research",
-    "License :: OSI Approved :: MIT License",
     "Operating System :: OS Independent",
     "Programming Language :: Python",
     "Programming Language :: Python :: 3",
@@ -33,6 +32,7 @@ classifiers = [
     "Topic :: Scientific/Engineering",
     "Topic :: Scientific/Engineering :: Artificial Intelligence",
 ]
+license = "MIT"
 
 [project.urls]
 Homepage = "https://torchjd.org/"