Update README.md - more changes
This commit is contained in:
Jedrzej Kosinski
@@ -32,11 +32,11 @@ The two core concepts for scheduling are ***Timestep Keyframes*** and ***Latent
|
||||
The ControlNet nodes provided here are the ***Apply Advanced ControlNet*** and ***Load Advanced ControlNet Model*** (or diff) nodes. The vanilla ControlNet nodes are also compatible, and can be used almost interchangeably - the only difference is that **at least one of these nodes must be used** for Advanced versions of ControlNets to be used (important for sliding context sampling, like with AnimateDiff-Evolved).
|
||||
|
||||
Key:
|
||||
|
||||
- 🟩 - required inputs
|
||||
- 🟨 - optional inputs
|
||||
- 🟥 - optional input/output, but not recommended to use unless needed
|
||||
- 🟦 - start as widgets, can be converted to inputs
|
||||
- 🟥 - optional input/output, but not recommended to use unless needed
|
||||
- 🟪 - output
|
||||
|
||||
## Apply Advanced ControlNet
|
||||
|
||||
@@ -57,8 +57,8 @@ Same functionality as the vanilla Apply Advanced ControlNet (Advanced) node, exc
|
||||
- 🟦***stop_percent***: sampling step percentage at which controlnet should stop being applied - no matter what start_percent is set on timestep keyframes, they won't take effect once this end_percent is reached.
|
||||
|
||||
### Outputs
|
||||
- ***positive***: conditioning (positive) with applied controlnets
|
||||
- ***negative***: conditioning (negative) with applied controlnets
|
||||
- 🟪***positive***: conditioning (positive) with applied controlnets
|
||||
- 🟪***negative***: conditioning (negative) with applied controlnets
|
||||
|
||||
## Load Advanced ControlNet Model
|
||||
|
||||
@@ -70,6 +70,40 @@ Loads a ControlNet model and converts it into an Advanced version that supports
|
||||
- 🟨***model***: model to plug into the diff version of the node. Some controlnets are designed for receive the model; if you don't know what this does, you probably don't want tot use the diff version of the node.
|
||||
|
||||
### Outputs
|
||||
- 🟪***CONTROL_NET***: loaded Advanced ControlNet
|
||||
|
||||
## Timestep Keyframe
|
||||
|
||||
|
||||
Scheduling node across timesteps (sampling steps) based on the set start_percent. Chaining Timestep Keyframes allows ControlNet scheduling across sampling steps (percentage-wise), through a timestep keyframe schedule.
|
||||
|
||||
### Inputs
|
||||
- 🟨***prev_timestep_keyframe***: used to chain Timestep Keyframes together to create a schedule. The order does not matter - the Timestep Keyframes sort themselves automatically by their start_percent. *Any Timestep Keyframe contained in the prev_timestep_keyframe that contains the same start_percent as the Timestep Keyframe will be overwritten.*
|
||||
- 🟨***control_net_weights***: weights to apply to controlnet while this Timestep Keyframe is in effect. Must be compatible with the loaded controlnet, or will throw an error explaining what weight types are compatible. If inherit_missing is True, if no control_net_weight is passed in, will attempt to reuse the last-used weights in the timestep keyframe schedule. *If Apply Advanced ControlNet node has a weight_override, the weight_override will be used during sampling instead of control_net_weight.*
|
||||
- 🟨***latent_keyframe***: latent keyframes to apply to controlnet while this Timestep Keyframe is in effect. If inherit_missing is True, if no latent_keyframe is passed in, will attempt to reuse the last-used weights in the timestep keyframe schedule. *If Apply Advanced ControlNet node has a latent_kf_override, the latent_lf_override will be used during sampling instead of latent_keyframe.*
|
||||
- 🟨***mask_optional***: attention masks to apply to controlnets; basically, decides what part of the image the controlnet to apply to (and the relative strength, if the mask is not binary). Same as mask_optional on the Apply Advanced ControlNet node, can apply either one maks to all latents, or individual masks for each latent. If inherit_missing is True, if no mask_optional is passed in, will attempt to reuse the last-used mask_optional in the timestep keyframe schedule. It is NOT overriden by mask_optional on the Apply Advanced ControlNet node; will be used together.
|
||||
- 🟦***start_percent***: sampling step percentage at which this Timestep Keyframe qualifies to be used. Acts as the 'key' for the Timestep Keyframe in the timestep keyframe schedule.
|
||||
- 🟦***strength***: strength of the controlnet; multiplies the controlnet by this value, basically, applied alongside the strength on the Apply ControlNet node. If set to 0.0 will not have any effect during the duration of this Timestep Keyframe's effect, and will increase sampling speed by not doing any work.
|
||||
- 🟦***null_latent_kf_strength***: strength to assign to latents that are unaccounted for in the passed in latent_keyframes. Has no effect if no latent_keyframes are passed in, or no batch_indeces are unaccounted in the latent_keyframes for during sampling.
|
||||
- 🟦***inherit_missing***: determines if should reuse values from previous Timestep Keyframes for optional values (control_net_weights, latent_keyframe, and mask_option) that are not included on this TimestepKeyframe. To inherit only specific inputs, use default inputs.
|
||||
- 🟦***guarantee_usage***: when true, even if a Timestep Keyframe's start_percent ahead of this one in the schedule is closer to current sampling percentage, this Timestep Keyframe will still be used for one step before moving on to the next selected Timestep Keyframe in the following step. Whether the Timestep Keyframe is used or not, its inputs will still be accounted for inherit_missing purposes.
|
||||
|
||||
### Outputs
|
||||
- 🟪***TIMESTEP_KF***: the created Timestep Keyframe, that can either be linked to another or into a Timestep Keyframe input.
|
||||
|
||||
## Latent Keyframe
|
||||
|
||||
|
||||
A singular Latent Keyframe, selects the strength for a specific batch_index. If batch_index is not present during sampling, will simply have no effect. Can be chained with any other Latent Keyframe-type node to create a latent keyframe schedule.
|
||||
|
||||
### Inputs
|
||||
- 🟨***prev_latent_keyframe***: used to chain Latent Keyframes together to create a schedule. *If a Latent Keyframe contained in prev_latent_keyframes have the same batch_index as this Latent Keyframe, they will take priority over this node's value.*
|
||||
- 🟦***batch_index***: index of latent in batch to apply controlnet strength to. Acts as the 'key' for the Latent Keyframe in the latent keyframe schedule.
|
||||
- 🟦***strength***: strength of controlnet to apply to the corresponding latent.
|
||||
|
||||
### Outputs
|
||||
|
||||
|
||||
|
||||
## Workflows
|
||||
|
||||
|
||||
Reference in New Issue
Block a user