Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 

Basic Usage And Nodes

There are two families of nodes that can be used to use AnimateDiff/Evolved Sampling - Gen1 and Gen2. Other than nodes marked specifically for Gen1/Gen2, all other nodes can be used for both Gen1 and Gen2.

Gen1 and Gen2 produce the exact same results (the backend code is identical), the only difference is in how the modes are used. Overall, Gen1 is the simplest way to use basic AnimateDiff features, while Gen2 separates model loading and application from the Evolved Sampling features. This means in practice, Gen2's Use Evolved Sampling node can be used without a model model, letting Context Options and Sample Settings be used without AnimateDiff.

In the following documentation, inputs/outputs will be color coded as follows:

  • 🟩 - required inputs
  • 🟨 - optional inputs
  • 🟦 - start as widgets, can be converted to inputs
  • 🟪 - output

Gen1/Gen2 Nodes

① Gen1 ① ② Gen2 ②
- All-in-One node
- If same model is loaded by multiple Gen1 nodes, duplicates RAM usage.
- Separates model loading from application and Evolved Sampling
- Enables no motion model usage while preserving Evolved Sampling features
- Enables multiple motion model usage with Apply AnimateDiff Model (Adv.) Node
image image
image image

Inputs

  • 🟩model: StableDiffusion (SD) Model input.
  • 🟦model_name: AnimateDiff (AD) model to load and/or apply during the sampling process. Certain motion models work with SD1.5, while others work with SDXL.
  • 🟦beta_schedule: Applies selected beta_schedule to SD model; autoselect will automatically select the recommended beta_schedule for selected motion models - or will use_existing if no motion model selected for Gen2.
  • 🟨context_options: Context Options node from the context_opts submenu - should be used when needing to go back the sweetspot of an AnimateDiff model. Works with no motion models as well (Gen2 only).
  • 🟨sample_settings: Sample Settings node input - used to apply custom sampling options such as FreeNoise (noise_type), FreeInit (iter_opts), custom seeds, Noise Layers, etc. Works with no motion models as well (Gen2 only).
  • 🟨motion_lora: For v2-based models, Motion LoRA will influence the generated movement. Only a few official motion LoRAs were released - soon, I will be working with some community members to create training code to create (and test) new Motion LoRAs that might work with non-v2 models.
  • 🟨ad_settings: Modifies motion models during loading process, allowing the Positional Encoders (PEs) to be adjusted to extend a model's sweetspot or modify overall motion.
  • 🟨ad_keyframes: Allows scheduling of scale_multival and effect_multival inputs across sampling timesteps.
  • 🟨scale_multival: Uses a Multival input (defaults to 1.0). Previously called motion_scale, it directly influences the amount of motion generated by the model. With the Multival nodes, it can accept a float, list of floats, and/or mask inputs, allowing different scale to be applied to not only different frames, but different areas of frames (including per-frame).
  • 🟨effect_multival: Uses a Multival input (defaults to 1.0). Determines the influence of the motion models on the sampling process. Value of 0.0 is equivalent to normal SD output with no AnimateDiff influence. With the Multival nodes, it can accept a float, list of floats, and/or mask inputs, allowing different effect amount to be applied to not only different frames, but different areas of frames (including per-frame).

Gen2-Only Inputs

  • 🟨motion_model: Input for loaded motion_model.
  • 🟨m_models: One (or more) motion models outputted from Apply AnimateDiff Model nodes.

Gen2 Adv.-Only Inputs

  • 🟨prev_m_models: Previous applied motion models to use alongside this one.
  • 🟨start_percent: Determines when connected motion_model should take effect (supercedes any ad_keyframes).
  • 🟨end_percent: Determines when connected motion_model should stop taking effect (supercedes any ad_keyframes).

Gen1 (Legacy) Inputs

  • 🟦motion_scale: legacy version of scale_multival, can only be a float.
  • 🟦apply_v2_models_properly: backwards compatible toggle for months-old workflows that used code that did not turn off groupnorm hack for v2 models. Only affects v2 models, nothing else. All nodes default this value to True now.

Outputs

  • 🟪MODEL: Injected SD model with Evolved Sampling/AnimateDiff.

Gen2-Only Outputs

  • 🟪MOTION_MODEL: Loaded motion model.
  • 🟪M_MODELS: One (or more) applied motion models, to be either plugged into Use Evolved Sampling or another Apply AnimateDiff Model (Adv.) node.

Multival Nodes

For Multival inputs, these nodes allow the use of floats, list of floats, and/or masks to use as input. Scaled Mask node allows customization of dark/light areas of masks in terms of what the values correspond to.

Node Inputs
image 🟨mask_optional: Mask for float values - black means 0.0, white means 1.0 (multiplied by float_val).
🟦float_val: Float multiplier.
image 🟩mask: Mask for float values.
🟦min_float_val: Minimum value.
🟦max_float_val: Maximum value.
🟦scaling: When absolute, black means min_float_val, white means max_float_val. When relative, darkest area in masks (total) means min_float_val, lighest area in massk (total) means max_float_val.

AnimateDiff Keyframe

Allows scheduling (in terms of timesteps) for scale_multival and effect_multival.

The two settings to determine schedule are start_percent and guarantee_steps. When multiple keyframes have the same start_percent, they will be executed in the order they are connected, and run for guarantee_steps before moving on to the next node.

Node
image

Inputs

  • 🟨prev_ad_keyframes: Chained keyframes to create schedule.
  • 🟨scale_multival: Value of scale to use for this keyframe.
  • 🟨effect_multival: Value of effect to use for this keyframe.
  • 🟦start_percent: Percent of timesteps to start usage of this keyframe. If multiple keyframes have same start_percent, order of execution is determined by their chained order, and will last for guarantee_steps timesteps.
  • 🟦guarantee_steps: Minimum amount of steps the keyframe will be used - when set to 0, this keyframe will only be used when no other keyframes are better matches for current timestep.
  • 🟦inherit_missing: When set to True, any missing scale_multival or effect_multival inputs will inherit the previous keyframe's values - if the previous keyframe also inherits missing, the last inherited value will be used.

Context Options and View Options

These nodes provide techniques used to extend the lengths of animations to get around the sweetspot limitations of AnimateDiff models (typically 16 frames) and HotshotXL model (8 frames).

Context Options works by diffusing portions of the animation at a time, including main SD diffusion, ControlNets, IPAdapters, etc., effectively limiting VRAM usage to be equivalent to be context_length latents.

View Options, in contrast, work by portioning the latents seen by the motion model. This does NOT decrease VRAM usage, but in general is more stable and faster than Context Options, since the latents don't have to go through the whole SD unet.

Context Options and View Options can be combined to get the best of both worlds - longer context_length can be used to gain more stable output, at the cost of using more VRAM (since context_length determines how much SD sampling is done at the same time on the GPU). Provided you have the VRAM, you could also use Views Only Context Options to use only View Options (and automatically make context_length equivalent to full latents) to get a speed boost in return for the higher VRAM usage.

There are two types of Context/View Options: Standard and Looped. Standard options do not cause looping in the output. Looped options, as the name implies, causes looping in the output (from end to beginning). Prior to the code rework, the only context available was the looping kind.

I recommend using Standard Static at first when not wanting looped outputs.

In the below animations, green shows the Contexts, and red shows the Views. TL;DR green is the amount of latents that are loaded into VRAM (and sampled), while red is the amount of latents that get passed into the motion model at a time.

Context Options◆Standard Static

Behavior
anim__00005
(latent count: 64, context_length: 16, context_overlap: 4, total steps: 20)
Node Inputs
image 🟦context_length: Amount of latents to diffuse at once.
🟦context_overlap: Minimum common latents between adjacent windows.
🟦fuse_method: Method for averaging results of windows.
🟦use_on_equal_length: When True, allows context to be used when latent count matches context_length.
🟦start_percent: When multiple Context Options are chained, allows scheduling.
🟦guarantee_steps: When scheduling contexts, determines the minimum amount of sampling steps context should be used.
🟦context_length: Amount of latents to diffuse at once.
🟨prev_context: Allows chaining of contexts.
🟨view_options: When context_length > view_length (unless otherwise specified), allows view_options to be used within each context window.

Context Options◆Standard Uniform

Behavior
anim__00006
(latent count: 64, context_length: 16, context_overlap: 4, context_stride: 1, total steps: 20)
anim__00010
(latent count: 64, context_length: 16, context_overlap: 4, context_stride: 2, total steps: 20)
Node Inputs
image 🟦context_length: Amount of latents to diffuse at once.
🟦context_overlap: Minimum common latents between adjacent windows.
🟦context_stride: Maximum 2^(stride-1) distance between adjacent latents.
🟦fuse_method: Method for averaging results of windows.
🟦use_on_equal_length: When True, allows context to be used when latent count matches context_length.
🟦start_percent: When multiple Context Options are chained, allows scheduling.
🟦guarantee_steps: When scheduling contexts, determines the minimum amount of sampling steps context should be used.
🟦context_length: Amount of latents to diffuse at once.
🟨prev_context: Allows chaining of contexts.
🟨view_options: When context_length > view_length (unless otherwise specified), allows view_options to be used within each context window.

Context Options◆Looped Uniform

Behavior
anim__00008
(latent count: 64, context_length: 16, context_overlap: 4, context_stride: 1, closed_loop: False, total steps: 20)
anim__00009
(latent count: 64, context_length: 16, context_overlap: 4, context_stride: 1, closed_loop: True, total steps: 20)
Node Inputs
image 🟦context_length: Amount of latents to diffuse at once.
🟦context_overlap: Minimum common latents between adjacent windows.
🟦context_stride: Maximum 2^(stride-1) distance between adjacent latents.
🟦closed_loop: When True, adds additional windows to enhance looping.
🟦fuse_method: Method for averaging results of windows.
🟦use_on_equal_length: When True, allows context to be used when latent count matches context_length - allows loops to be made when latent count == context_length.
🟦start_percent: When multiple Context Options are chained, allows scheduling.
🟦guarantee_steps: When scheduling contexts, determines the minimum amount of sampling steps context should be used.
🟦context_length: Amount of latents to diffuse at once.
🟨prev_context: Allows chaining of contexts.
🟨view_options: When context_length > view_length (unless otherwise specified), allows view_options to be used within each context window.

Context Options◆Views Only [VRAM⇈]

Behavior
anim__00011
(latent count: 64, view_length: 16, view_overlap: 4, View Options◆Standard Static, total steps: 20)
Node Inputs
image 🟩view_opts_req: View_options to be used across all latents.
🟨prev_context: Allows chaining of contexts.

There are View Options equivalent of these schedules:

View Options◆Standard Static

Behavior
anim__00012
(latent count: 64, view_length: 16, view_overlap: 4, Context Options◆Standard Static, context_length: 32, context_overlap: 8, total steps: 20)
Node Inputs
image 🟦view_length: Amount of latents in context to pass into motion model at a time.
🟦view_overlap: Minimum common latents between adjacent windows.
🟦fuse_method: Method for averaging results of windows.

View Options◆Standard Uniform

Behavior
anim__00015
(latent count: 64, view_length: 16, view_overlap: 4, view_stride: 1, Context Options◆Standard Static, context_length: 32, context_overlap: 8, total steps: 20)
Node Inputs
image 🟦view_length: Amount of latents in context to pass into motion model at a time.
🟦view_overlap: Minimum common latents between adjacent windows.
🟦view_stride: Maximum 2^(stride-1) distance between adjacent latents.
🟦fuse_method: Method for averaging results of windows.

View Options◆Looped Uniform

Behavior
anim__00016
(latent count: 64, view_length: 16, view_overlap: 4, view_stride: 1, closed_loop: False, Context Options◆Standard Static, context_length: 32, context_overlap: 8, total steps: 20)
NOTE: this one is probably not going to come out looking well unless you are using this for a very specific reason.
Node Inputs
image 🟦view_length: Amount of latents in context to pass into motion model at a time.
🟦view_overlap: Minimum common latents between adjacent windows.
🟦view_stride: Maximum 2^(stride-1) distance between adjacent latents.
🟦closed_loop: When True, adds additional windows to enhance looping.
🟦use_on_equal_length: When True, allows context to be used when latent count matches context_length - allows loops to be made when latent count == context_length.
🟦fuse_method: Method for averaging results of windows.

Sample Settings

The Sample Settings node allows customization of the sampling process beyond what is exposed on most KSampler nodes. With its default values, it will NOT have any effect, and can safely be attached without changing any behavior.

TL;DR To use FreeNoise, select FreeNoise from the noise_type dropdown. FreeNoise does not decrease performance in any way. To use FreeInit, attach the FreeInit Iteration Options to the iteration_opts input. NOTE: FreeInit, despite it's name, works by resampling the latents iterations amount of times - this means if you use iteration=2, total sampling time will be exactly twice as slow since it will be performing the sampling twice.

Noise Layers with the inputs of the same name (or very close to same name) have same intended behavior as the ones for Sample Settings - refer to the inputs below.

Node
image

Inputs

  • 🟨noise_layers: Customizable, stackable noise to add to/modify initial noise.
  • 🟨iteration_opts: Options for determining if (and how) sampling should be repeated consecutively; if you want to check out FreeInit, this is how to use it.
  • 🟨seed_override: Accepts a single int to use a seed instead of the seed passed into the KSampler, or a list of ints (like via FizzNodes' BatchedValueSchedule) to assign individual seeds to each latent in the batch.
  • 🟦seed_offset: When not set to 0, adds value to current seed, predictably changing it, whatever the original seed may have been.
  • 🟦batch_offset: When not set to 0, will 'offset' the noise as if the first latent was actually the batch_offset-nth latent, shifting all the noises over.
  • 🟦noise_type: Selects type of noise to be generated. Values include:
    • default: generates different noise for all latents as usual.
    • constant: generates exact same noise for all latents (based on seed).
    • empty: generates no noise for all latents (as if noise was turned off).
    • repeated_context: repeats noise every context_length (or view_length) amount of latents; stabilizes longer generations, but has very obvious repetition.
    • FreeNoise: repeats noise such that it is repeated every context_length (or view_length), but the overlapped noise between contexts/views is shuffled to make repetition less prevelant while still achieving stabilization.
  • 🟦seed_gen: Allows choosing between ComfyUI and Auto1111 methods of noise generation. One is not better than the other (noise distributions are the same), they are just different methods.
    • comfy: Noise is generated for the entire latent batch tensor at once based on the provided seed.
    • auto1111: Noise is generated individually for each latent, with each latent receiving an increasing +1 seed offset (first latent uses seed, second latent uses seed+1, etc.).
  • 🟦adapt_denoise_steps: When True, KSamplers with a 'denoise' input will automatically scale down the total steps to run like the default options in Auto1111.
    • True: Steps will decrease with lower denoise, i.e. 20 steps with 0.5 denoise will be 10 total steps executed, but sigmas will be selected that still achieve 0.5 denoise. Trades speed for quality (since less steps are sampled).
    • False: Default behavior; 20 steps with 0.5 denoise will execute 20 steps.

Iteration Options

These options allow KSamplers to re-sample the same latents without needing to chain multiple KSamplers together, and also allows specialized iteration behavior to implement features such as FreeInit.

Default Iteration Options

Simply re-runs the KSampler, plugging in the output of the previous iteration into the next one. At the dafault iterations=1, it is no different than not having this node plugged in at all.

Node Inputs
image 🟦iterations: Total amount of times KSampler should run back-to-back.
🟦iter_batch_offset: batch_offset to apply on each subsequent iteration.
🟦iter_seed_offset: seed_offset to apply on each subsequent iteration.

FreeInit Iteration Options

Implements FreeInit, which is the idea that AnimateDiff was trained on latents of existing videos (images with temporal coherence between them) that were then noised rather than from random initial noise, and that when noising existing latents, low-frequency data still remains in the noised latents. It combines the low-frequency noise from existing videos (or, as is the default behavior, the previous iteration) with the high-frequency noise in randomly generated noise to run the subsequent iterations. Each iteration is a full sample - 2 iterations means it will take twice as long to run as compared to having 1 iteration/no iteration_opts connected.

When apply_to_1st_iter is False, the noising/low-freq/high-freq combination will not occur on the first iteration, with the assumption that there are no useful latents passed in to do the noise combining in the first place, thus requiring at least 2 iterations for FreeInit to take effect.

If you have an existing set of latents to use to get low-freq noise from, you may set apply_to_1st_iter to True, and then even if you set iterations=1, FreeInit will still take effect.

Node
image

Inputs

  • 🟦iterations: Total amount of times KSampler should run back-to-back. Refer to explanation above why it is 2 by default (and when it can be set to 1 instead).

  • 🟦init_type: Code implementation for applying FreeInit.

    • FreeInit [sampler sigma]: likely closest to intended implementation, and gets the sigma for noising from the sampler instead of the model (when possible).
    • FreeInit [model sigma]: gets sigma for noising from the model; when using Custom KSampler, this is the method that will be used for both FreeInit options.
    • DinkInit_v1: my initial, flawed implementation of FreeInit before I figured out how to exactly copy the noising behavior. By sheer luck and trial and error, I managed to have it actually sort of work with this method. Mainly for backwards compatibility now, but might produce useful results too.
  • 🟦apply_to_1st_iter: When set to True, will do FreeInit low-freq/high-freq combo work even on the 1st iteration it runs Refer to explanation in the above FreeInit Iteration Options section for when this can be set to True.

  • 🟦init_type: Code implementation for applying FreeInit.

  • 🟦iter_batch_offset: batch_offset to apply on each subsequent iteration.

  • 🟦iter_seed_offset: seed_offset to apply on each subsequent iteration. Defaults to 1 so that new random noise is used for each iteration.

  • 🟦filter: Determines low-freq filter to apply to noise. Very technical, look into code/online resources to figure out how the individual filters act.

  • 🟦d_s: Spatial parameter of filter (within latents, I think); very technical. Look into code/online resources if you wish to know what exactly it does.

  • 🟦d_t: Temporal parameter of filter (across latents, I think); very technical. Look into code/online resources if you wish to know what exactly it does.

  • 🟦n_butterworth: Only applies to butterworth filter; very technical. Look into code/online resources if you wish to know what exactly it does.

  • 🟦sigma_step: Noising step to use/emulate when noising latents to then get low-freq noise out of. 999 actually means last (-1), and any number under 999 will mean the distance away from last. Leave at 999 unless you know what you're trying to do with it.

Noise Layers

These nodes allow initial noise to be added onto, weighted, or replaced. In near future, I will add the ability for masks to 'move' the noise relative to the masks' movement instead of just 'cutting and pasting' the noise.

The inputs that are shared with Sample Settings have the same exact effect - only new option is in seed_gen_override, which by default will use same seed_gen as Sample Settings (use existing). You can make a noise layer use a different seed_gen strategy at will, or use a different seed/set of seeds, etc.

The mask_optional parameter determines where on the initial noise the noise layer should be applied.

Node Behavior + Inputs
image [Add]; Adds noise directly on top.
🟦noise_weight: Multiplier for noise layer before being added on top.
image [Add Weighted]; Adds noise, but takes a weighted average between what is already there and itself.
🟦noise_weight: Weight of new noise in the weighted average with existing noise.
🟦balance_multipler: Scale for how much noise_weight should affect existing noise; 1.0 means normal weighted average, and below 1.0 will lessen the weighted reduction by that amount (i.e. if balance_multiplier is set to 0.5 and noise_weight is 0.25, existing noise will only be reduced by 0.125 instead of 0.25, but new noise will be added with the unmodified 0.25 weight).
image [Replace]; Directly replaces existing noise from layers underneath with itself.