指南

使用方法

安装：

1. 进入 ComfyUI/custom_nodes
2. 克隆此仓库，路径应为 ComfyUI/custom_nodes/x-flux-comfyui/*，其中 * 代表该仓库中的所有文件。
3. 进入 ComfyUI/custom_nodes/x-flux-comfyui/ 并运行 python setup.py
4. 安装完成后启动 ComfyUI，即可使用！

首次启动后，ComfyUI/models/xlabs/loras 和 ComfyUI/models/xlabs/controlnets 文件夹将自动创建。
因此，要使用 LoRA 或 ControlNet 模型，只需将模型放入这些文件夹中。
之后，您可能需要在用户友好界面中点击“刷新”按钮以使模型生效。
对于 ControlNet，您还需要安装 https://github.com/Fannovel16/comfyui_controlnet_aux

低显存模式

您可以使用 12GB 显存来运行 Flux。

1. 按照 https://github.com/city96/ComfyUI-GGUF 仓库中的说明进行安装。
2. 使用来自 https://github.com/city96/ComfyUI-GGUF 仓库的 flux1-dev-Q4_0.gguf 文件。
   
3. 使用以下参数启动 ComfyUI：

python3 main.py --lowvram --preview-method auto --use-split-cross-attention

在我们的工作流中，请将“加载扩散模型”节点替换为“Unet 加载器 (GGUF)”节点。

模型

我们为 FLUX.1 [dev] 训练了 Canny ControlNet、Depth ControlNet、HED ControlNet 以及 LoRA 检查点。
您可以在 HuggingFace 上下载它们：

• flux-controlnet-collections
• flux-controlnet-canny
• flux-RealismLora
• flux-lora-collections
• flux-furry-lora
• flux-ip-adapter

IP 适配器

使用说明

1. 使用 git pull 更新 x-flux-comfy，或重新安装。
2. 从 OpenAI VIT CLIP large 下载 Clip-L 的 model.safetensors 文件，并将其放置到 ComfyUI/models/clip_vision/* 目录下。
3. 从 HuggingFace 下载我们的 IPAdapter，并将其放置到 ComfyUI/models/xlabs/ipadapters/* 目录下。
4. 使用 Flux 加载 IPAdapter 和 应用 Flux IPAdapter 节点，选择合适的 CLIP 模型，即可开始生成。
5. 您可以在本仓库的 workflows 文件夹中找到示例工作流。

局限性

IP Adapter 目前仍处于测试阶段。 我们无法保证您能立即获得理想效果，可能需要多次尝试才能得到满意的结果。不过，我们会不断努力，逐步简化并优化这一流程。

x-flux-comfyui 快速上手指南

本指南帮助开发者在 ComfyUI 中快速集成 XLabs 提供的 FLUX.1 控制网（ControlNet）、LoRA 及 IP Adapter 节点。

环境准备

• 系统要求：支持 Python 3.8+ 的操作系统（Linux/Windows/macOS）。
• 前置依赖：
  • 已安装并配置好 ComfyUI。
  • 显存建议：标准模式建议 16GB+ VRAM；若需低显存模式（12GB），需额外安装 ComfyUI-GGUF 插件。
  • ControlNet 辅助依赖：使用 ControlNet 功能前，必须安装 comfyui_controlnet_aux 节点包。
• 网络建议：下载模型时若访问 HuggingFace 困难，建议使用国内镜像源（如 hf-mirror.com）或代理加速。

安装步骤

1. 进入插件目录 终端进入 ComfyUI 的自定义节点文件夹：

   cd ComfyUI/custom_nodes
   

2. 克隆仓库 下载本项目代码：

   git clone https://github.com/XLabs-AI/x-flux-comfyui.git
   

3. 运行初始化脚本 进入插件目录并执行设置脚本以安装依赖：

   cd x-flux-comfyui
   python setup.py
   

4. 重启 ComfyUI 启动或重启 ComfyUI。首次运行后，系统将自动创建以下模型目录：

   • ComfyUI/models/xlabs/loras
   • ComfyUI/models/xlabs/controlnets
   • ComfyUI/models/xlabs/ipadapters (配置 IP Adapter 时使用)

基本使用

1. 部署模型

从 HuggingFace 下载所需模型并放入对应目录（下载后若界面未显示，请点击 ComfyUI 界面上的 "Refresh" 按钮）：

• ControlNet 模型 (Canny/Depth/HED): 放入 ComfyUI/models/xlabs/controlnets
  • 来源：flux-controlnet-collections
• LoRA 模型: 放入 ComfyUI/models/xlabs/loras
  • 来源：flux-lora-collection 或 flux-RealismLora

2. 构建工作流

在 ComfyUI 画布中添加以下专用节点进行连接：

• 加载 ControlNet：使用 Load ControlNet Model 节点选择 xlabs 目录下的模型。
• 加载 LoRA：使用标准的 Load LoRA 节点。
• 参考官方示例工作流：查看仓库内 workflows 文件夹获取预设流程图。

3. 低显存模式 (12GB VRAM)

若显存有限，请按以下步骤启用量化推理：

1. 安装 ComfyUI-GGUF 插件。
2. 下载 flux1-dev-Q4_0.gguf 模型文件。
3. 在工作流中，将标准的 "Load Diffusion Model" 节点替换为 "Unet Loader (GGUF)"。
4. 使用以下参数启动 ComfyUI：

   python3 main.py --lowvram --preview-method auto --use-split-cross-attention
   

4. IP Adapter 配置 (Beta)

如需使用图像提示功能：

1. 下载 OpenAI CLIP-L 模型 (model.safetensors) 至 ComfyUI/models/clip_vision/。
   • 来源：openai/clip-vit-large-patch14
2. 下载 XLabs IPAdapter 模型至 ComfyUI/models/xlabs/ipadapters/。
   • 来源：flux-ip-adapter
3. 使用 Flux Load IPAdapter 和 Apply Flux IPAdapter 节点连接工作流。
   • 注意：该功能处于测试阶段，可能需要多次尝试以获得最佳效果。