Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
25 changes: 25 additions & 0 deletions built-in-nodes/APG.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "APG - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the APG node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "APG"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/APG/en.md)

The APG (Adaptive Projected Guidance) node modifies the sampling process by adjusting how guidance is applied during diffusion. It separates the guidance vector into parallel and orthogonal components relative to the conditional output, allowing for more controlled image generation. The node provides parameters to scale the guidance, normalize its magnitude, and apply momentum for smoother transitions between diffusion steps.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `model` | MODEL | Required | - | - | The diffusion model to apply adaptive projected guidance to |
| `eta` | FLOAT | Required | 1.0 | -10.0 to 10.0 | Controls the scale of the parallel guidance vector. Default CFG behavior at a setting of 1. |
| `norm_threshold` | FLOAT | Required | 5.0 | 0.0 to 50.0 | Normalize guidance vector to this value, normalization disable at a setting of 0. |
| `momentum` | FLOAT | Required | 0.0 | -5.0 to 1.0 | Controls a running average of guidance during diffusion, disabled at a setting of 0. |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `model` | MODEL | Returns the modified model with adaptive projected guidance applied to its sampling process |
31 changes: 31 additions & 0 deletions built-in-nodes/AddNoise.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "AddNoise - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AddNoise node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AddNoise"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AddNoise/en.md)

# AddNoise

This node adds controlled noise to a latent image using specified noise parameters and sigma values. It processes the input through the model's sampling system to apply noise scaling appropriate for the given sigma range.

## How It Works

The node takes a latent image and applies noise to it based on the provided noise generator and sigma values. It first checks if there are any sigmas provided - if not, it returns the original latent image unchanged. The node then uses the model's sampling system to process the latent image and apply scaled noise. The noise scaling is determined by the difference between the first and last sigma values when multiple sigmas are provided, or by the single sigma value when only one is available. Empty latent images (containing only zeros) are not shifted during processing. The final output is a new latent representation with the applied noise, with any NaN or infinite values converted to zeros for stability.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `model` | MODEL | Required | - | - | The model containing sampling parameters and processing functions |
| `noise` | NOISE | Required | - | - | The noise generator that produces the base noise pattern |
| `sigmas` | SIGMAS | Required | - | - | Sigma values controlling the noise scaling intensity |
| `latent_image` | LATENT | Required | - | - | The input latent representation to which noise will be added |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `LATENT` | LATENT | The modified latent representation with added noise |
23 changes: 23 additions & 0 deletions built-in-nodes/AddTextPrefix.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "AddTextPrefix - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AddTextPrefix node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AddTextPrefix"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AddTextPrefix/en.md)

The Add Text Prefix node modifies text by adding a specified string to the beginning of each input text. It takes the text and a prefix as input, then returns the combined result.

## Inputs

| Parameter | Data Type | Required | Range | Description |
|-----------|-----------|----------|-------|-------------|
| `text` | STRING | Yes | | The text to which the prefix will be added. |
| `prefix` | STRING | No | | The string to add to the beginning of the text (default: ""). |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `text` | STRING | The resulting text with the prefix added to the front. |
23 changes: 23 additions & 0 deletions built-in-nodes/AddTextSuffix.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "AddTextSuffix - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AddTextSuffix node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AddTextSuffix"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AddTextSuffix/en.md)

This node appends a specified suffix to the end of an input text string. It takes the original text and the suffix as inputs, then returns the combined result.

## Inputs

| Parameter | Data Type | Required | Range | Description |
|-----------|-----------|----------|-------|-------------|
| `text` | STRING | Yes | | The original text to which the suffix will be added. |
| `suffix` | STRING | No | | The suffix to add to the text (default: ""). |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `text` | STRING | The resulting text after the suffix has been appended. |
23 changes: 23 additions & 0 deletions built-in-nodes/AdjustBrightness.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "AdjustBrightness - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AdjustBrightness node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AdjustBrightness"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AdjustBrightness/en.md)

The Adjust Brightness node modifies the brightness of an input image. It works by multiplying each pixel's value by a specified factor, then ensuring the resulting values stay within a valid range. A factor of 1.0 leaves the image unchanged, values below 1.0 make it darker, and values above 1.0 make it brighter.

## Inputs

| Parameter | Data Type | Required | Range | Description |
|-----------|-----------|----------|-------|-------------|
| `image` | IMAGE | Yes | - | The input image to adjust. |
| `factor` | FLOAT | No | 0.0 - 2.0 | Brightness factor. 1.0 = no change, <1.0 = darker, >1.0 = brighter. (default: 1.0) |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `image` | IMAGE | The output image with adjusted brightness. |
23 changes: 23 additions & 0 deletions built-in-nodes/AdjustContrast.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "AdjustContrast - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AdjustContrast node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AdjustContrast"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AdjustContrast/en.md)

The Adjust Contrast node modifies the contrast level of an input image. It works by adjusting the difference between the light and dark areas of the image. A factor of 1.0 leaves the image unchanged, values below 1.0 reduce contrast, and values above 1.0 increase it.

## Inputs

| Parameter | Data Type | Required | Range | Description |
|-----------|-----------|----------|-------|-------------|
| `image` | IMAGE | Yes | - | The input image to have its contrast adjusted. |
| `factor` | FLOAT | No | 0.0 - 2.0 | Contrast factor. 1.0 = no change, <1.0 = less contrast, >1.0 = more contrast. (default: 1.0) |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `image` | IMAGE | The resulting image with adjusted contrast. |
24 changes: 24 additions & 0 deletions built-in-nodes/AlignYourStepsScheduler.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "AlignYourStepsScheduler - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AlignYourStepsScheduler node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AlignYourStepsScheduler"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AlignYourStepsScheduler/en.md)

The AlignYourStepsScheduler node generates sigma values for the denoising process based on different model types. It calculates appropriate noise levels for each step of the sampling process and adjusts the total number of steps according to the denoise parameter. This helps align the sampling steps with the specific requirements of different diffusion models.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `model_type` | STRING | COMBO | - | SD1, SDXL, SVD | Specifies the type of model to use for sigma calculation |
| `steps` | INT | INT | 10 | 1-10000 | The total number of sampling steps to generate |
| `denoise` | FLOAT | FLOAT | 1.0 | 0.0-1.0 | Controls how much to denoise the image, where 1.0 uses all steps and lower values use fewer steps |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `sigmas` | SIGMAS | Returns the calculated sigma values for the denoising process |
23 changes: 23 additions & 0 deletions built-in-nodes/AudioAdjustVolume.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "AudioAdjustVolume - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AudioAdjustVolume node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AudioAdjustVolume"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AudioAdjustVolume/en.md)

The AudioAdjustVolume node modifies the loudness of audio by applying volume adjustments in decibels. It takes an audio input and applies a gain factor based on the specified volume level, where positive values increase volume and negative values decrease it. The node returns the modified audio with the same sample rate as the original.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `audio` | AUDIO | required | - | - | The audio input to be processed |
| `volume` | INT | required | 1.0 | -100 to 100 | Volume adjustment in decibels (dB). 0 = no change, +6 = double, -6 = half, etc |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `audio` | AUDIO | The processed audio with adjusted volume level |
24 changes: 24 additions & 0 deletions built-in-nodes/AudioConcat.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "AudioConcat - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AudioConcat node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AudioConcat"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AudioConcat/en.md)

The AudioConcat node combines two audio inputs by joining them together. It takes two audio inputs and connects them in the order you specify, either placing the second audio before or after the first audio. The node automatically handles different audio formats by converting mono audio to stereo and matching sample rates between the two inputs.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `audio1` | AUDIO | required | - | - | The first audio input to be concatenated |
| `audio2` | AUDIO | required | - | - | The second audio input to be concatenated |
| `direction` | COMBO | required | after | ['after', 'before'] | Whether to append audio2 after or before audio1 |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `AUDIO` | AUDIO | The combined audio containing both input audio files joined together |
23 changes: 23 additions & 0 deletions built-in-nodes/AudioEncoderEncode.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "AudioEncoderEncode - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AudioEncoderEncode node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AudioEncoderEncode"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AudioEncoderEncode/en.md)

The AudioEncoderEncode node processes audio data by encoding it using an audio encoder model. It takes audio input and converts it into an encoded representation that can be used for further processing in the conditioning pipeline. This node transforms raw audio waveforms into a format suitable for audio-based machine learning applications.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `audio_encoder` | AUDIO_ENCODER | Required | - | - | The audio encoder model used to process the audio input |
| `audio` | AUDIO | Required | - | - | The audio data containing waveform and sample rate information |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `output` | AUDIO_ENCODER_OUTPUT | The encoded audio representation generated by the audio encoder |
22 changes: 22 additions & 0 deletions built-in-nodes/AudioEncoderLoader.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "AudioEncoderLoader - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AudioEncoderLoader node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AudioEncoderLoader"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AudioEncoderLoader/en.md)

The AudioEncoderLoader node loads audio encoder models from your available audio encoder files. It takes an audio encoder filename as input and returns a loaded audio encoder model that can be used for audio processing tasks in your workflow.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `audio_encoder_name` | STRING | COMBO | - | Available audio encoder files | Selects which audio encoder model file to load from your audio_encoders folder |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `audio_encoder` | AUDIO_ENCODER | Returns the loaded audio encoder model for use in audio processing workflows |
31 changes: 31 additions & 0 deletions built-in-nodes/AudioEqualizer3Band.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: "AudioEqualizer3Band - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AudioEqualizer3Band node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AudioEqualizer3Band"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AudioEqualizer3Band/en.md)

The Audio Equalizer (3-Band) node allows you to adjust the bass, mid, and treble frequencies of an audio waveform. It applies three separate filters: a low shelf for bass, a peaking filter for mids, and a high shelf for treble. Each band can be independently controlled with gain, frequency, and bandwidth settings.

## Inputs

| Parameter | Data Type | Required | Range | Description |
|-----------|-----------|----------|-------|-------------|
| `audio` | AUDIO | Yes | - | The input audio data containing the waveform and sample rate. |
| `low_gain_dB` | FLOAT | No | -24.0 to 24.0 | Gain for Low frequencies (Bass). Positive values boost, negative values cut. (default: 0.0) |
| `low_freq` | INT | No | 20 to 500 | Cutoff frequency for Low shelf filter in Hertz (Hz). (default: 100) |
| `mid_gain_dB` | FLOAT | No | -24.0 to 24.0 | Gain for Mid frequencies. Positive values boost, negative values cut. (default: 0.0) |
| `mid_freq` | INT | No | 200 to 4000 | Center frequency for the Mid peaking filter in Hertz (Hz). (default: 1000) |
| `mid_q` | FLOAT | No | 0.1 to 10.0 | Q factor (bandwidth) for the Mid peaking filter. Lower values create a wider band, higher values create a narrower band. (default: 0.707) |
| `high_gain_dB` | FLOAT | No | -24.0 to 24.0 | Gain for High frequencies (Treble). Positive values boost, negative values cut. (default: 0.0) |
| `high_freq` | INT | No | 1000 to 15000 | Cutoff frequency for High shelf filter in Hertz (Hz). (default: 5000) |

**Note:** The `low_gain_dB`, `mid_gain_dB`, and `high_gain_dB` parameters are only applied when their value is not zero. If a gain is set to 0.0, the corresponding filter stage is skipped.

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `audio` | AUDIO | The processed audio data with the equalization applied, containing the modified waveform and the original sample rate. |
24 changes: 24 additions & 0 deletions built-in-nodes/AudioMerge.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "AudioMerge - ComfyUI Built-in Node Documentation"
description: "Complete documentation for the AudioMerge node in ComfyUI. Learn its inputs, outputs, parameters and usage."
sidebarTitle: "AudioMerge"
icon: "circle"
mode: wide
---
> This documentation was AI-generated. If you find any errors or have suggestions for improvement, please feel free to contribute! [Edit on GitHub](https://github.com/Comfy-Org/embedded-docs/blob/main/comfyui_embedded_docs/docs/AudioMerge/en.md)

The AudioMerge node combines two audio tracks by overlaying their waveforms. It automatically matches the sample rates of both audio inputs and adjusts their lengths to be equal before merging. The node provides several mathematical methods for combining the audio signals and ensures the output remains within acceptable volume levels.

## Inputs

| Parameter | Data Type | Input Type | Default | Range | Description |
|-----------|-----------|------------|---------|-------|-------------|
| `audio1` | AUDIO | required | - | - | First audio input to merge |
| `audio2` | AUDIO | required | - | - | Second audio input to merge |
| `merge_method` | COMBO | required | - | ["add", "mean", "subtract", "multiply"] | The method used to combine the audio waveforms. |

## Outputs

| Output Name | Data Type | Description |
|-------------|-----------|-------------|
| `AUDIO` | AUDIO | The merged audio output containing the combined waveform and sample rate |
Loading
Loading