ITADN
Comfy-Org/ComfyUI
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

ComfyUI

最强大且高度模块化的内容创作 AI 引擎。

网站 动态 JSON 徽章 Twitter Matrix

ComfyUI 截图

ComfyUI 是专为那些希望对每个模型、每个参数以及每个输出结果都拥有完全控制权的视觉行业专业人士打造的 AI 创作引擎。其强大且模块化的节点图界面让创作者能够生成图像、视频、3D 模型、音频等内容……

  • ComfyUI 原生支持最新的开源尖端模型。
  • API 节点则可让用户使用诸如 Nano Banana、Seedance、Hunyuan3D 等优秀的闭源模型。
  • 它可在 Windows、Linux 和 macOS 系统上运行,既可以通过我们的 桌面应用程序便携版安装包在本地使用,也可以通过我们的 云平台使用。
  • 得益于应用模式,最复杂的工作流也能通过简洁的界面实现。
  • 它还能通过我们的 API 端点与生产流程实现无缝集成。

开始使用

本地使用

桌面应用程序

  • 最简单的入门方式。
  • 支持 Windows 和 macOS 系统。

Windows 便携版包

  • 可获取最新版本,并且完全便携。
  • 仅支持 Windows 系统。

手动安装

  • 支持所有操作系统及各类 GPU(NVIDIA、AMD、Intel、Apple Silicon、Ascend)。

云端使用

Comfy Cloud

  • 面向那些无力购买本地硬件用户的官方付费云服务版本。

实例

通过 较新的模板工作流或旧的示例工作流,了解 ComfyUI 的强大功能。

功能特性

  • 提供可视化的节点图,无需编写代码即可构建和复用图像、视频、音频、3D 以及文本相关的工作流。
  • 支持可复用的子图、工作流模板、应用模式,以及用于将工作流集成到应用程序中的本地 API。
  • 通过异步队列、部分图重执行、智能的 VRAM 和 RAM 管理、模型卸载以及对量化模型的支持,实现高效的本地执行。
  • 对众多原生模型提供支持。以下仅为部分示例;如需查看经过维护、可直接运行的模板,请浏览 工作流库
    • 图像生成:Stable Diffusion 1.5、SDXL、SD3.5、Flux.1、Flux.2、Qwen Image、Z-Image、Hunyuan Image 2.1、HiDream、Lumina Image 2.0、Chroma、Anima、LongCat Image、Ideogram 4、Krea 2、MageFlow、Microsoft Lens、PixelDiT、Kandinsky 5 以及 Ernie Image。
    • 图像编辑:Flux Kontext、Flux.2 Klein、Qwen Image Edit、HiDream E1.1 和 O1、OmniGen2、Boogu、JoyImage Edit、MageFlow Edit 以及 LongCat Image Edit。
    • 视频生成:Wan 2.1 和 2.2、LTX-Video 2 和 2.3、HunyuanVideo 1.5、Kandinsky 5 Video、CogVideoX、Cosmos Predict2、Bernini-R、SCAIL 2 以及 Mochi。
    • 音频与视频生成:MiniMax H3 和 LTX-AV。
    • 音频生成:ACE-Step 1.5 和 Stable Audio 3。
    • 3D 与视觉处理:Hunyuan3D 2.1、TripoSplat、SeedVR2、SUPIR、Depth Anything 3、MoGe、SAM 3 和 3.1、RT-DETRv4 以及 BiRefNet。
    • 文本生成:Gemma 3 和 4、Qwen3、Qwen3.5 以及 Qwen3-VL,支持多模态输入。
  • 可从受支持的模型格式中加载完整的检查点,或单独加载扩散模型、VAE、文本编码器、LoRAs、ControlNets、适配器以及上采样器。
  • 内置多种工具,可用于修补画、扩展画布、参考条件设置、遮罩与合成、模型合并、上采样、帧插值、分割、深度估计以及媒体处理。
  • 可以将工作流保存为 JSON 格式,也可从已生成的受支持媒体中恢复完整的工作流及种子数据。
  • 完全离线运行:除非用户主动请求,否则核心组件不会下载任何内容。可使用 --disable-api-nodes 禁用可选的付费 Comfy API 节点,从而确保所有内置功能始终在离线状态下运行。
  • 可通过自定义节点扩展 ComfyUI 的功能。
  • 可使用 extra_model_paths.yaml 配置额外的模型存储位置。

发布流程

ComfyUI 通常遵循每周一次的发布周期,目标发布日为周一,但由于新模型的推出或代码库的重大变更,这一时间可能会发生变化。该项目包含三个相互关联的仓库:

  1. ComfyUI Core

    • 大约每 2 周发布一个新的主要稳定版本(例如 v0.7.0)。
    • 从 v0.4.0 开始,修复补丁版本将用于回迁到当前的稳定版本中。
    • 小版本将用于从主分支发布的版本。
    • 在无法进行回迁的情况下,主分支的发布仍可能使用补丁版本。
    • 位于稳定版本标签之外的提交可能会非常不稳定,从而导致许多自定义节点出错。
    • 它是桌面版发布的基础。
  2. Comfy Desktop

    • 使用最新的稳定核心版本构建新版本。
  3. ComfyUI Frontend

    • 每 2 周左右,前端更新就会被合并到核心代码库中。
    • 即将发布的核心版本的功能不会再有变动。
    • 开发工作会持续进行,为下一个发布周期做准备。

快捷键

键位组合说明
Ctrl + Enter将当前图表加入生成队列
Ctrl + Shift + Enter将当前图表设为生成队列中的第一个项目
Ctrl + Alt + Enter取消当前的生成操作
Ctrl + Z/Ctrl + Y撤销/重做
Ctrl + S保存工作流
Ctrl + O加载工作流
Ctrl + A全选节点
Alt + C收起/展开选中的节点
Ctrl + M静音/取消静音选中的节点
Ctrl + B规避选中的节点(相当于将该节点从图表中移除,并重新连接相应的线路)
Delete/Backspace删除选中的节点
Ctrl + Backspace删除当前的图表
Space按住该键并移动光标时,可移动画布位置
Ctrl/Shift + Click将点击的节点加入选中列表
Ctrl + C/Ctrl + V复制并粘贴选中的节点(不会保留与未选中节点输出端的连接)
Ctrl + C/Ctrl + Shift + V复制并粘贴选中的节点(会保留未选中节点输出端与粘贴后节点输入端之间的连接)
Shift + Drag同时移动多个选中的节点
Ctrl + D加载默认图表
Alt + +放大画布
Alt + -缩小画布
Ctrl + Shift + 左键 + 垂直拖动放大/缩小画布
P固定/取消固定选中的节点
Ctrl + G将选中的节点分组
Q切换队列的显示状态
H切换历史记录的显示状态
R刷新图表
F显示/隐藏菜单
.使视图适应选中内容(若未选中任何内容,则显示整个图表)
双击左键打开节点快速搜索面板
Shift + 拖动一次性移动多条线路
Ctrl + Alt + 左键断开所有与点击插槽相连的线路

Ctrl 对于 macOS 用户,也可以替换为 Cmd

安装

Windows 与 Mac

我们强烈建议新用户使用 桌面应用

下载链接

对于新手而言,桌面应用是使用 ComfyUI 最简单且最佳的方式。

Windows 便携版

有一个适用于 Windows 的独立便携版,既可以在 Nvidia GPU 上运行,也可以仅通过 CPU 运行。不建议普通用户使用,普通用户应使用上述桌面应用。

直接下载链接(nvidia)

只需下载后,使用 7-Zip 或最新版本 Windows 自带的资源管理器解压,然后运行即可。对于较小的模型,通常只需将检查点文件(即庞大的 ckpt/safetensors 文件)放入 ComfyUI\models\checkpoints 文件夹中;但许多大型模型包含多个文件,务必按照说明确定应将它们放入 ComfyUI\models\ 下的哪个子文件夹中。

如果解压时遇到问题,可右键点击文件 -> 属性 -> 解锁。

上述便携版目前内置了 python 3.13 和 pytorch cuda 13.0。如果程序无法启动,请更新您的 Nvidia 驱动程序。

所有官方便携版下载链接:

AMD GPU 便携版

Intel GPU 便携版

Nvidia GPU 便携版(支持 20 系列及更高版本)。

配备 pytorch cuda 12.6 和 python 3.12 的 Nvidia GPU 便携版(支持 Nvidia 10 系列及更早版本的 GPU,切勿在 20 系列及更高版本的 GPU 上使用)。

如何在其他 UI 与 ComfyUI 之间共享模型?

请查看 配置文件 以设置模型的搜索路径。在独立的 Windows 版本中,该文件位于 ComfyUI 目录下。将此文件重命名为 extra_model_paths.yaml,然后使用您喜欢的文本编辑器进行编辑。

comfy-cli

您也可以使用 comfy-cli 来安装并启动 ComfyUI:

pip install comfy-cli
comfy install

手动安装(Windows、Linux)

Python 3.14 可以使用,但某些自定义节点可能会出现问题。免费的线程版也可以使用,但由于部分依赖项会启用 GIL,因此并不完全受支持。

Python 3.13 的支持度非常高。如果您在 3.13 版本上遇到某些自定义节点的依赖问题,可以尝试使用 3.12 版本。

torch 2.5 仅得到最基本的支持,强烈建议使用更新版本的库。某些功能与优化可能仅适用于更新版本。除非版本发布时间不到 2 周,否则我们通常建议使用最新版本的 pytorch 以及对应的最新 cuda 版本。如果您的 pytorch 已经超过 6 个月未更新,请及时升级。

操作指南:

使用 Git 克隆此仓库。

将您的 SD 检查点文件(即那些体积庞大的 ckpt/safetensors 文件)放入:models/checkpoints

将您的 VAE 文件放入:models/vae

AMD GPU(Linux)

如果尚未安装,AMD 用户可以通过 pip 安装 rocm 以及 pytorch。以下是安装稳定版本的命令:

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/rocm7.2

以下是安装 ROCm 7.2 版本夜间构建的命令,该版本可能在性能上有所提升:

pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/rocm7.2

AMD GPU(实验性版本:Windows 和 Linux),仅支持 RDNA 3、3.5 和 4 架构。

这类架构的硬件支持程度低于上述版本,但可在 Windows 系统上运行。此外,您还需要安装针对自身硬件的特定 pytorch 版本。

RDNA 3(RX 7000 系列):

pip install --pre torch torchvision torchaudio --index-url https://rocm.nightlies.amd.com/v2/gfx110X-all/

RDNA 3.5(Strix halo/Ryzen AI Max+ 365):

pip install --pre torch torchvision torchaudio --index-url https://rocm.nightlies.amd.com/v2/gfx1151/

RDNA 4(RX 9000 系列):

pip install --pre torch torchvision torchaudio --index-url https://rocm.nightlies.amd.com/v2/gfx120X-all/

Intel GPU(Windows 和 Linux)

Intel Arc GPU 用户可以通过 pip 安装带有 torch.xpu 支持的原生 PyTorch。更多相关信息可查看 此处

  1. 要安装 PyTorch xpu,请使用以下命令:

pip install torch torchvision torchaudio --index-url https://download.pytorch.org/whl/xpu

以下是安装 PyTorch xpu 夜间构建的命令,该版本可能在性能上有所提升:

pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/xpu

NVIDIA

Nvidia 用户应使用以下命令安装稳定版本的 pytorch:

pip install torch torchvision torchaudio --extra-index-url https://download.pytorch.org/whl/cu130

以下则是安装 pytorch 夜间构建的命令,该版本可能在性能上有所提升。

pip install --pre torch torchvision torchaudio --index-url https://download.pytorch.org/whl/nightly/cu132

故障排除

如果出现“Torch not compiled with CUDA enabled”错误,请先使用以下命令卸载 torch:

pip uninstall torch

然后再使用上述命令重新安装。

依赖项

在 ComfyUI 文件夹内的终端中执行以下命令来安装所有依赖项:

pip install -r requirements.txt

完成这些操作后,所有依赖项都应该已安装,您可以开始运行 ComfyUI 了。

其他情况:

Apple Mac silicon

在搭载 Apple Mac silicon(M1、M2、M3 或 M4)且运行最新版本 macOS 的设备上,也可以安装 ComfyUI。

  1. 先安装 pytorch 夜间构建版本。相关说明请参阅 Apple 开发者指南中的“在 Mac 上进行加速型 PyTorch 训练”(请务必安装最新的 pytorch 夜间构建版本)。
  2. 按照 ComfyUI 手动安装指南中的步骤操作,该指南适用于 Windows 和 Linux 系统。
  3. 安装 ComfyUI 的依赖项。如果您已有其他 Stable Diffusion UI,或许可以复用这些依赖项
  4. 通过运行python main.py来启动 ComfyUI。

注意:请记得将您的模型、VAE、LoRAs 等文件放入对应的 Comfy 文件夹中,具体方法可参考 ComfyUI 手动安装指南。

Ascend NPU

适用于 PyTorch 的 Ascend Extension(torch_npu)所支持的模型。要开始使用,请确保您的环境满足 安装页面] 中列出的先决条件。以下是针对您的平台及安装方式定制的逐步指南:

  1. 如有需要,首先根据 torch-npu 的安装页面说明,安装 Linux 系统推荐的或更新的内核版本。
  2. 按照针对您特定平台提供的说明,继续安装包含驱动程序、固件以及 CANN 的 Ascend Basekit。
  3. 接下来,遵循 安装页面] 上针对不同平台的说明,安装 torch-npu 所需的软件包。
  4. 最后,按照 Linux 系统的 ComfyUI 手动安装指南] 操作。所有组件安装完成后,即可按照前述方法运行 ComfyUI。

Cambricon MLUs

适用于 PyTorch 的 Cambricon Extension(torch_mlu)所支持的模型。以下是针对您的平台及安装方式定制的逐步指南:

  1. 按照 安装页面] 上针对不同平台的说明,安装 Cambricon CNToolkit。
  2. 接下来,按照 安装页面] 的说明安装 PyTorch(torch_mlu)。
  3. 通过运行 python main.py来启动 ComfyUI。

Iluvatar Corex

适用于 PyTorch 的 Iluvatar Extension 所支持的模型。以下是针对您的平台及安装方式定制的逐步指南:

  1. 按照 安装页面] 上针对不同平台的说明,安装 Iluvatar Corex Toolkit。
  2. 通过运行 python main.py来启动 ComfyUI。

ComfyUI-Manager

ComfyUI-Manager 是一款扩展插件,可让您轻松安装、更新及管理 ComfyUI 的自定义节点。

设置

  1. 安装管理器的依赖项:

    pip install -r manager_requirements.txt
  2. 运行 ComfyUI 时,使用 --enable-manager标志启用该管理器:

    python main.py --enable-manager

命令行选项

标志描述
--enable-manager启用 ComfyUI-Manager
--enable-manager-legacy-ui使用旧版管理器界面,而非新版界面(此时--enable-manager也会被启用)
--disable-manager-ui禁用管理器界面及端点,但保留安全检查、定时安装完成等后台功能(需要配合--enable-manager使用)

运行

python main.py

针对 ROCm 未正式支持的 AMD 显卡

如果您遇到问题,可尝试使用以下命令运行:

对于 6700、6600 以及可能的其他 RDNA2 及更早架构的显卡:HSA_OVERRIDE_GFX_VERSION=10.3.0 python main.py

对于 AMD 7600 以及可能的其他 RDNA3 架构的显卡:HSA_OVERRIDE_GFX_VERSION=11.0.0 python main.py

AMD ROCm 使用技巧

您可以尝试设置该环境变量 PYTORCH_TUNABLEOP_ENABLED=1,这或许能提升速度,但代价是初始运行时会非常缓慢。

备注

只有那些在所有输入都正确的情况下才有输出的结果图部分才会被执行。

只有那些在每次执行之间会发生变化的图部分才会被执行;如果您两次提交相同的图,只会执行第一次的。如果您只修改了图的最后一部分,那么只有被修改的部分以及依赖于它的部分会被执行。

将生成的 png 文件拖放到网页上或直接加载它,即可查看包含用于生成该文件的种子的完整工作流程。

您可以使用 () 来调整单词或短语的强调程度,例如:(good code:1.2) 或 (bad code:0.8)。() 的默认强调值为 1.1。要在实际提示词中使用 () 字符,需对其进行转义,如 \( 或 \)。

您可以使用 {day|night} 来实现通配符/动态提示词功能。通过这种语法 "{wild|card|test}",每次提交提示词时,前端都会随机将其替换为 “wild”、“card” 或 “test” 之一。要在实际提示词中使用 {} 字符,需对其进行转义,如:\{ 或 \}。

动态提示词还支持 C 语言风格的注释,例如 // comment/* comment */

若要在文本提示词中使用文本反转概念/嵌入模型,需将其放入 models/embeddings 目录,然后像这样在 CLIPTextEncode 节点中使用它们(可省略 .pt 扩展名):

embedding:embedding_filename.pt

如何显示高质量预览?

使用 --preview-method auto 可以启用预览功能。

默认安装版本包含一种快速但分辨率较低的潜在空间预览方法。若要使用 TAESD 实现更高品质的预览,请下载 taesd_decoder.pth、taesdxl_decoder.pth、taesd3_decoder.pth 和 taef1_decoder.pth,并将它们放入 models/vae_approx 文件夹中。安装完成后,重启 ComfyUI,并使用 --preview-method taesd 启动它,即可获得高质量预览。

如何使用 TLS/SSL?

通过运行以下命令来生成自签名证书(不适用于共享/生产环境)及密钥:openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/C=XX/ST=StateName/L=CityName/O=CompanyName/OU=CompanySectionName/CN=CommonNameOrHostname"

使用 --tls-keyfile key.pem --tls-certfile cert.pem 可以启用 TLS/SSL,此时该应用将通过 https://... 而非 http://... 访问。

注意:Windows 用户可以使用 alexisrolland/docker-openssl第三方二进制分发版本 来运行上述命令。

如果您使用容器,请注意,卷挂载 -v 可以是相对路径,因此 ... -v ".\:/openssl-certs" ... 会在命令提示符或 PowerShell 终端的当前目录中生成密钥和证书文件。

支持与开发频道

Discord:可以尝试 #help 或 #feedback 频道。

Matrix 空间:#comfyui_space:matrix.org(它类似于 Discord,但属于开源项目)。

另请参阅:https://www.comfy.org/

嘘——我们正在招人! 帮助打造 ComfyUI:comfy.org/careers

前端开发

截至 2024 年 8 月 15 日,我们已切换到新的前端版本,该版本现托管在独立的仓库中:ComfyUI Frontend。从 TS/Vue 编译生成的 JS 文件会被发布到 pypi,并作为依赖项安装到 ComfyUI 中。

报告问题与提出功能需求

对于与前端相关的任何漏洞、问题或功能需求,请使用 ComfyUI Frontend 仓库。这有助于我们更高效地管理和处理前端相关的问题。

使用最新前端版本

新的前端版本现已成为 ComfyUI 的默认版本。但请注意:

  1. 主 ComfyUI 仓库中的前端版本每两周更新一次。
  2. 独立的前端仓库则提供每日发布的版本。

若要使用最新版本的前端:

  1. 若需获取最新的每日发布版本,可通过以下命令行参数启动 ComfyUI:

    --front-end-version Comfy-Org/ComfyUI_frontend@latest
    
  2. 若需指定特定版本,可将 latest 替换为所需的版本号:

    --front-end-version Comfy-Org/ComfyUI_frontend@1.2.2
    

通过这种方式,您可以轻松地在稳定的双周发布版本、最新的每日更新版本之间切换,甚至可以选用特定版本进行测试。

质量保障

我应该买哪款 GPU?

可查看此页面获取相关推荐