2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 15:48:18 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00
2025-04-30 17:10:09 +08:00

ComfyUI_Step1X-Edit

English | 中文文档

This custom node integrates the Step1X-Edit image editing model into ComfyUI. Step1X-Edit is a state-of-the-art image editing model that processes a reference image and user's editing instruction to generate a new image.

Features

  • Load and use Step1X-Edit models in ComfyUI
  • Edit images with natural language instructions
  • Control the editing process with parameters like steps and guidance scale

Examples

Here are some examples of what you can achieve with ComfyUI_Step1X-Edit:

Example 1 Example 2
Example Image1 Example Image2
  • Example 1: The corresponding prompt was: "给这个女生的脖子上戴一个带有红宝石的吊坠。" ("Add pendant with a ruby around this girl's neck.")
  • Example 2: The corresponding prompt was: "让她哭。" ("Let her cry.")

You can find the example workflow in the examples directory. Load it directly into ComfyUI to see how it works.

Installation

  1. Clone this repository into your ComfyUI's custom_nodes directory:
cd ComfyUI/custom_nodes
git clone https://github.com/raykindle/ComfyUI_Step1X-Edit.git
  1. Install the required dependencies: Step 1: Install ComfyUI_Step1X-Edit
cd ComfyUI_Step1X-Edit
pip install -r requirements.txt

Step 2: Install flash-attn, here we provide a script to help find the pre-built wheel suitable for your system.

python utils/get_flash_attn.py

The script will generate a wheel name like flash_attn-2.7.2.post1+cu12torch2.5cxx11abiFALSE-cp310-cp310-linux_x86_64.whl, which could be found in the release page of flash-attn.

Then you can download the corresponding pre-built wheel and install it following the instructions in flash-attn.

  1. Download the Step1X-Edit-FP8 model:
    • Step1X-Edit diffusion model: Download step1x-edit-i1258-FP8.safetensors from HuggingFace and place it in ComfyUI's models/diffusion_models directory
    • Step1X-Edit VAE: Download vae.safetensors from HuggingFace and place it in ComfyUI's models/vae directory
    • Qwen2.5-VL model: Download Qwen2.5-VL-7B-Instruct and place it in ComfyUI's models/text_encoders/Qwen2.5-VL-7B-Instruct directory

Usage

  1. Start ComfyUI and create a new workflow.
  2. Add the "Step1X-Edit Model Loader" node to your workflow.
  3. Configure the model parameters:
    • Select step1x-edit-i1258-FP8.safetensors as the diffusion model
    • Select vae.safetensors as the VAE
    • Set "Qwen2.5-VL-7B-Instruct" as the text encoder
    • Set additional parameters (dtype, quantized, offload) as needed
  4. Connect an "Step1X-Edit Generate" node to the model node.
  5. Provide an input image and an editing prompt.
  6. Run the workflow to generate edited images.

Example Workflow

Here's a simple example workflow:

  1. Load Image → Step1X-Edit Generate
  2. Step1X-Edit Model Loader → Step1X-Edit Generate
  3. Step1X-Edit Generate → Preview Image

Parameters

Step1X-Edit Model Loader

  • diffusion_model: The Step1X-Edit diffusion model file (select from the diffusion_models dropdown)
  • vae: The Step1X-Edit VAE file (select from the vae dropdown)
  • text_encoder: The path to the Qwen2.5-VL model directory name (e.g., "Qwen2.5-VL-7B-Instruct")
  • dtype: Model precision (bfloat16, float16, or float32)
  • quantized: Whether to use FP8 quantized weights (true recommended)
  • offload: Whether to offload models to CPU when not in use

Step1X-Edit Generate

  • model: The Step1X-Edit model bundle
  • image: The input image to edit
  • prompt: Text instructions describing the desired edit
  • negative_prompt: Text describing what to avoid
  • steps: Number of denoising steps (more steps = better quality but slower)
  • cfg_scale: Guidance scale (how closely to follow the prompt)
  • image_size: Size of the output image (512 recommended)
  • seed: Random seed for reproducibility

Memory Requirements

The Step1X-Edit model requires significant GPU memory:

Model Version Peak GPU Memory (512px / 768px / 1024px)
Standard 42.5GB / 46.5GB / 49.8GB
FP8 Quantized 31GB / 31.5GB / 34GB
With Offload 25.9GB / 27.3GB / 29.1GB
FP8 + Offload 18GB / 18GB / 18GB

For lower memory usage, enable the quantized and/or offload options in the Model Loader node.

Troubleshooting

  • If you encounter CUDA out of memory errors, try:
    • Enabling the offload option
    • Using the FP8 quantized model
    • Reducing the image size
    • Closing other GPU-intensive applications
  • If you get errors about missing files:
    • Make sure your model paths are correct
    • The diffusion model should be in models/diffusion_models
    • The VAE should be in models/vae
    • The text encoder should be in models/text_encoders/Qwen2.5-VL-7B-Instruct
  • If you get import errors, ensure all dependencies are installed correctly

License

This custom node is licensed under the Apache License 2.0, consistent with the original Step1X-Edit repository.

Acknowledgements

  • The Step1X-Edit team for creating the original model
  • ComfyUI for the extensible UI framework
S
Description
No description provided
Readme MIT
1.4 MiB
Languages
Python 100%