Use astral uv on CI testing. Add uv lock and lock check

Author: goanpeca

.github/workflows/unit-tests.yml

@@ -59,44 +59,43 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-
       - name: Get year & week number
         id: get-date
         run: |
           echo "date=$(/bin/date "+%Y-%U")" >> $GITHUB_OUTPUT
-
-      - name: Get pip cache dir
-        id: pip-cache
-        run: |
-          pip install -U pip || python -m pip install -U pip
-          echo "pip_cache=$(pip cache dir)" >> $GITHUB_OUTPUT
-
-      - uses: actions/cache@v4
+      - uses: astral-sh/setup-uv@v6
         with:
-          path: |
-            ${{ steps.pip-cache.outputs.pip_cache }}
-          key: ${{ steps.get-date.outputs.date }}-pytorch-${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.pytorch-channel }}-${{ hashFiles('requirements-dev.txt') }}
-          restore-keys: |
-            ${{ steps.get-date.outputs.date }}-pytorch-${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.pytorch-channel }}-
+          version: "latest"
+          python-version: ${{ matrix.python-version }}
+          activate-environment: true
+          enable-cache: true
+          cache-suffix: "${{ steps.get-date.outputs.date }}-pytorch-${{ runner.os }}-${{ matrix.python-version }}-${{ matrix.pytorch-channel }}"
+          cache-dependency-glob: |
+            **/requirements-dev.txt
+            **/pyproject.toml
+            **/uv.lock
+
+      - name: Check uv lock
+        id: check-lock
+        run: |
+          uv lock --check
 
-      - run: pip install pip wheel setuptools -Uqq
+      - name: Install dev tools
+        run: uv pip install wheel setuptools -Uqq
 
       - name: Install PyTorch
         if: ${{ matrix.pytorch-channel == 'pytorch' }}
-        run: pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
+        run: uv pip install torch torchvision --index-url https://download.pytorch.org/whl/cpu
 
       - name: Install PyTorch (nightly)
         if: ${{ matrix.pytorch-channel == 'pytorch-nightly' }}
-        run: pip install torch torchvision --index-url https://download.pytorch.org/whl/nightly/cpu --pre
+        run: uv pip install torch torchvision --index-url https://download.pytorch.org/whl/nightly/cpu --pre
 
       - name: Install dependencies
         run: |
-          pip install -r requirements-dev.txt
-          pip install .
-          pip list
+          uv pip install -r requirements-dev.txt
+          uv pip install .
+          uv pip list
 
       - name: Check code formatting
         run: |
@@ -142,63 +141,63 @@ jobs:
         run: |
           # MNIST
           # 1) mnist.py
-          python examples/mnist/mnist.py --epochs=1
+          uv run python examples/mnist/mnist.py --epochs=1
 
       - name: Run MNIST with loggers Examples
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           # 2) mnist_with_visdom.py
-          python -c "from visdom.server.build import download_scripts; download_scripts()" # download scripts : https://github.com/facebookresearch/visdom/blob/master/py/server.py#L929
-          python -m visdom.server &
+          uv run python -c "from visdom.server.build import download_scripts; download_scripts()" # download scripts : https://github.com/facebookresearch/visdom/blob/master/py/server.py#L929
+          uv run python -m visdom.server &
           sleep 10
-          python examples/mnist/mnist_with_visdom.py --epochs=1
+          uv run python examples/mnist/mnist_with_visdom.py --epochs=1
           kill %1
           # 3.1) mnist_with_tensorboard.py with tbX
-          python examples/mnist/mnist_with_tensorboard.py --epochs=1
+          uv run python examples/mnist/mnist_with_tensorboard.py --epochs=1
           # 3.2) mnist_with_tensorboard.py with native torch tb
-          pip uninstall -y tensorboardX
-          python examples/mnist/mnist_with_tensorboard.py --epochs=1
+          uv pip uninstall tensorboardX
+          uv run python examples/mnist/mnist_with_tensorboard.py --epochs=1
 
       - name: Run MNIST Example With Crash
         if: ${{ matrix.os == 'ubuntu-latest' }}
         continue-on-error: true
         run: |
           # 4) mnist_save_resume_engine.py
-          python examples/mnist/mnist_save_resume_engine.py --epochs=2 --crash_iteration 1100
+          uv run python examples/mnist/mnist_save_resume_engine.py --epochs=2 --crash_iteration 1100
 
       - name: Resume MNIST from previous crash
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
-          python examples/mnist/mnist_save_resume_engine.py --epochs=2 --resume_from=/tmp/mnist_save_resume/checkpoint_1.pt
+          uv run python examples/mnist/mnist_save_resume_engine.py --epochs=2 --resume_from=/tmp/mnist_save_resume/checkpoint_1.pt
 
       - name: Run GAN example
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           # DCGAN
-          python examples/gan/dcgan.py --dataset fake --dataroot /tmp/fakedata --output-dir /tmp/outputs-dcgan --batch-size 2 --epochs 2  --workers 0
+          uv run python examples/gan/dcgan.py --dataset fake --dataroot /tmp/fakedata --output-dir /tmp/outputs-dcgan --batch-size 2 --epochs 2  --workers 0
 
       - name: Run RL Examples
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           # RL
           # 1) Actor-Critic
-          python examples/reinforcement_learning/actor_critic.py --max-episodes=2
+          uv run python examples/reinforcement_learning/actor_critic.py --max-episodes=2
           # 2) Reinforce
-          python examples/reinforcement_learning/reinforce.py --max-episodes=2
+          uv run python examples/reinforcement_learning/reinforce.py --max-episodes=2
 
       - name: Run Neural Style Example
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           #fast-neural-style
           #train
           mkdir -p ~/.cache/torch/checkpoints/ && wget "https://download.pytorch.org/models/vgg16-397923af.pth" -O ~/.cache/torch/checkpoints/vgg16-397923af.pth
-          python examples/fast_neural_style/neural_style.py train --epochs 1 --cuda 0 --dataset test --dataroot . --image_size 32 --style_image examples/fast_neural_style/images/style_images/mosaic.jpg --style_size 32
+          uv run python examples/fast_neural_style/neural_style.py train --epochs 1 --cuda 0 --dataset test --dataroot . --image_size 32 --style_image examples/fast_neural_style/images/style_images/mosaic.jpg --style_size 32
       - name: Run SR Example
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           set -e
           echo "Testing Caltech101 dataset availability..."
-          if python -c "import torchvision; torchvision.datasets.Caltech101(root='./data', download=True)"; then
+          if uv run python -c "import torchvision; torchvision.datasets.Caltech101(root='./data', download=True)"; then
             echo "Caltech101 dataset downloaded successfully. Please remove this workaround and restore dataset check."
             exit 1
             # python examples/super_resolution/main.py --upscale_factor 3 --crop_size 180 --batch_size 4 --test_batch_size 100 --n_epochs 1 --lr 0.001 --threads 2 --debug

pyproject.toml

@@ -14,6 +14,7 @@ license-files = ["LICENSE"]
 classifiers = [
     "Programming Language :: Python :: 3",
 ]
+requires-python = ">=3.9,<3.13"
 dependencies = [
     "torch>=1.3,<3",
     "packaging"

tests/run_code_style.sh

@@ -3,12 +3,12 @@
 set -xeu
 
 if [ $1 = "lint" ]; then
-    flake8 ignite tests examples --config setup.cfg
+    uv run flake8 ignite tests examples --config setup.cfg
     ufmt diff .
 elif [ $1 = "fmt" ]; then
-    ufmt format .
+    uv run ufmt format .
 elif [ $1 = "mypy" ]; then
-    mypy --config-file mypy.ini
+    uv run mypy --config-file mypy.ini
 elif [ $1 = "install" ]; then
-    pip install --upgrade flake8 "black==24.10.0" "usort==1.0.8.post1" "ufmt==2.7.3" "mypy"
+    uv pip install flake8 "black==24.10.0" "usort==1.0.8.post1" "ufmt==2.7.3" "mypy"
 fi