Update

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-executables-have-shebangs
       - id: check-json
@@ -18,13 +18,15 @@ repos:
     hooks:
       - id: docformatter
         args: ["--in-place"]
-  - repo: https://github.com/pycqa/isort
-    rev: 5.13.2
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
     hooks:
-      - id: isort
-        args: ["--profile", "black"]
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format
+        args: ["--line-length", "119"]
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.14.0
     hooks:
       - id: mypy
         args: ["--ignore-missing-imports"]
@@ -35,14 +37,8 @@ repos:
             "types-PyYAML",
             "types-pytz",
           ]
-  - repo: https://github.com/psf/black
-    rev: 24.4.2
-    hooks:
-      - id: black
-        language_version: python3.10
-        args: ["--line-length", "119"]
   - repo: https://github.com/kynan/nbstripout
-    rev: 0.7.1
+    rev: 0.8.1
     hooks:
       - id: nbstripout
         args:
@@ -51,7 +47,7 @@ repos:
             "metadata.interpreter metadata.kernelspec cell.metadata.pycharm",
           ]
   - repo: https://github.com/nbQA-dev/nbQA
-    rev: 1.8.5
+    rev: 1.9.1
     hooks:
       - id: nbqa-black
       - id: nbqa-pyupgrade

.python-version

@@ -0,0 +1 @@
+3.10

.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "charliermarsh.ruff",
+        "streetsidesoftware.code-spell-checker",
+        "tamasfe.even-better-toml"
+    ]
+}

.vscode/settings.json

@@ -2,29 +2,20 @@
     "editor.formatOnSave": true,
     "files.insertFinalNewline": false,
     "[python]": {
-        "editor.defaultFormatter": "ms-python.black-formatter",
+        "editor.defaultFormatter": "charliermarsh.ruff",
         "editor.formatOnType": true,
         "editor.codeActionsOnSave": {
+            "source.fixAll.ruff": "explicit",
             "source.organizeImports": "explicit"
         }
     },
     "[jupyter]": {
         "files.insertFinalNewline": false
     },
-    "black-formatter.args": [
-        "--line-length=119"
-    ],
-    "isort.args": ["--profile", "black"],
-    "flake8.args": [
-        "--max-line-length=119"
-    ],
-    "ruff.lint.args": [
-        "--line-length=119"
-    ],
     "notebook.output.scrolling": true,
     "notebook.formatOnCellExecution": true,
     "notebook.formatOnSave.enabled": true,
-        "notebook.codeActionsOnSave": {
-            "source.organizeImports": "explicit"
-        }
+    "notebook.codeActionsOnSave": {
+        "source.organizeImports": "explicit"
+    }
 }

README.md

@@ -4,7 +4,7 @@ emoji: 🐢
 colorFrom: blue
 colorTo: pink
 sdk: gradio
-sdk_version: 4.36.1
+sdk_version: 5.9.1
 app_file: app.py
 pinned: false
 suggested_hardware: a10g-small

app.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python
 
-from __future__ import annotations
-
 import os
 import pathlib
 import shlex
@@ -23,14 +21,15 @@ if not torch.cuda.is_available():
 if torch.cuda.is_available():
     weight_dir = pathlib.Path("plug-and-play/models/ldm/stable-diffusion-v1")
     if not weight_dir.exists():
-        subprocess.run(shlex.split("mkdir -p plug-and-play/models/ldm/stable-diffusion-v1/"))
-        subprocess.run(
+        subprocess.run(shlex.split("mkdir -p plug-and-play/models/ldm/stable-diffusion-v1/"), check=True)  # noqa: S603
+        subprocess.run(  # noqa: S603
             shlex.split(
                 "wget https://huggingface.co/CompVis/stable-diffusion-v-1-4-original/resolve/main/sd-v1-4.ckpt -O plug-and-play/models/ldm/stable-diffusion-v1/model.ckpt"
-            )
+            ),
+            check=True,
         )
 
-with gr.Blocks(css="style.css") as demo:
+with gr.Blocks(css_paths="style.css") as demo:
     gr.Markdown(DESCRIPTION)
     with gr.Tabs():
         with gr.TabItem("Use real image as input"):

app_generated_image.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python
 
-from __future__ import annotations
-
 import pathlib
 import shlex
 import subprocess
@@ -24,9 +22,9 @@ def gen_feature_extraction_config(
     config.config.seed = seed
     config.config.scale = guidance_scale
     config.config.ddim_steps = ddim_steps
-    temp_file = tempfile.NamedTemporaryFile(suffix=".yaml", delete=False)
-    with open(temp_file.name, "w") as f:
-        f.write(OmegaConf.to_yaml(config))
+    with tempfile.NamedTemporaryFile(suffix=".yaml", delete=False) as temp_file:
+        with pathlib.Path(temp_file.name).open("w") as f:
+            f.write(OmegaConf.to_yaml(config))
     return temp_file.name
 
 
@@ -45,7 +43,9 @@ def run_feature_extraction_command(
             guidance_scale,
             ddim_steps,
         )
-        subprocess.run(shlex.split(f"python run_features_extraction.py --config {config_path}"), cwd="plug-and-play")
+        subprocess.run(  # noqa: S603
+            shlex.split(f"python run_features_extraction.py --config {config_path}"), cwd="plug-and-play", check=False
+        )
     return f"plug-and-play/experiments/{exp_name}/samples/0.png", exp_name
 
 
@@ -68,9 +68,9 @@ def gen_pnp_config(
     config.negative_prompt = negative_prompt
     config.negative_prompt_alpha = negative_prompt_alpha
     config.negative_prompt_schedule = negative_prompt_schedule
-    temp_file = tempfile.NamedTemporaryFile(suffix=".yaml", delete=False)
-    with open(temp_file.name, "w") as f:
-        f.write(OmegaConf.to_yaml(config))
+    with tempfile.NamedTemporaryFile(suffix=".yaml", delete=False) as temp_file:
+        with pathlib.Path(temp_file.name).open("w") as f:
+            f.write(OmegaConf.to_yaml(config))
     return temp_file.name
 
 
@@ -94,7 +94,9 @@ def run_pnp_command(
         negative_prompt_alpha,
         negative_prompt_schedule,
     )
-    subprocess.run(shlex.split(f"python run_pnp.py --config {config_path}"), cwd="plug-and-play")
+    subprocess.run(  # noqa: S603
+        shlex.split(f"python run_pnp.py --config {config_path}"), cwd="plug-and-play", check=False
+    )
 
     out_dir = pathlib.Path(
         f'plug-and-play/experiments/{exp_name}/translations/{guidance_scale}_{prompt.replace(" ", "_")}'

app_real_image.py

@@ -1,7 +1,5 @@
 #!/usr/bin/env python
 
-from __future__ import annotations
-
 import hashlib
 import pathlib
 import shlex
@@ -13,18 +11,17 @@ from omegaconf import OmegaConf
 
 
 def get_exp_name(path: str) -> str:
-    with open(path, "rb") as f:
-        res = hashlib.md5(f.read()).hexdigest()
-    return res
+    with pathlib.Path(path).open("rb") as f:
+        return hashlib.md5(f.read()).hexdigest()  # noqa: S324
 
 
 def gen_feature_extraction_config(exp_name: str, init_image_path: str) -> str:
     config = OmegaConf.load("plug-and-play/configs/pnp/feature-extraction-real.yaml")
     config.config.experiment_name = exp_name
     config.config.init_img = init_image_path
-    temp_file = tempfile.NamedTemporaryFile(suffix=".yaml", delete=False)
-    with open(temp_file.name, "w") as f:
-        f.write(OmegaConf.to_yaml(config))
+    with tempfile.NamedTemporaryFile(suffix=".yaml", delete=False) as temp_file:
+        with pathlib.Path(temp_file.name).open("w") as f:
+            f.write(OmegaConf.to_yaml(config))
     return temp_file.name
 
 
@@ -32,7 +29,9 @@ def run_feature_extraction_command(init_image_path: str) -> tuple[str, str]:
     exp_name = get_exp_name(init_image_path)
     if not pathlib.Path(f"plug-and-play/experiments/{exp_name}").exists():
         config_path = gen_feature_extraction_config(exp_name, init_image_path)
-        subprocess.run(shlex.split(f"python run_features_extraction.py --config {config_path}"), cwd="plug-and-play")
+        subprocess.run(  # noqa: S603
+            shlex.split(f"python run_features_extraction.py --config {config_path}"), cwd="plug-and-play", check=False
+        )
     return f"plug-and-play/experiments/{exp_name}/samples/0.png", exp_name
 
 
@@ -55,9 +54,9 @@ def gen_pnp_config(
     config.negative_prompt = negative_prompt
     config.negative_prompt_alpha = negative_prompt_alpha
     config.negative_prompt_schedule = negative_prompt_schedule
-    temp_file = tempfile.NamedTemporaryFile(suffix=".yaml", delete=False)
-    with open(temp_file.name, "w") as f:
-        f.write(OmegaConf.to_yaml(config))
+    with tempfile.NamedTemporaryFile(suffix=".yaml", delete=False) as temp_file:
+        with pathlib.Path(temp_file.name).open("w") as f:
+            f.write(OmegaConf.to_yaml(config))
     return temp_file.name
 
 
@@ -81,7 +80,9 @@ def run_pnp_command(
         negative_prompt_alpha,
         negative_prompt_schedule,
     )
-    subprocess.run(shlex.split(f"python run_pnp.py --config {config_path}"), cwd="plug-and-play")
+    subprocess.run(  # noqa: S603
+        shlex.split(f"python run_pnp.py --config {config_path}"), cwd="plug-and-play", check=False
+    )
 
     out_dir = pathlib.Path(
         f'plug-and-play/experiments/{exp_name}/translations/{guidance_scale}_{prompt.replace(" ", "_")}'
@@ -106,7 +107,7 @@ def process_example(image: str, translation_prompt: str, negative_prompt: str) -
     return reconstructed_image, exp_name, result
 
 
-def create_real_image_demo():
+def create_real_image_demo() -> gr.Blocks:
     with gr.Blocks() as demo:
         with gr.Group():
             gr.Markdown("Step 1 (This step will take about 5 minutes on A10G.)")

pyproject.toml

@@ -0,0 +1,65 @@
+[project]
+name = "pnp-diffusion-features"
+version = "0.1.0"
+description = ""
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "albumentations>=1.4.24",
+    "clip",
+    "diffusers==0.12.1",
+    "einops>=0.8.0",
+    "gradio>=5.9.1",
+    "hf-transfer>=0.1.8",
+    "imageio[ffmpeg]>=2.36.1",
+    "kornia>=0.7.4",
+    "omegaconf>=2.3.0",
+    "opencv-python-headless>=4.10.0.84",
+    "python-slugify>=8.0.4",
+    "pytorch-lightning==1.9.0",
+    "scikit-learn>=1.6.0",
+    "taming-transformers",
+    "torch==1.13.1",
+    "torchvision>=0.14.1",
+    "transformers>=4.47.1",
+]
+
+[tool.ruff]
+line-length = 119
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "COM812", # missing-trailing-comma
+    "D203",   # one-blank-line-before-class
+    "D213",   # multi-line-summary-second-line
+    "E501",   # line-too-long
+    "SIM117", # multiple-with-statements
+]
+extend-ignore = [
+    "D100",    # undocumented-public-module
+    "D101",    # undocumented-public-class
+    "D102",    # undocumented-public-method
+    "D103",    # undocumented-public-function
+    "D104",    # undocumented-public-package
+    "D105",    # undocumented-magic-method
+    "D107",    # undocumented-public-init
+    "EM101",   # raw-string-in-exception
+    "FBT001",  # boolean-type-hint-positional-argument
+    "FBT002",  # boolean-default-value-positional-argument
+    "PD901",   # pandas-df-variable-name
+    "PGH003",  # blanket-type-ignore
+    "PLR0913", # too-many-arguments
+    "PLR0915", # too-many-statements
+    "TRY003",  # raise-vanilla-args
+]
+unfixable = [
+    "F401", # unused-import
+]
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.uv.sources]
+clip = { git = "https://github.com/openai/CLIP.git" }
+taming-transformers = { git = "https://github.com/CompVis/taming-transformers.git" }

requirements.txt

@@ -1,19 +1,333 @@
-albumentations==1.3.0
--e git+https://github.com/openai/CLIP.git@main#egg=clip
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml -o requirements.txt
+aiofiles==23.2.1
+    # via gradio
+aiohappyeyeballs==2.4.4
+    # via aiohttp
+aiohttp==3.11.11
+    # via fsspec
+aiosignal==1.3.2
+    # via aiohttp
+albucore==0.0.23
+    # via albumentations
+albumentations==1.4.24
+    # via pnp-diffusion-features (pyproject.toml)
+annotated-types==0.7.0
+    # via pydantic
+antlr4-python3-runtime==4.9.3
+    # via omegaconf
+anyio==4.7.0
+    # via
+    #   gradio
+    #   httpx
+    #   starlette
+async-timeout==5.0.1
+    # via aiohttp
+attrs==24.3.0
+    # via aiohttp
+certifi==2024.12.14
+    # via
+    #   httpcore
+    #   httpx
+    #   requests
+charset-normalizer==3.4.1
+    # via requests
+click==8.1.8
+    # via
+    #   typer
+    #   uvicorn
+clip @ git+https://github.com/openai/CLIP.git@dcba3cb2e2827b402d2701e7e1c7d9fed8a20ef1
+    # via pnp-diffusion-features (pyproject.toml)
 diffusers==0.12.1
-einops==0.6.0
-gradio==4.36.1
-huggingface-hub==0.23.3
-imageio==2.25.0
-imageio-ffmpeg==0.4.8
-kornia==0.6.9
+    # via pnp-diffusion-features (pyproject.toml)
+einops==0.8.0
+    # via pnp-diffusion-features (pyproject.toml)
+exceptiongroup==1.2.2
+    # via anyio
+fastapi==0.115.6
+    # via gradio
+ffmpy==0.5.0
+    # via gradio
+filelock==3.16.1
+    # via
+    #   diffusers
+    #   huggingface-hub
+    #   transformers
+frozenlist==1.5.0
+    # via
+    #   aiohttp
+    #   aiosignal
+fsspec==2024.12.0
+    # via
+    #   gradio-client
+    #   huggingface-hub
+    #   pytorch-lightning
+ftfy==6.3.1
+    # via clip
+gradio==5.9.1
+    # via pnp-diffusion-features (pyproject.toml)
+gradio-client==1.5.2
+    # via gradio
+h11==0.14.0
+    # via
+    #   httpcore
+    #   uvicorn
+hf-transfer==0.1.8
+    # via pnp-diffusion-features (pyproject.toml)
+httpcore==1.0.7
+    # via httpx
+httpx==0.28.1
+    # via
+    #   gradio
+    #   gradio-client
+    #   safehttpx
+huggingface-hub==0.27.0
+    # via
+    #   diffusers
+    #   gradio
+    #   gradio-client
+    #   tokenizers
+    #   transformers
+idna==3.10
+    # via
+    #   anyio
+    #   httpx
+    #   requests
+    #   yarl
+imageio==2.36.1
+    # via pnp-diffusion-features (pyproject.toml)
+imageio-ffmpeg==0.5.1
+    # via imageio
+importlib-metadata==8.5.0
+    # via diffusers
+jinja2==3.1.5
+    # via gradio
+joblib==1.4.2
+    # via scikit-learn
+kornia==0.7.4
+    # via pnp-diffusion-features (pyproject.toml)
+kornia-rs==0.1.8
+    # via kornia
+lightning-utilities==0.11.9
+    # via
+    #   pytorch-lightning
+    #   torchmetrics
+markdown-it-py==3.0.0
+    # via rich
+markupsafe==2.1.5
+    # via
+    #   gradio
+    #   jinja2
+mdurl==0.1.2
+    # via markdown-it-py
+multidict==6.1.0
+    # via
+    #   aiohttp
+    #   yarl
+numpy==2.2.1
+    # via
+    #   albucore
+    #   albumentations
+    #   diffusers
+    #   gradio
+    #   imageio
+    #   opencv-python-headless
+    #   pandas
+    #   pytorch-lightning
+    #   scikit-learn
+    #   scipy
+    #   taming-transformers
+    #   torchmetrics
+    #   torchvision
+    #   transformers
+nvidia-cublas-cu11==11.10.3.66
+    # via
+    #   nvidia-cudnn-cu11
+    #   torch
+nvidia-cuda-nvrtc-cu11==11.7.99
+    # via torch
+nvidia-cuda-runtime-cu11==11.7.99
+    # via torch
+nvidia-cudnn-cu11==8.5.0.96
+    # via torch
 omegaconf==2.3.0
-opencv-python-headless==4.7.0.68
-Pillow==9.4.0
-python-slugify==7.0.0
+    # via pnp-diffusion-features (pyproject.toml)
+opencv-python-headless==4.10.0.84
+    # via
+    #   pnp-diffusion-features (pyproject.toml)
+    #   albucore
+    #   albumentations
+orjson==3.10.13
+    # via gradio
+packaging==24.2
+    # via
+    #   clip
+    #   gradio
+    #   gradio-client
+    #   huggingface-hub
+    #   kornia
+    #   lightning-utilities
+    #   pytorch-lightning
+    #   torchmetrics
+    #   transformers
+pandas==2.2.3
+    # via gradio
+pillow==11.0.0
+    # via
+    #   diffusers
+    #   gradio
+    #   imageio
+    #   torchvision
+propcache==0.2.1
+    # via
+    #   aiohttp
+    #   yarl
+psutil==6.1.1
+    # via imageio
+pydantic==2.10.4
+    # via
+    #   albumentations
+    #   fastapi
+    #   gradio
+pydantic-core==2.27.2
+    # via pydantic
+pydub==0.25.1
+    # via gradio
+pygments==2.18.0
+    # via rich
+python-dateutil==2.9.0.post0
+    # via pandas
+python-multipart==0.0.20
+    # via gradio
+python-slugify==8.0.4
+    # via pnp-diffusion-features (pyproject.toml)
 pytorch-lightning==1.9.0
-scikit-learn==1.2.0
--e git+https://github.com/CompVis/taming-transformers.git@master#egg=taming-transformers
+    # via pnp-diffusion-features (pyproject.toml)
+pytz==2024.2
+    # via pandas
+pyyaml==6.0.2
+    # via
+    #   albumentations
+    #   gradio
+    #   huggingface-hub
+    #   omegaconf
+    #   pytorch-lightning
+    #   transformers
+regex==2024.11.6
+    # via
+    #   clip
+    #   diffusers
+    #   transformers
+requests==2.32.3
+    # via
+    #   diffusers
+    #   huggingface-hub
+    #   torchvision
+    #   transformers
+rich==13.9.4
+    # via typer
+ruff==0.8.4
+    # via gradio
+safehttpx==0.1.6
+    # via gradio
+safetensors==0.4.5
+    # via transformers
+scikit-learn==1.6.0
+    # via pnp-diffusion-features (pyproject.toml)
+scipy==1.14.1
+    # via
+    #   albumentations
+    #   scikit-learn
+semantic-version==2.10.0
+    # via gradio
+setuptools==75.6.0
+    # via
+    #   imageio-ffmpeg
+    #   lightning-utilities
+    #   nvidia-cublas-cu11
+    #   nvidia-cuda-runtime-cu11
+shellingham==1.5.4
+    # via typer
+simsimd==6.2.1
+    # via albucore
+six==1.17.0
+    # via python-dateutil
+sniffio==1.3.1
+    # via anyio
+starlette==0.41.3
+    # via
+    #   fastapi
+    #   gradio
+stringzilla==3.11.3
+    # via albucore
+taming-transformers @ git+https://github.com/CompVis/taming-transformers.git@3ba01b241669f5ade541ce990f7650a3b8f65318
+    # via pnp-diffusion-features (pyproject.toml)
+text-unidecode==1.3
+    # via python-slugify
+threadpoolctl==3.5.0
+    # via scikit-learn
+tokenizers==0.21.0
+    # via transformers
+tomlkit==0.13.2
+    # via gradio
 torch==1.13.1
+    # via
+    #   pnp-diffusion-features (pyproject.toml)
+    #   clip
+    #   kornia
+    #   pytorch-lightning
+    #   taming-transformers
+    #   torchmetrics
+    #   torchvision
+torchmetrics==1.5.2
+    # via pytorch-lightning
 torchvision==0.14.1
-transformers==4.26.0
+    # via
+    #   pnp-diffusion-features (pyproject.toml)
+    #   clip
+tqdm==4.67.1
+    # via
+    #   clip
+    #   huggingface-hub
+    #   pytorch-lightning
+    #   taming-transformers
+    #   transformers
+transformers==4.47.1
+    # via pnp-diffusion-features (pyproject.toml)
+typer==0.15.1
+    # via gradio
+typing-extensions==4.12.2
+    # via
+    #   anyio
+    #   fastapi
+    #   gradio
+    #   gradio-client
+    #   huggingface-hub
+    #   lightning-utilities
+    #   multidict
+    #   pydantic
+    #   pydantic-core
+    #   pytorch-lightning
+    #   rich
+    #   torch
+    #   torchvision
+    #   typer
+    #   uvicorn
+tzdata==2024.2
+    # via pandas
+urllib3==2.3.0
+    # via requests
+uvicorn==0.34.0
+    # via gradio
+wcwidth==0.2.13
+    # via ftfy
+websockets==14.1
+    # via gradio-client
+wheel==0.45.1
+    # via
+    #   nvidia-cublas-cu11
+    #   nvidia-cuda-runtime-cu11
+yarl==1.18.3
+    # via aiohttp
+zipp==3.21.0
+    # via importlib-metadata