00d38181b2
* docs: verify and complete project documentation (#31) Align the docs with the shipped V1 implementation (MASTER_SPEC §7.6, Phase 7). - README: fix the Category Splitter output (it emits a Category Map; the per-category strings are produced by the Prompt Builder). - docs/nodes.md: developer node reference with the exact inputs, outputs, and inter-stage data types for all eight nodes. - CONTRIBUTING.md: link the Knowledge Base contribution guide and validation command, the golden-regeneration note, and the node/benchmark references. - tests/test_docs_consistency.py: guards that README and docs/nodes.md mention every registered node and cover the inter-stage types, and that CONTRIBUTING links the Knowledge Base guide -- so docs cannot drift from the code. The wiki ComfyUI-Nodes page is updated to match (Category Splitter emits a Category Map) in the wiki repository. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> * chore: retrigger CI (runner backlog) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> --------- Co-authored-by: kunail0804 <kunail0804@gmail.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2.7 KiB
2.7 KiB
ComfyUI node reference
The exact inputs, outputs, and data types of the shipped Scene Compiler nodes.
All nodes appear under the Scene Compiler category. Data flows between nodes
as typed objects; the inter-stage types are SCENE, RESOLVED_TAGS,
CATEGORY_MAP, KNOWLEDGE_BASE, and COMPILER_CONFIG.
Nodes are thin adapters: all behaviour lives in the compiler package, which
never imports ComfyUI.
Pipeline nodes
| Node | Inputs | Outputs |
|---|---|---|
| Scene Analyzer | natural_language (STRING), model_name (STRING), temperature (FLOAT), timeout (INT), system_prompt (STRING, optional) |
scene (SCENE), warnings (STRING), errors (STRING) |
| Scene Validator | scene (SCENE), config (COMPILER_CONFIG, optional) |
scene (SCENE), warnings (STRING), errors (STRING) |
| Resolver | scene (SCENE), knowledge_base (KNOWLEDGE_BASE), config (COMPILER_CONFIG, optional) |
resolved_tags (RESOLVED_TAGS), warnings (STRING), errors (STRING) |
| Category Splitter | resolved_tags (RESOLVED_TAGS) |
category_map (CATEGORY_MAP), warnings (STRING), errors (STRING) |
| Prompt Builder | category_map (CATEGORY_MAP), config (COMPILER_CONFIG, optional) |
one STRING per category (character, appearance, hair, face, eyes, expression, body, clothing, accessories, pose, action, interaction, objects, environment, camera, lighting, style, quality, miscellaneous) plus reserved negative and scene (STRING) |
The Category Splitter produces the intermediate Category Map; the per-category prompt strings are produced by the Prompt Builder.
Support nodes
| Node | Inputs | Outputs |
|---|---|---|
| Configuration | one input per configuration option (analyzer, resolver, validator, prompt builder, debug) | config (COMPILER_CONFIG), errors (STRING) |
| Knowledge Base Loader | path (STRING), reload (INT, optional) |
knowledge_base (KNOWLEDGE_BASE), warnings (STRING), errors (STRING) |
| Debug Viewer | scene (SCENE, optional), resolved_tags (RESOLVED_TAGS, optional), category_map (CATEGORY_MAP, optional), warnings (STRING, optional), errors (STRING, optional) |
report (STRING) |
- The Configuration node's
configoutput feeds the optionalconfiginput of the Validator, Resolver, and Prompt Builder, so behaviour changes without rewiring. - The Knowledge Base Loader reloads only when
reloadchanges (no automatic file watching). - The Debug Viewer is read-only; connect any intermediate state to inspect it.
A ready-to-use workflow wiring all of these is in
examples/workflows/scene_compiler_pipeline.json.