Progress updates

[DragonfruitQuirky]

Anyway to get progress updates?

I see this in the task queue code but there is no way to hook into it?

                                elif msg['type'] == 'progress':
                                    # See ComfyUI::main.hijack_progress
                                    # 'prompt_id', 'node': https://github.com/comfyanonymous/ComfyUI/issues/2425
                                    progress_data = msg['data']
                                    # TODO: Node
                                    value = progress_data['value']
                                    max = progress_data['max']
                                    if value == 1:
                                        if pbar is not None:
                                            pbar.close()
                                        pbar = tqdm(initial=value, total=max)
                                    else:
                                        # value may not start with 1
                                        # e.g. start watch in the middle, CivitAICheckpointLoader
                                        if pbar is None:
                                            pbar = tqdm(initial=value, total=max)
                                        pbar.update(value - pbar.n)
                                        if value == max:
                                            pbar.close()
                                            pbar = None

[Chaoses-Ib]

I've only added hook for preview images (#36). I wanted to unify them into one, but the problem is preview and progress are seperate messages in ComfyUI. I'm not sure it is possible to unify them without letting the user specify if there will be preview or not.

For now, you can use ComfyUI's built-in hook directly, if you are using in-process ComfyUI server:

from comfy_script.runtimeimport *
# load()
load(args=ComfyUIArgs('--preview-method', 'auto'))
from comfy_script.runtime.nodes import *

import comfy.utils

def hook(value, total, preview_image):
    print(value, total, preview_image)
comfy.utils.set_progress_bar_global_hook(hook)

with Workflow() as wf:
    model, clip, vae = CheckpointLoaderSimple('v1-5-pruned-emaonly.ckpt')
    conditioning = CLIPTextEncode('beautiful scenery nature glass bottle landscape, , purple galaxy bottle,', clip)
    conditioning2 = CLIPTextEncode('text, watermark', clip)
    latent = EmptyLatentImage(512, 512, 1)
    latent = KSampler(model, 4, 20, 8, 'euler', 'normal', conditioning, conditioning2, latent, 1)
    image = VAEDecode(latent, vae)
    image = SaveImage(image, 'ComfyUI')
'''
1 20 ('JPEG', <PIL.Image.Image image mode=RGB size=64x64 at 0x27228632CE0>, 512)
2 20 ('JPEG', <PIL.Image.Image image mode=RGB size=64x64 at 0x27228632BC0>, 512)
3 20 ('JPEG', <PIL.Image.Image image mode=RGB size=64x64 at 0x27228633AC0>, 512)
...
18 20 ('JPEG', <PIL.Image.Image image mode=RGB size=64x64 at 0x272286489D0>, 512)
19 20 ('JPEG', <PIL.Image.Image image mode=RGB size=64x64 at 0x27228648D90>, 512)
20 20 ('JPEG', <PIL.Image.Image image mode=RGB size=64x64 at 0x27228728400>, 512)
'''

[DragonfruitQuirky]

Oh, ok! Thanks!

[Chaoses-Ib]

Anyway, I've added callback for progress now. Example:

queue.watch_display(False)

with Workflow() as wf:
    model, clip, vae = CheckpointLoaderSimple(Checkpoints.v1_5_pruned_emaonly)
    latent = KSampler(model, steps=10, positive=CLIPTextEncode('1girl', clip), negative=CLIPTextEncode('watermark', clip), latent_image=EmptyLatentImage())
    image = VAEDecode(latent, vae)
    SaveImage(image)

def progress_callback(progress: TaskProgress):
    print(progress.node_id, progress.value, progress.max)
wf.task.add_progress_callback(progress_callback)
"""
KSampler.0 1 10
KSampler.0 2 10
...
KSampler.0 10 10
"""

[DragonfruitQuirky]

Nice! Thank you so much!! 😁