SUPIR 项目安装与使用指南

1. 项目目录结构及介绍

SUPIR/
├── assets/
├── llava/
├── options/
├── sgmsgm/
├── CKPT_PTH.py
├── LICENSE
├── README.md
├── gradio_demo.py
├── gradio_demo_face.py
├── gradio_demo_tiled.py
├── requirements.txt
├── test.py

目录结构说明

• assets/: 存放项目相关的资源文件。
• llava/: 存放与 LLaVA 相关的文件和模型。
• options/: 存放项目的配置文件。
• sgmsgm/: 存放与 SGMSGM 相关的文件和模型。
• CKPT_PTH.py: 用于管理模型检查点的 Python 文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• gradio_demo.py: 用于启动 Gradio 演示的 Python 文件。
• gradio_demo_face.py: 用于人脸图像处理的 Gradio 演示文件。
• gradio_demo_tiled.py: 用于分块处理的 Gradio 演示文件。
• requirements.txt: 项目依赖的 Python 包列表。
• test.py: 用于测试项目的 Python 文件。

2. 项目的启动文件介绍

gradio_demo.py

gradio_demo.py 是 SUPIR 项目的主要启动文件之一，用于启动 Gradio 演示界面。通过该文件，用户可以交互式地进行图像处理和恢复操作。

使用方法

CUDA_VISIBLE_DEVICES=0,1 python gradio_demo.py --ip 0.0.0.0 --port 6688 --use_image_slider --log_history

test.py

test.py 是用于测试 SUPIR 模型的启动文件。用户可以通过该文件对图像进行批量处理和恢复。

使用方法

CUDA_VISIBLE_DEVICES=0,1 python test.py --img_dir '/path/to/input/images' --save_dir '/path/to/output/images' --SUPIR_sign Q --upscale 2

3. 项目的配置文件介绍

options/SUPIR_v0.yaml

options/SUPIR_v0.yaml 是 SUPIR 项目的主要配置文件，包含了模型的各种参数设置。

配置项说明

• SDXL_CKPT: SDXL 模型的检查点路径。
• SUPIR_CKPT_Q: SUPIR-v0Q 模型的检查点路径。
• SUPIR_CKPT_F: SUPIR-v0F 模型的检查点路径。
• LLAVA_CLIP_PATH: LLaVA CLIP 模型的路径。
• LLAVA_MODEL_PATH: LLaVA 模型的路径。
• SDXL_CLIP1_PATH: SDXL CLIP Encoder-1 的路径。
• SDXL_CLIP2_CACHE_DIR: SDXL CLIP Encoder-2 的缓存目录。

CKPT_PTH.py

CKPT_PTH.py 是用于管理模型检查点的配置文件。用户可以通过该文件设置模型的路径和参数。

配置项说明

• LLAVA_CLIP_PATH: LLaVA CLIP 模型的路径。
• LLAVA_MODEL_PATH: LLaVA 模型的路径。
• SDXL_CLIP1_PATH: SDXL CLIP Encoder-1 的路径。
• SDXL_CLIP2_CACHE_DIR: SDXL CLIP Encoder-2 的缓存目录。

通过以上配置文件，用户可以根据自己的需求调整模型的参数和路径，以实现最佳的图像恢复效果。