ComfyUI-SUPIR安装与使用指南
一、项目目录结构及介绍
ComfyUI-SUPIR 是一个专为 ComfyUI 设计的SUPIR(Scaling Up to Excellence)超分辨率增强插件。这个项目帮助用户在ComfyUI环境中轻松实现基于SUPIR模型的图像上采样。以下是该项目的基本目录结构以及各部分简介:
ComfyUI-SUPIR/
├── github/workflows # GitHub Actions 的工作流程配置
├── configs # 存放SUPIR相关的配置文件
├── examples # 示例工作流程,展示如何使用本插件
├── options # 可选设置或参数示例
├── sgm # 可能涉及特定算法或组件的代码
├── .gitattributes # Git属性文件,定义文件处理方式
├── .gitignore # 忽略文件列表
├── CKPT_PTH # 模型路径相关脚本或指示
├── pyCKPT_PTH.py # Python脚本,可能用于管理模型路径
├── LICENSE # 许可证文件
├── README.md # 主要的项目说明文件
├── __init__.py # Python包初始化文件
├── nodes.py # 包含ComfyUI节点定义的核心代码
├── nodes_v2.py # 新版本的节点定义,可能是对原nodes.py的改进或扩展
└── requirements.txt # Python依赖库列表,用于环境搭建
二、项目的启动文件介绍
本项目并非通过一个典型的“启动文件”进行运行,而是作为ComfyUI的一部分集成。要启用并使用ComfyUI-SUPIR,您首先需确保已正确安装了ComfyUI。之后的集成步骤主要涉及到以下两步:
-
将项目复制到ComfyUI的自定义节点目录:通常这需要将整个
ComfyUI-SUPIR
目录复制到ComfyUI安装路径下的custom_nodes
中。 -
安装Python依赖:通过运行
requirements.txt
文件中的指令来安装必要的Python库。对于标准安装,使用命令行工具执行:pip install -r requirements.txt
若使用ComfyUI的便携版,则运行:
python_embedded/python.exe -m pip install -r ComfyUI/custom_nodes/ComfyUI-SUPIR/requirements.txt
三、项目的配置文件介绍
项目的主要配置并不体现在单一的配置文件中,而是在于如何使用和调用configs
目录下的各种设定来适配SUPIR模型。用户可以通过修改这些配置实例或者在ComfyUI界面中调整节点参数来定制化上采样的行为。例如,您可以根据需要选择不同的SUPIR模型、设置上采样的倍数(scale_by
)、决定是否使用特定的预处理步骤等。
特别地,模型加载时主要依赖于ComfyUI的标准模型存放路径ComfyUI/models/checkpoints
,意味着用户需自行下载SUPIR及相关SDXL模型,并放置于此路径下。此外,若要优化性能或内存使用,可通过环境变量或额外配置来启用或禁用如xformers
这类加速库。
请注意,本指南为简化说明,具体使用过程还需参考项目内的README.md
文件以及ComfyUI的文档,以获取最新的使用指导和注意事项。