ComfyUI-Impact-Pack

Custom node pack for ComfyUI This node pack helps to conveniently enhance images through Detector, Detailer, Upscaler, Pipe, and more.

NOTE: The UltralyticsDetectorProvider node is not part of the ComfyUI-Impact-Pack. To use the UltralyticsDetectorProvider node, please install the ComfyUI-Impact-Subpack separately.

NOTICE

• V8.24: This compatibility patch requires ComfyUI version 0.3.63 or higher due to structural changes in DifferentialDiffusion.
• V8.19: legacy nodes (mmdet and etc.) are removed
• V8.18: Support facebookresearch/sam2 models
• V8.0: The Impact Subpack is no longer installed automatically. To use UltralyticsDetectorProvider nodes, please install the Impact Subpack separately.
• V7.6: Automatic installation is no longer supported. Please install using ComfyUI-Manager, or manually install requirements.txt and run install.py to complete the installation.
• V7.0: Supports Switch based on Execution Model Inversion.
• V6.0: Supports FLUX.1 model in Impact KSampler, Detailers, PreviewBridgeLatent
• V5.0: It is no longer compatible with versions of ComfyUI before 2024.04.08.
• V4.87.4: Update to a version of ComfyUI after 2024.04.08 for proper functionality.
• V4.85: Incompatible with the outdated ComfyUI IPAdapter Plus. (A version dated March 24th or later is required.)
• V4.77: Compatibility patch applied. Requires ComfyUI version (Oct. 8th) or later.
• V4.73.3: ControlNetApply (SEGS) supports AnimateDiff
• V4.20.1: Due to the feature update in RegionalSampler, the parameter order has changed, causing malfunctions in previously created RegionalSamplers. Please adjust the parameters accordingly.
• V4.12: MASKS is changed to MASK.
• V4.7.2 isn't compatible with old version of ControlNet Auxiliary Preprocessor. If you will use MediaPipe FaceMesh to SEGS update to latest version(Sep. 17th).
• Selection weight syntax is changed(: -> ::) since V3.16. (tutorial)
• Starting from V3.6, requires latest version(Aug 8, 9ccc965) of ComfyUI.
• In versions below V3.3.1, there was an issue with the image quality generated after using the UltralyticsDetectorProvider. Please make sure to upgrade to a newer version.
• Starting from V3.0, nodes related to mmdet are optional nodes that are activated only based on the configuration settings.
  • Through ComfyUI-Impact-Subpack, you can utilize UltralyticsDetectorProvider to access various detection models.
• Between versions 2.22 and 2.21, there is partial compatibility loss regarding the Detailer workflow. If you continue to use the existing workflow, errors may occur during execution. An additional output called "enhanced_alpha_list" has been added to Detailer-related nodes.
• The permission error related to cv2 that occurred during the installation of Impact Pack has been patched in version 2.21.4. However, please note that the latest versions of ComfyUI and ComfyUI-Manager are required.
• The "PreviewBridge" feature may not function correctly on ComfyUI versions released before July 1, 2023.
• Attempting to load the "ComfyUI-Impact-Pack" on ComfyUI versions released before June 27, 2023, will result in a failure.
• With the addition of wildcard support in FaceDetailer, the structure of DETAILER_PIPE-related nodes and Detailer nodes has changed. There may be malfunctions when using the existing workflow.

How To Install

Recommended

• Install via ComfyUI-Manager.

Manual

• Navigate to ComfyUI/custom_nodes in your terminal (cmd).
• Clone the repository under the custom_nodes directory using the following command:

  git clone https://github.com/ltdrdata/ComfyUI-Impact-Pack comfyui-impact-pack
  cd comfyui-impact-pack
  

• Install dependencies in your Python environment.
  • For Windows Portable, run the following command inside ComfyUI\custom_nodes\comfyui-impact-pack:

    ..\..\..\python_embeded\python.exe -m pip install -r requirements.txt
    

  • If using venv or conda, activate your Python environment first, then run:

    pip install -r requirements.txt
    

Companion Pack

• If you need the Ultralytics Detector Provider to use various YOLO detection models, you should also install ComfyUI-Impact-Subpack.

Custom Nodes

Detector nodes

• SAMLoader (Impact) - Loads the SAM model.
• ONNXDetectorProvider - Loads the ONNX model to provide BBOX_DETECTOR.
• CLIPSegDetectorProvider - Wrapper for CLIPSeg to provide BBOX_DETECTOR.
  • You need to install the ComfyUI-CLIPSeg node extension.
• SEGM Detector (combined) - Detects segmentation and returns a mask from the input image.
• BBOX Detector (combined) - Detects bounding boxes and returns a mask from the input image.
• SAMDetector (combined) - Utilizes the SAM technology to extract the segment at the location indicated by the input SEGS on the input image and outputs it as a unified mask.
• SAMDetector (Segmented) - It is similar to SAMDetector (combined), but it separates and outputs the detected segments. Multiple segments can be found for the same detected area, and currently, a policy is in place to group them arbitrarily in sets of three. This aspect is expected to be improved in the future.
  • As a result, it outputs the combined_mask, which is a unified mask, and batch_masks, which are multiple masks grouped together in batch form.
  • While batch_masks may not be completely separated, it provides functionality to perform some level of segmentation.
• Simple Detector (SEGS) - Operating primarily with BBOX_DETECTOR, and with the additional provision of SAM_MODEL or SEGM_DETECTOR, this node internally generates improved SEGS through mask operations on both bbox and silhouette. It serves as a convenient tool to simplify a somewhat intricate workflow.
• Simple Detector for Video (SEGS) – Performs detection on videos composed of image frames. Instead of using a single mask, it performs detection individually on each image frame and generates a SEGS object with a batch of masks.
• SAM2 Video Detector (SEGS) – Similar to Simple Detector for Video (SEGS), but utilizes SAM2’s video tracking technology to generate a SEGS object with a batch of masks.
  • To use this node, you must select a SAM2 model in the SAMLoader.

ControlNet, IPAdapter

• ControlNetApply (SEGS) - To apply ControlNet in SEGS, you need to use the Preprocessor Provider node from the Inspire Pack to utilize this node.
  • segs_preprocessor and control_image can be selectively applied. If a control_image is given, segs_preprocessor will be ignored.
  • If set to control_image, you can preview the cropped cnet image through SEGSPreview (CNET Image). Images generated by segs_preprocessor should be verified through the cnet_images output of each Detailer.
  • The segs_preprocessor operates by applying preprocessing on-the-fly based on the cropped image during the detailing process, while control_image will be cropped and used as input to ControlNetApply (SEGS).
• ControlNetClear (SEGS) - Clear applied ControlNet in SEGS
• IPAdapterApply (SEGS) - To apply IPAdapter in SEGS, you need to use the Preprocessor Provider node from the Inspire Pack to utilize this node.

Mask operation

• Pixelwise(SEGS & SEGS) - Performs a 'pixelwise and' operation between two SEGS.
• Pixelwise(SEGS - SEGS) - Subtracts one SEGS from another.
• Pixelwise(SEGS & MASK) - Performs a pixelwise AND operation between SEGS and MASK.
• Pixelwise(SEGS & MASKS ForEach) - Performs a pixelwise AND operation between SEGS and MASKS.
  • Please note that this operation is performed with batches of MASKS, not just a single MASK.
• Pixelwise(MASK & MASK) - Performs a 'pixelwise and' operation between two masks.
• Pixelwise(MASK - MASK) - Subtracts one mask from another.
• Pixelwise(MASK + MASK) - Combine two masks.
• SEGM Detector (SEGS) - Detects segmentation and returns SEGS from the input image.
• BBOX Detector (SEGS) - Detects bounding boxes and returns SEGS from the input image.
• Dilate Mask - Dilate Mask.
  • Support erosion for negative value.
• Gaussian Blur Mask - Apply Gaussian Blur to Mask. You can utilize this for mask feathering.
• Mask Rect Area - Create a rectangular mask defined by percentages with preview canvas.
• Mask Rect Area (Advanced) - Create a rectangular mask defined by pixels and image size.

Detailer nodes

• Detailer (SEGS) - Refines the image based on SEGS.
• Detailer (SEGS) with auto retry - Refines the image based on SEGS and will automatically retry if the patch is all black.
• DetailerDebug (SEGS) - Refines the image based on SEGS. Additionally, it provides the ability to monitor the cropped image and the refined image of the cropped image.
  • To prevent regeneration caused by the seed that does not change every time when using 'external_seed', please disable the 'seed random generate' option in the 'Detailer...' node.
• MASK to SEGS - Generates SEGS based on the mask.
• MASK to SEGS For Video - Generates SEGS based on the mask for Video. (Ren