5f2f0b7ff2
The docs had drifted badly: docs/nodes.md still documented the Category Splitter and Prompt Builder (removed in V1.1) and the Knowledge Base Loader (removed in V2.1), gave the Resolver the wrong outputs, and the consistency test actively pinned the retired RESOLVED_TAGS/CATEGORY_MAP types. - README: rewritten around the V2 philosophy shift — 'know more, ask less'. Documents the automatic Knowledge Base growth, the opt-in KB-bounded semantic fallback and the fidelity work (know more), and the configuration centralization, node consolidation (eight nodes -> five) and hidden non-user-facing options (ask less), plus what did not change: determinism. Corrects the tagline (flat prompt, not category-separated) and the node tables. - docs/nodes.md: rewritten for the five shipped nodes with their real inputs and outputs, plus a full Configuration input reference and the settings that are deliberately not exposed. - docs/definition_of_done.md: V1 record marked complete; evidence re-pointed at the code as it stands (no compiler/splitter, compiler/builder). - docs/README.md: MASTER_SPEC reframed as the original design spec (code wins); index the in-repo docs. - examples/README.md: pipeline diagram redrawn for the current graph. - tests/test_docs_consistency.py: stop requiring the retired inter-stage types and add a guard so removed nodes cannot reappear in the reference. Co-authored-by: kunail0804 <kunail0804@gmail.com> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
40 lines
1.6 KiB
Markdown
40 lines
1.6 KiB
Markdown
# Examples
|
|
|
|
Ready-to-use examples for Scene Compiler.
|
|
|
|
## Workflow
|
|
|
|
[`workflows/scene_compiler_pipeline.json`](workflows/scene_compiler_pipeline.json)
|
|
is a ComfyUI workflow wiring the full pipeline:
|
|
|
|
```
|
|
Configuration ─ config ──────────► Scene Analyzer / Scene Validator / Resolver
|
|
└ knowledge_base ───► Resolver
|
|
|
|
Scene Analyzer → Scene Validator → Resolver → prompt
|
|
```
|
|
|
|
The Configuration node supplies every setting *and* loads the Knowledge Base, so it
|
|
is the only node you normally need to touch.
|
|
|
|
Load it in ComfyUI (**Load** → pick the file). The Scene Analyzer requires a local
|
|
[Ollama](https://ollama.com) instance; the rest of the pipeline runs offline.
|
|
|
|
## Scene JSON examples
|
|
|
|
Each `scenes/*.scene.json` is a Scene JSON document (the Analyzer's output form),
|
|
and each matching `scenes/*.prompts.json` is the exact prompt output it compiles
|
|
to with the shipped Knowledge Base and default configuration:
|
|
|
|
| Scene | Highlights |
|
|
|---|---|
|
|
| [`single_character`](scenes/single_character.scene.json) | one character, appearance, clothing, environment, camera, lighting |
|
|
| [`couple_interaction`](scenes/couple_interaction.scene.json) | two characters, an interaction, and an expansion (`school_uniform → blazer, pleated_skirt`) |
|
|
|
|
The `*.prompts.json` outputs are verified by `tests/test_examples.py`. To skip the
|
|
Analyzer and compile a Scene JSON directly, feed it through the Scene Validator →
|
|
Resolver nodes (or the compiler API).
|
|
|
|
> **Note:** the workflow JSON is provided as a starting point; verify it loads in
|
|
> your ComfyUI and re-save if ComfyUI adjusts the layout.
|