From 969fd9e25e509dc0c229d05b593246995846ba26 Mon Sep 17 00:00:00 2001 From: Vito Sansevero Date: Sun, 21 Dec 2025 06:44:14 -0800 Subject: [PATCH] docs: Add Workflow Timer section to README.md --- README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 891ed9f..62e36df 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ Iโ€™m sharing them here with the community, and I hope you find them as useful a | [๐Ÿงน Kiko Purge VRAM](#-kiko-purge-vram) | Intelligent VRAM management with detailed reporting | ๐Ÿ› ๏ธ Utils | | [๐Ÿ“‚ Local Image Loader](#-local-image-loader) | Visual gallery browser for local media files | ๐Ÿ’พ Images | | [๐ŸŒ Model Downloader](#-model-downloader) | Download models from CivitAI, HuggingFace, and custom URLs | ๐Ÿ› ๏ธ Utils | +| [โฑ๏ธ Workflow Timer](#๏ธ-workflow-timer) | Real-time execution timer with customizable display | ๐Ÿ› ๏ธ Utils | ### ๐Ÿงฐ xyz-helpers Tools @@ -405,6 +406,26 @@ Download models, LoRAs, and other assets directly from CivitAI, HuggingFace, and ![Model Downloader Example](examples/workflows/model_downloader_example.png) +#### โฑ๏ธ Workflow Timer +Real-time execution timer that displays workflow duration with millisecond precision. + +- **Live Timing**: Updates in real-time during workflow execution (MM:SS:mmm format) +- **Customizable Color**: Choose your preferred display color via KikoTools settings +- **Glow Effect**: Optional pulsing glow animation (can be enabled/disabled in settings) +- **Global Settings**: Color and glow preferences apply to all timer nodes +- **Persistent Display**: Shows final execution time after workflow completes +- **Multi-Node Sync**: All timer nodes stay synchronized during execution + +**Use Cases:** +- Monitor workflow execution performance +- Compare generation times across different settings +- Identify slow nodes by adding timers at different workflow stages +- Track optimization improvements over time + +**Settings (KikoTools Settings Panel):** +- **Workflow Timer: Color** - Custom color picker for timer display +- **Workflow Timer: Enable Glow** - Toggle pulsing glow effect on/off + ### ๐Ÿ”ค Embedding Autocomplete **Intelligent autocomplete for embeddings, LoRAs, and custom tags in text prompts.** @@ -448,7 +469,7 @@ This feature is an enhanced fork of the autocomplete functionality from [ComfyUI **Intelligent GPU memory management with threshold-based triggering and detailed reporting.** **Key Features:** -- **4 Purge Modes**: +- **4 Purge Modes**: - `soft`: Basic garbage collection and cache clearing - `aggressive`: Multiple GC passes with full CUDA cache clearing - `models_only`: Unload all models and clear model cache @@ -728,6 +749,7 @@ Example workflow available: [xyz_helpers_lora_testing.json](examples/workflows/x | **Text Encode Sampler Params** | Combined text encoding and parameter management | โœ… Complete | [Docs](examples/documentation/text_encode_sampler_params.md) | | **Local Image Loader** | Visual gallery browser for local media files | โœ… Complete | [Docs](examples/documentation/local_image_loader.md) | | **Model Downloader** | Download models from CivitAI, HuggingFace, and custom URLs | โœ… Complete | [Docs](examples/documentation/model_downloader.md) | +| **Workflow Timer** | Real-time execution timer with customizable display | โœ… Complete | [Docs](examples/documentation/workflow_timer.md) | | **Batch Image Processor** | Process multiple images with consistent settings | ๐Ÿšง Planned | Coming Soon | | **Advanced Prompt Utilities** | Enhanced prompt manipulation and generation | ๐Ÿšง Planned | Coming Soon | @@ -1021,7 +1043,7 @@ MIT License - see [LICENSE](LICENSE) file for details. ## ๐Ÿ“ˆ Stats -- **Nodes**: 20 (14 core tools + 6 xyz-helpers) +- **Nodes**: 21 (15 core tools + 6 xyz-helpers) - **Features**: Embedding Autocomplete (settings-based, not a node) - **Categories**: 9 emoji-based categories for better organization - **Download Platforms**: 3 (CivitAI, HuggingFace, Custom URLs)