Docs/pipeline diagrams and quickstart - #1
Merged
Merged
Conversation
- README: new "## Pipeline" section with a Mermaid stage flowchart; new
"## Quickstart: run the included dataset" walkthrough (mock-echo, no API
key) pointing at tests/scenarios/data/full_pipeline_dataset.jsonl; a
hand-authored Mermaid beam-search candidate tree in the Stage 4 section;
stale eval model names refreshed; datasets note clarifying the appendix
datasets are not in the runnable schema.
- docs/algorithm.md: rewritten from the stale EMOSA/annealing spec to
document the beam search that actually ships (config, candidate tree,
round structure, Pareto/crowding-distance selection, hypervolume
stagnation, convergence).
- docs/architecture.md: reconcile stage numbering (six user-facing vs five
internal), replace the "trunk/leaf branch" framing with single-repo,
beam-only language throughout, fix the stale Prompt Builder registry row,
correct the Review Agent prompt-layer description and file list, drop a
dead .claude/rules link.
- docs/project-overview.md: drop the missing Excalidraw reference, align
stage labels, de-stale the repo-structure tree.
- prompt_builder/search_ops.py, mcp/prompts.py: docstring and comment
wording only ("this repo runs beam" instead of "on this leaf branch").
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Replace the text-heavy per-node flowchart with a simple left-to-right 1→6 stage flow plus a dashed self-loop on stage 4; move the per-stage detail into two short lines of prose. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…tages Replace the single stage-4 self-loop with a subgraph showing the two LLM agents in the loop: Prompt Builder -> Review Agent, with the dashed refine arrow back. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.