ComfyUI/comfy_extras
Jedrzej Kosinski 0ee322ec5f
ModelPatcher Overhaul and Hook Support (#5583)
* Added hook_patches to ModelPatcher for weights (model)

* Initial changes to calc_cond_batch to eventually support hook_patches

* Added current_patcher property to BaseModel

* Consolidated add_hook_patches_as_diffs into add_hook_patches func, fixed fp8 support for model-as-lora feature

* Added call to initialize_timesteps on hooks in process_conds func, and added call prepare current keyframe on hooks in calc_cond_batch

* Added default_conds support in calc_cond_batch func

* Added initial set of hook-related nodes, added code to register hooks for loras/model-as-loras, small renaming/refactoring

* Made CLIP work with hook patches

* Added initial hook scheduling nodes, small renaming/refactoring

* Fixed MaxSpeed and default conds implementations

* Added support for adding weight hooks that aren't registered on the ModelPatcher at sampling time

* Made Set Clip Hooks node work with hooks from Create Hook nodes, began work on better Create Hook Model As LoRA node

* Initial work on adding 'model_as_lora' lora type to calculate_weight

* Continued work on simpler Create Hook Model As LoRA node, started to implement ModelPatcher callbacks, attachments, and additional_models

* Fix incorrect ref to create_hook_patches_clone after moving function

* Added injections support to ModelPatcher + necessary bookkeeping, added additional_models support in ModelPatcher, conds, and hooks

* Added wrappers to ModelPatcher to facilitate standardized function wrapping

* Started scaffolding for other hook types, refactored get_hooks_from_cond to organize hooks by type

* Fix skip_until_exit logic bug breaking injection after first run of model

* Updated clone_has_same_weights function to account for new ModelPatcher properties, improved AutoPatcherEjector usage in partially_load

* Added WrapperExecutor for non-classbound functions, added calc_cond_batch wrappers

* Refactored callbacks+wrappers to allow storing lists by id

* Added forward_timestep_embed_patch type, added helper functions on ModelPatcher for emb_patch and forward_timestep_embed_patch, added helper functions for removing callbacks/wrappers/additional_models by key, added custom_should_register prop to hooks

* Added get_attachment func on ModelPatcher

* Implement basic MemoryCounter system for determing with cached weights due to hooks should be offloaded in hooks_backup

* Modified ControlNet/T2IAdapter get_control function to receive transformer_options as additional parameter, made the model_options stored in extra_args in inner_sample be a clone of the original model_options instead of same ref

* Added create_model_options_clone func, modified type annotations to use __future__ so that I can use the better type annotations

* Refactored WrapperExecutor code to remove need for WrapperClassExecutor (now gone), added sampler.sample wrapper (pending review, will likely keep but will see what hacks this could currently let me get rid of in ACN/ADE)

* Added Combine versions of Cond/Cond Pair Set Props nodes, renamed Pair Cond to Cond Pair, fixed default conds never applying hooks (due to hooks key typo)

* Renamed Create Hook Model As LoRA nodes to make the test node the main one (more changes pending)

* Added uuid to conds in CFGGuider and uuids to transformer_options to allow uniquely identifying conds in batches during sampling

* Fixed models not being unloaded properly due to current_patcher reference; the current ComfyUI model cleanup code requires that nothing else has a reference to the ModelPatcher instances

* Fixed default conds not respecting hook keyframes, made keyframes not reset cache when strength is unchanged, fixed Cond Set Default Combine throwing error, fixed model-as-lora throwing error during calculate_weight after a recent ComfyUI update, small refactoring/scaffolding changes for hooks

* Changed CreateHookModelAsLoraTest to be the new CreateHookModelAsLora, rename old ones as 'direct' and will be removed prior to merge

* Added initial support within CLIP Text Encode (Prompt) node for scheduling weight hook CLIP strength via clip_start_percent/clip_end_percent on conds, added schedule_clip toggle to Set CLIP Hooks node, small cleanup/fixes

* Fix range check in get_hooks_for_clip_schedule so that proper keyframes get assigned to corresponding ranges

* Optimized CLIP hook scheduling to treat same strength as same keyframe

* Less fragile memory management.

* Make encode_from_tokens_scheduled call cleaner, rollback change in model_patcher.py for hook_patches_backup dict

* Fix issue.

* Remove useless function.

* Prevent and detect some types of memory leaks.

* Run garbage collector when switching workflow if needed.

* Moved WrappersMP/CallbacksMP/WrapperExecutor to patcher_extension.py

* Refactored code to store wrappers and callbacks in transformer_options, added apply_model and diffusion_model.forward wrappers

* Fix issue.

* Refactored hooks in calc_cond_batch to be part of get_area_and_mult tuple, added extra_hooks to ControlBase to allow custom controlnets w/ hooks, small cleanup and renaming

* Fixed inconsistency of results when schedule_clip is set to False, small renaming/typo fixing, added initial support for ControlNet extra_hooks to work in tandem with normal cond hooks, initial work on calc_cond_batch merging all subdicts in returned transformer_options

* Modified callbacks and wrappers so that unregistered types can be used, allowing custom_nodes to have their own unique callbacks/wrappers if desired

* Updated different hook types to reflect actual progress of implementation, initial scaffolding for working WrapperHook functionality

* Fixed existing weight hook_patches (pre-registered) not working properly for CLIP

* Removed Register/Direct hook nodes since they were present only for testing, removed diff-related weight hook calculation as improved_memory removes unload_model_clones and using sample time registered hooks is less hacky

* Added clip scheduling support to all other native ComfyUI text encoding nodes (sdxl, flux, hunyuan, sd3)

* Made WrapperHook functional, added another wrapper/callback getter, added ON_DETACH callback to ModelPatcher

* Made opt_hooks append by default instead of replace, renamed comfy.hooks set functions to be more accurate

* Added apply_to_conds to Set CLIP Hooks, modified relevant code to allow text encoding to automatically apply hooks to output conds when apply_to_conds is set to True

* Fix cached_hook_patches not respecting target_device/memory_counter results

* Fixed issue with setting weights from hooks instead of copying them, added additional memory_counter check when caching hook patches

* Remove unnecessary torch.no_grad calls for hook patches

* Increased MemoryCounter minimum memory to leave free by *2 until a better way to get inference memory estimate of currently loaded models exists

* For encode_from_tokens_scheduled, allow start_percent and end_percent in add_dict to limit which scheduled conds get encoded for optimization purposes

* Removed a .to call on results of calculate_weight in patch_hook_weight_to_device that was screwing up the intermediate results for fp8 prior to being passed into stochastic_rounding call

* Made encode_from_tokens_scheduled work when no hooks are set on patcher

* Small cleanup of comments

* Turn off hook patch caching when only 1 hook present in sampling, replace some current_hook = None with calls to self.patch_hooks(None) instead to avoid a potential edge case

* On Cond/Cond Pair nodes, removed opt_ prefix from optional inputs

* Allow both FLOATS and FLOAT for floats_strength input

* Revert change, does not work

* Made patch_hook_weight_to_device respect set_func and convert_func

* Make discard_model_sampling True by default

* Add changes manually from 'master' so merge conflict resolution goes more smoothly

* Cleaned up text encode nodes with just a single clip.encode_from_tokens_scheduled call

* Make sure encode_from_tokens_scheduled will respect use_clip_schedule on clip

* Made nodes in nodes_hooks be marked as experimental (beta)

* Add get_nested_additional_models for cases where additional_models could have their own additional_models, and add robustness for circular additional_models references

* Made finalize_default_conds area math consistent with other sampling code

* Changed 'opt_hooks' input of Cond/Cond Pair Set Default Combine nodes to 'hooks'

* Remove a couple old TODO's and a no longer necessary workaround
2024-12-02 14:51:02 -05:00
..
chainner_models Keep compatibility with some custom nodes. 2024-05-26 15:37:41 -04:00
nodes_advanced_samplers.py Fix SamplerEulerCFGpp node. 2024-07-02 12:21:08 -04:00
nodes_align_your_steps.py Add a denoise value to AlignYourStepsScheduler. 2024-04-27 00:48:41 -04:00
nodes_attention_multiply.py Add some nodes to multiply the attention in UNet and Clip models. 2024-04-28 13:03:43 -04:00
nodes_audio.py Add batch size to EmptyLatentAudio. 2024-09-24 04:32:55 -04:00
nodes_canny.py Remove some unused imports. 2024-05-27 19:08:27 -04:00
nodes_clip_sdxl.py ModelPatcher Overhaul and Hook Support (#5583) 2024-12-02 14:51:02 -05:00
nodes_compositing.py Fix alpha in PorterDuffImageComposite. (#3411) 2024-06-04 16:37:11 -04:00
nodes_cond.py Don't make dynamicPrompts the default on multiline string inputs. 2024-04-13 16:18:00 -04:00
nodes_controlnet.py Make the inpaint controlnet node work with non inpaint ones. 2024-09-14 09:17:13 -04:00
nodes_custom_sampler.py add laplace scheduler [2407.03297] (#4990) 2024-09-19 23:23:09 -04:00
nodes_differential_diffusion.py Fix differential diffusion node for batches. 2024-03-04 00:43:09 -05:00
nodes_flux.py ModelPatcher Overhaul and Hook Support (#5583) 2024-12-02 14:51:02 -05:00
nodes_freelunch.py Move PAG to model_patches/unet section. 2024-07-18 17:22:51 -04:00
nodes_gits.py feat: add gits scheduler (#3769) 2024-06-20 08:12:15 -04:00
nodes_hooks.py ModelPatcher Overhaul and Hook Support (#5583) 2024-12-02 14:51:02 -05:00
nodes_hunyuan.py ModelPatcher Overhaul and Hook Support (#5583) 2024-12-02 14:51:02 -05:00
nodes_hypernetwork.py add simple error check to model loading (#4950) 2024-09-17 03:57:17 -04:00
nodes_hypertile.py Move PAG to model_patches/unet section. 2024-07-18 17:22:51 -04:00
nodes_images.py Increase image batch nodes maximum values. 2024-03-17 08:57:49 -04:00
nodes_ip2p.py Add InstructPixToPixConditioning node. 2024-04-04 15:06:17 -04:00
nodes_latent.py Add missing import. 2024-10-16 14:58:30 -04:00
nodes_lora_extract.py Add tooltips to LoraSave node. 2024-10-18 06:01:09 -04:00
nodes_lt.py set LTX min length to 1 for t2i (#5750) 2024-11-23 21:33:08 -05:00
nodes_mask.py Add a ThresholdMask node. 2024-03-04 00:31:59 -05:00
nodes_mochi.py Move mochi latent node to: latent/video. 2024-11-08 08:33:44 -05:00
nodes_model_advanced.py Fix regression. 2024-11-13 04:24:48 -05:00
nodes_model_downscale.py Move some nodes out of _for_testing. 2024-09-25 08:41:22 -04:00
nodes_model_merging.py CheckpointSave node name. 2024-08-19 15:06:12 -04:00
nodes_model_merging_model_specific.py LTXV model merging node. 2024-11-27 01:43:31 -05:00
nodes_morphology.py Add Morphology nodes from kornia (#2781) 2024-03-04 12:50:28 -05:00
nodes_pag.py Lower SAG scale step for finer control (#4158) 2024-08-02 10:29:03 -04:00
nodes_perpneg.py Set some nodes as DEPRECATED. 2024-09-12 20:27:07 -04:00
nodes_photomaker.py add simple error check to model loading (#4950) 2024-09-17 03:57:17 -04:00
nodes_post_processing.py Speed up Sharpen node. 2024-04-21 09:02:06 -04:00
nodes_rebatch.py Add a RebatchImages node. 2023-12-20 16:22:18 -05:00
nodes_sag.py proper fix for sag. 2024-11-10 00:10:45 -05:00
nodes_sd3.py ModelPatcher Overhaul and Hook Support (#5583) 2024-12-02 14:51:02 -05:00
nodes_sdupscale.py Remove some unused imports. 2024-05-27 19:08:27 -04:00
nodes_slg.py Add a skip layer guidance node that can also skip single layers. 2024-11-18 02:20:43 -05:00
nodes_stable3d.py SV3D support. 2024-03-18 16:54:13 -04:00
nodes_stable_cascade.py Move some nodes out of _for_testing. 2024-09-25 08:41:22 -04:00
nodes_tomesd.py Move some nodes out of _for_testing. 2024-09-25 08:41:22 -04:00
nodes_torch_compile.py Add backend option to TorchCompileModel. 2024-09-27 02:12:37 -04:00
nodes_upscale_model.py add simple error check to model loading (#4950) 2024-09-17 03:57:17 -04:00
nodes_video_model.py Move some nodes out of _for_testing. 2024-09-25 08:41:22 -04:00
nodes_webcam.py Add webcam node (#3497) 2024-05-17 13:16:08 -04:00