docs: clarify save node optional inputs
This commit is contained in:
@@ -75,9 +75,14 @@ Restart ComfyUI after installation.
|
||||
### Quick Start
|
||||
|
||||
1. Add "MetaHub Save Image" node to your workflow
|
||||
2. Connect the `images` output from your decoder/sampler
|
||||
2. Connect only the `images` output from your decoder/sampler
|
||||
3. Generate! The node auto-detects and saves metadata.
|
||||
|
||||
For most workflows, `images` is the only connection you need. The visible
|
||||
`seed`, `steps`, `cfg`, `model_name`, `positive`, `negative`, `vae_name`, and
|
||||
similar sockets are optional overrides. Leave them disconnected unless you want
|
||||
to replace the value that the node detected from the workflow.
|
||||
|
||||
Auto-detected fields:
|
||||
- seed, steps, cfg
|
||||
- sampler and scheduler
|
||||
@@ -86,6 +91,11 @@ Auto-detected fields:
|
||||
- LoRAs + weights
|
||||
- VAE name
|
||||
|
||||
If a workflow uses custom nodes that the extractor cannot understand yet, the
|
||||
image is still saved and the metadata is marked as `partial`. In that case,
|
||||
connect only the missing override sockets you care about, such as `positive`,
|
||||
`seed`, or `model_name`.
|
||||
|
||||
### Override (Optional)
|
||||
|
||||
**Generation Parameters:**
|
||||
@@ -124,7 +134,13 @@ For custom benchmarking, connect these hidden inputs:
|
||||
- `gpu_device_override` - Override GPU device name
|
||||
- `generation_time_override` - Manual generation time (or from Timer node)
|
||||
|
||||
All overrides use `forceInput: True` (hidden from UI, connection-only).
|
||||
All generation-parameter sockets are optional. They use `forceInput: True` so
|
||||
ComfyUI shows them as connection inputs, but they are not required for normal
|
||||
saving. A good default setup is:
|
||||
|
||||
- `VAEDecode.IMAGE` -> `MetaHub Save Image.images`
|
||||
- optional `MetaHub Timer.elapsed_time` -> `generation_time_override`
|
||||
- optional manual overrides only when the console says a field was not detected
|
||||
|
||||
### Filename Pattern
|
||||
Use `filename_pattern` to customize names (default `ComfyUI_%counter%`). Invalid filename characters are sanitized and missing values become `unknown`. `filename_prefix` is deprecated but still supported.
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
[project]
|
||||
name = "imagemetahub-comfyui-save"
|
||||
description = "Official companion node for Image MetaHub. Saves A1111/Civitai-compatible parameters plus extended Image MetaHub metadata (workflow JSON, SHA256 model hashes, VRAM peak/total, GPU device, generation time, and steps/sec) for reproducibility and benchmarking."
|
||||
version = "1.0.7"
|
||||
version = "1.0.8"
|
||||
license = {file = "LICENSE"}
|
||||
# classifiers = [
|
||||
# # For OS-independent nodes (works on all operating systems)
|
||||
|
||||
Reference in New Issue
Block a user