ComfyUI/comfy
guill 5cfe38f41c
Execution Model Inversion (#2666)
* Execution Model Inversion

This PR inverts the execution model -- from recursively calling nodes to
using a topological sort of the nodes. This change allows for
modification of the node graph during execution. This allows for two
major advantages:

    1. The implementation of lazy evaluation in nodes. For example, if a
    "Mix Images" node has a mix factor of exactly 0.0, the second image
    input doesn't even need to be evaluated (and visa-versa if the mix
    factor is 1.0).

    2. Dynamic expansion of nodes. This allows for the creation of dynamic
    "node groups". Specifically, custom nodes can return subgraphs that
    replace the original node in the graph. This is an incredibly
    powerful concept. Using this functionality, it was easy to
    implement:
        a. Components (a.k.a. node groups)
        b. Flow control (i.e. while loops) via tail recursion
        c. All-in-one nodes that replicate the WebUI functionality
        d. and more
    All of those were able to be implemented entirely via custom nodes,
    so those features are *not* a part of this PR. (There are some
    front-end changes that should occur before that functionality is
    made widely available, particularly around variant sockets.)

The custom nodes associated with this PR can be found at:
https://github.com/BadCafeCode/execution-inversion-demo-comfyui

Note that some of them require that variant socket types ("*") be
enabled.

* Allow `input_info` to be of type `None`

* Handle errors (like OOM) more gracefully

* Add a command-line argument to enable variants

This allows the use of nodes that have sockets of type '*' without
applying a patch to the code.

* Fix an overly aggressive assertion.

This could happen when attempting to evaluate `IS_CHANGED` for a node
during the creation of the cache (in order to create the cache key).

* Fix Pyright warnings

* Add execution model unit tests

* Fix issue with unused literals

Behavior should now match the master branch with regard to undeclared
inputs. Undeclared inputs that are socket connections will be used while
undeclared inputs that are literals will be ignored.

* Make custom VALIDATE_INPUTS skip normal validation

Additionally, if `VALIDATE_INPUTS` takes an argument named `input_types`,
that variable will be a dictionary of the socket type of all incoming
connections. If that argument exists, normal socket type validation will
not occur. This removes the last hurdle for enabling variant types
entirely from custom nodes, so I've removed that command-line option.

I've added appropriate unit tests for these changes.

* Fix example in unit test

This wouldn't have caused any issues in the unit test, but it would have
bugged the UI if someone copy+pasted it into their own node pack.

* Use fstrings instead of '%' formatting syntax

* Use custom exception types.

* Display an error for dependency cycles

Previously, dependency cycles that were created during node expansion
would cause the application to quit (due to an uncaught exception). Now,
we'll throw a proper error to the UI. We also make an attempt to 'blame'
the most relevant node in the UI.

* Add docs on when ExecutionBlocker should be used

* Remove unused functionality

* Rename ExecutionResult.SLEEPING to PENDING

* Remove superfluous function parameter

* Pass None for uneval inputs instead of default

This applies to `VALIDATE_INPUTS`, `check_lazy_status`, and lazy values
in evaluation functions.

* Add a test for mixed node expansion

This test ensures that a node that returns a combination of expanded
subgraphs and literal values functions correctly.

* Raise exception for bad get_node calls.

* Minor refactor of IsChangedCache.get

* Refactor `map_node_over_list` function

* Fix ui output for duplicated nodes

* Add documentation on `check_lazy_status`

* Add file for execution model unit tests

* Clean up Javascript code as per review

* Improve documentation

Converted some comments to docstrings as per review

* Add a new unit test for mixed lazy results

This test validates that when an output list is fed to a lazy node, the
node will properly evaluate previous nodes that are needed by any inputs
to the lazy node.

No code in the execution model has been changed. The test already
passes.

* Allow kwargs in VALIDATE_INPUTS functions

When kwargs are used, validation is skipped for all inputs as if they
had been mentioned explicitly.

* List cached nodes in `execution_cached` message

This was previously just bugged in this PR.
2024-08-15 11:21:11 -04:00
..
cldm "auto" type is only relevant to the SetUnionControlNetType node. 2024-07-22 11:30:38 -04:00
extra_samplers Cleanup uni_pc inpainting. 2024-02-23 02:39:35 -05:00
k_diffusion Switch to the real cfg++ method in the samplers. 2024-06-29 11:59:48 -04:00
ldm Fix issue. 2024-08-14 02:51:47 -04:00
sd1_tokenizer Initial commit. 2023-01-16 22:37:14 -05:00
t2i_adapter Controlnet refactor. 2024-06-27 18:43:11 -04:00
taesd Improvements to the TAESD3 implementation. 2024-06-16 02:04:24 -04:00
text_encoders Correct spelling 'token_weight_pars_t5' to 'token_weight_pairs_t5' (#4200) 2024-08-04 17:10:02 -04:00
caching.py Execution Model Inversion (#2666) 2024-08-15 11:21:11 -04:00
checkpoint_pickle.py Remove pytorch_lightning dependency. 2023-06-13 10:11:33 -04:00
cli_args.py Execution Model Inversion (#2666) 2024-08-15 11:21:11 -04:00
clip_config_bigg.json Fix potential issue with non clip text embeddings. 2024-07-30 14:41:13 -04:00
clip_model.py Lower CLIP memory usage by a bit. 2024-07-31 01:32:35 -04:00
clip_vision_config_g.json Add support for clip g vision model to CLIPVisionLoader. 2023-08-18 11:13:29 -04:00
clip_vision_config_h.json Add support for unCLIP SD2.x models. 2023-04-01 23:19:15 -04:00
clip_vision_config_vitl_336.json support clip-vit-large-patch14-336 (#4042) 2024-07-17 13:12:50 -04:00
clip_vision_config_vitl.json Add support for unCLIP SD2.x models. 2023-04-01 23:19:15 -04:00
clip_vision.py support clip-vit-large-patch14-336 (#4042) 2024-07-17 13:12:50 -04:00
conds.py Fix bug with cosxl edit model. 2024-06-10 16:00:03 -04:00
controlnet.py xlabs Flux controlnet implementation. (#4260) 2024-08-12 21:22:22 -04:00
diffusers_convert.py Fix saving text encoder in fp8. 2024-04-02 11:46:34 -04:00
diffusers_load.py load_unet -> load_diffusion_model with a model_options argument. 2024-08-12 23:20:57 -04:00
gligen.py Fix gligen lowvram mode. 2024-02-18 02:20:23 -05:00
graph_utils.py Execution Model Inversion (#2666) 2024-08-15 11:21:11 -04:00
graph.py Execution Model Inversion (#2666) 2024-08-15 11:21:11 -04:00
latent_formats.py Fast preview support for Flux. 2024-08-01 16:28:11 -04:00
lora.py Implement text encoder part of HunyuanDiT loras. 2024-08-09 03:21:10 -04:00
model_base.py Add a way to set model dtype and ops from load_checkpoint_guess_config. 2024-08-11 08:50:34 -04:00
model_detection.py Fix issues with #4302 and support loading diffusers format flux. 2024-08-10 21:28:24 -04:00
model_management.py Fix bug when model cannot be partially unloaded. 2024-08-13 03:57:55 -04:00
model_patcher.py Fix some issues with TE being in lowvram mode. 2024-08-12 23:42:21 -04:00
model_sampling.py Basic Flux Schnell and Flux Dev model implementation. 2024-08-01 09:49:29 -04:00
ops.py Lower T5 memory usage by a few hundred MB. 2024-07-31 00:52:34 -04:00
options.py Only parse command line args when main.py is called. 2023-09-13 11:38:20 -04:00
sample.py Reshape the empty latent image to the right amount of channels if needed. 2024-06-08 02:35:08 -04:00
sampler_helpers.py Make ComfyUI split batches a higher priority than weight offload. 2024-08-01 16:39:59 -04:00
samplers.py More aggressive batch splitting. 2024-08-03 11:53:30 -04:00
sd1_clip_config.json Fix potential issue with non clip text embeddings. 2024-07-30 14:41:13 -04:00
sd1_clip.py Fix bundled embed. 2024-08-07 13:30:45 -04:00
sd.py Fix some issues with TE being in lowvram mode. 2024-08-12 23:42:21 -04:00
sdxl_clip.py Let tokenizers return weights to be stored in the saved checkpoint. 2024-07-25 10:52:09 -04:00
supported_models_base.py Add a way to set model dtype and ops from load_checkpoint_guess_config. 2024-08-11 08:50:34 -04:00
supported_models.py Try to fix SDXL OOM issue on some configurations. 2024-08-14 23:08:54 -04:00
types.py Fix UnetParams annotation typo (#3589) 2024-05-27 19:30:35 -04:00
utils.py Fix issues with #4302 and support loading diffusers format flux. 2024-08-10 21:28:24 -04:00