ci: build doc with uv and use ruff for lint checks instead of flake8

Author: fracape

.github/workflows/static-gh-pages.yml

@@ -10,21 +10,21 @@ jobs:
     name: publish documentation
     steps:
       - uses: actions/checkout@v4
-      - name: Setup Python
-        uses: actions/setup-python@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
         with:
           python-version: '3.10'
-
-      - name: install dependencies pip
-        run: |
-          python3 -m pip install -U pip
-          python3 -m pip install .[doc]
+      
+      - name: Install the project
+        run:
+          uv sync --group=doc
+          
 
       - name: make docs
         run: |
-          make -C docs clean
-          make -C docs html
-
+          cd docs
+          uv run --no-sync make html
+          
       - name: Init repo for generated files
         run: |
           cd docs/_build/html

.gitlab-ci.yml

@@ -70,14 +70,14 @@ sdist:
   tags:
     - docker
 
-flake8:
+ruff-lint:
   stage: static-analysis
   image: pytorch/pytorch:2.2.0-cuda11.8-cudnn8-devel
   before_script:
     - *default-before-script
     - uv sync --only-group=dev
   script:
-    - uv run --no-sync make check-flake8
+    - uv run --no-sync make check-ruff-lint
   tags:
     - docker
 

Makefile

@@ -15,7 +15,7 @@ help: ## Show this message
 
 
 # Check style and linting
-.PHONY: check-ruff-format check-ruff-organize-imports check-flake8 check-mypy static-analysis
+.PHONY: check-ruff-format check-ruff-organize-imports check-ruff-lint check-mypy static-analysis
 
 check-ruff-format: ## Run ruff format checks
 	@echo "--> Running ruff format checks"
@@ -25,15 +25,15 @@ check-ruff-organize-imports: ## Run ruff organize imports checks
 	@echo "--> Running ruff organize imports checks"
 	@ruff check --ignore ALL --select I $(src_dirs)
 
-check-flake8: ## Run flake8 checks
-	@echo "--> Running flake8 checks"
-	@flake8 $(src_dirs)
+check-ruff-lint: ## Run ruff lint checks
+	@echo "--> Running ruff lint checks"
+	@ruff check $(src_dirs)
 
 check-mypy: ## Run mypy checks
 	@echo "--> Running mypy checks"
 	@mypy
 
-static-analysis: check-ruff-format check-ruff-organize-imports check-flake8 # check-mypy ## Run all static checks
+static-analysis: check-ruff-format check-ruff-organize-imports check-ruff-lint # check-mypy ## Run all static checks
 
 
 # Apply styling

compressai/entropy_models/entropy_models.py

@@ -847,9 +847,9 @@ def _build_cdf(self, scales, means, weights, abs_max):
             ),
             dim=1,
         ).transpose(0, 1)
-        pmf_quantized[
-            pmf_real_steal_indices[0], pmf_real_steal_indices[1]
-        ] -= pmf_zero_count
+        pmf_quantized[pmf_real_steal_indices[0], pmf_real_steal_indices[1]] -= (
+            pmf_zero_count
+        )
 
         cdf = F.pad(torch.cumsum(pmf_quantized, 1).int(), (1, 0), "constant", 0)
         cdf = F.pad(cdf, (0, 1), "constant", cdf_limit + 1)

ruff.toml

@@ -2,11 +2,19 @@ extend-exclude = [
     "*.ipynb",
 ]
 
+[lint]
+select = ["E", "F"]
+ignore = ["E203", "E501", "F401", "F403"]
+# E203, black and flake8 disagree on whitespace before ':'
+# E501, line too long (> 79 characters)
+# W503, black and flake8 disagree on how to place operators
+# F403, 'from module import *' used; unable to detect undefined names
+
 [lint.isort]
 lines-between-types = 1
 known-third-party = [
     "PIL",
     "pytorch_msssim",
     "torchvision",
     "torch",
-]
+]