Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Agent Notes

`projects/templates/template_active_inference/docs/reference/` is documentation
only — reference lookups, not business logic. Keep logic in `../../src/`,
orchestration in `../../scripts/`, and generated artifacts under `../../output/`.

- **method-inventory.md** must stay in step with the methods actually defined in
`../../src/`; when you add or rename a method/track, update its row here.
- **rendering-reproducibility.md** documents the deterministic render contract
(fixed seeds, pinned inputs); update it when the render pipeline changes.

Every directory under `docs/` carries a `README.md` (user-facing) and an
`AGENTS.md` (this technical note) — the repo's doc-pair lint enforces both.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Reference

Reference material for the Active Inference exemplar — stable lookups that
support the manuscript and the track pipeline.

- [method-inventory.md](method-inventory.md) — catalogue of the analytical /
pymdp / Lean / GNN / ontology methods exercised by the tracks, and where each
is defined in `../../src/`.
- [rendering-reproducibility.md](rendering-reproducibility.md) — how the
manuscript and figures are rendered deterministically (seeds, pinned inputs,
regenerate-from-clean steps).

See the parent [docs/README.md](../README.md) for the full documentation map.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Source Module Notes

`validation_spine/` holds the deterministic artifact contracts for the Active
Inference exemplar. All reusable, tested logic lives here; `../../scripts/`
(e.g. `generate_validation_spine.py`) only parses arguments, resolves paths, and
calls these functions (thin-orchestrator pattern).

- `artifacts.py` writes and validates the artifact-provenance, deterministic
replay, and counterexample-matrix records consumed by the gate tests before
manuscript/output validation.
- Keep every contract deterministic (fixed seeds, no network, no runtime
downloads) so replays are byte-stable.
- The validation spine runs ahead of manuscript/output validation; changes here
must keep the five tracks (prose / formalism / numerics / pymdp / Lean)
concordant.
Loading