docs: sync all documentation with final implementation#30
docs: sync all documentation with final implementation#30melroyanthony merged 4 commits intomainfrom
Conversation
10 fixes applied across 14 files: 1. Test count 15 → 18 everywhere (README, CHANGELOG, CI, checkpoints) 2. ADR-004: K_cap=min → K_max=max (superseded by ADR-006 mixed-K) 3. data-flow.md: K_cap → K_max 4. README.md: benchmark results updated to current latencies 5. CHANGELOG.md: test count, ADR-004/005/006, new tests, latencies 6. workspace.dsl: granularity "(w, h)" → "(w, h, k)" 7. security-model.md: Track B Gemini API HTTPS calls documented 8. ADR-003: Python → Rust/Python, cost-based epsilon noted 9. system-design.md: removed draft text, fixed bench 17 ops 96→103 10. database-schema.md: bench 13 tensors 96→100
There was a problem hiding this comment.
Pull request overview
Documentation-only sync to reflect the current “final” implementation across both Track A (Rust) and Track B (Python), including mixed‑K behavior, updated benchmark scale numbers, and updated test counts.
Changes:
- Update docs from
K_cap = min(K_full)toK_max = max(K_full)for mixed‑K granularity search semantics. - Refresh benchmark metadata/results (ops/tensors counts, latency figures, subgraph counts) and remove outdated/draft explanatory text.
- Update reported Rust unit test count from 15 → 18 across docs and CI labels.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| solution/docs/decisions/ADR-004-k-dimension-search.md | Updates k-search cap to K_max and notes partial supersession by ADR‑006 mixed‑K model. |
| solution/docs/decisions/ADR-003-greedy-fusion.md | Updates benchmark scale references and adds cost-based fusion addendum with epsilon discussion. |
| solution/docs/architecture/workspace.dsl | Updates granularity search description to (w, h, k). |
| solution/docs/architecture/system-design.md | Updates benchmark scale numbers and refines retained-tensor working-set explanation. |
| solution/docs/architecture/security-model.md | Documents Track B Gemini API usage and environment-variable behavior. |
| solution/docs/architecture/database-schema.md | Updates benchmark tensor counts in schema documentation. |
| solution/docs/architecture/data-flow.md | Updates diagrams/notes to use K_max granularity candidate cap. |
| solution/checkpoints/stage-4-validation.md | Updates Rust test totals and lists new test coverage areas/names. |
| solution/README.md | Updates Rust test count and refreshes benchmark latency/subgraph summary table. |
| solution/CHANGELOG.md | Updates test counts, ADR list, and benchmark results table. |
| .github/workflows/ci.yml | Updates the CI step label for the Rust test count (15 → 18). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
- ADR-003: N=96 → N=103 for consistency - ADR-003: epsilon wording — merge requires lat_fused < lat_split - eps (rejects borderline, not accepts) - security-model.md: note error-path response preview to stderr - stage-4-validation.md: fix test name to match actual function name - CHANGELOG.md: fix test names to include test_ prefix and full names
There was a problem hiding this comment.
Pull request overview
This PR syncs project documentation to reflect the final scheduler implementation across both Track A (Rust) and Track B (Python agent), including mixed‑K support, updated benchmark sizes, updated benchmark results, and updated test counts.
Changes:
- Updates ADRs and architecture docs to reflect mixed‑K fusion (
K_max = max(K_full)), cost-based fusion, and (w,h,k) granularity search. - Refreshes benchmark metadata (ops/tensors counts) and reported Track A latency results in README/CHANGELOG.
- Updates validation/test-count references (15 → 18 Rust tests) and related CI labeling.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| solution/docs/decisions/ADR-004-k-dimension-search.md | Updates k-search decision to K_max=max(K_full) and notes partial supersession by ADR-006. |
| solution/docs/decisions/ADR-003-greedy-fusion.md | Updates benchmark 17 op count and adds cost-based fusion w/ epsilon tolerance note. |
| solution/docs/architecture/workspace.dsl | Updates granularity search description from (w,h) to (w,h,k). |
| solution/docs/architecture/system-design.md | Updates scale estimates and refines retained-tensor working set explanation; updates benchmark table counts. |
| solution/docs/architecture/security-model.md | Documents Track B Gemini API network behavior and error-path response previews. |
| solution/docs/architecture/database-schema.md | Updates benchmark tensor/op counts in the input profile table. |
| solution/docs/architecture/data-flow.md | Updates diagrams to use K_max terminology for k-candidate generation. |
| solution/checkpoints/stage-4-validation.md | Updates Rust test counts and lists the 3 new Rust tests. |
| solution/README.md | Updates Rust test count and refreshes benchmark results table (latency + subgraphs). |
| solution/CHANGELOG.md | Updates test count, ADR list, and benchmark results table (latency + subgraphs). |
| .github/workflows/ci.yml | Renames Rust test step to reflect 18 tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
- ADR-004: k candidates by "repeated integer halving" not "powers of 2" - data-flow.md: same halving wording in diagram and flowchart - security-model.md: clarify Track B transmits problem/solution to Gemini - README.md: "optimizer runs in under 1 second" (not ambiguous "complete") - ci.yml: removed hardcoded test count from step name
There was a problem hiding this comment.
Pull request overview
This PR updates repository documentation to match the finalized scheduler implementation (mixed‑K granularity search, cost-based fusion behavior, updated benchmark sizes/results, and updated test counts), without changing any code.
Changes:
- Sync documentation references from
K_cap = min(K_full)toK_max = max(K_full)and update granularity-search wording to reflect mixed‑K execution. - Update benchmark metadata/results across docs (ops/tensors counts and reported latencies) and refresh test counts (15 → 18 Rust tests).
- Clarify Track B (Python agent) operational/security implications when
GOOGLE_API_KEYenables Gemini API calls.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| solution/docs/decisions/ADR-004-k-dimension-search.md | Updates ADR to reflect mixed‑K model and K_max upper bound; adds superseded note. |
| solution/docs/decisions/ADR-003-greedy-fusion.md | Updates benchmark op counts; adds cost-based fusion + epsilon tolerance explanation. |
| solution/docs/architecture/workspace.dsl | Updates granularity component description to include k in (w,h,k) search. |
| solution/docs/architecture/system-design.md | Updates benchmark scale numbers and refines retained-tensor working set explanation. |
| solution/docs/architecture/security-model.md | Documents Track B Gemini network behavior, data transmission, and error-path response previews. |
| solution/docs/architecture/database-schema.md | Updates benchmark tensor/op counts in the referenced table. |
| solution/docs/architecture/data-flow.md | Updates diagrams to use K_max and “repeated halving” wording for k candidates. |
| solution/checkpoints/stage-4-validation.md | Updates Rust test counts and lists the 3 additional Rust tests. |
| solution/README.md | Updates test counts and refreshes benchmark latency/subgraph table + runtime wording. |
| solution/CHANGELOG.md | Updates test counts, ADR list, and benchmark results table. |
| .github/workflows/ci.yml | Removes hard-coded test count from the CI step name. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
There was a problem hiding this comment.
Pull request overview
Synchronizes project documentation with the current “final” implementation across both Track A (Rust) and Track B (Python agent), updating stale benchmark/test counts and architecture/ADR details without changing code.
Changes:
- Updates ADRs and architecture docs to reflect mixed‑K behavior (
K_max), cost-based fusion with epsilon tolerance, and granularity search over(w,h,k). - Refreshes benchmark metadata/results tables (ops/tensors counts and reported latencies) and test-suite counts (15 → 18 Rust tests).
- Clarifies Track B’s Gemini API network behavior and associated security considerations.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| solution/docs/decisions/ADR-004-k-dimension-search.md | Marks ADR partially superseded; updates k-search cap to K_max and clarifies mixed‑K execution semantics. |
| solution/docs/decisions/ADR-003-greedy-fusion.md | Updates benchmark size references; documents cost-based fusion criterion + epsilon tolerance. |
| solution/docs/architecture/workspace.dsl | Updates granularity-search description to include (w,h,k). |
| solution/docs/architecture/system-design.md | Updates scale estimates and benchmark table counts; removes/cleans draft reasoning in retained-tensor section. |
| solution/docs/architecture/security-model.md | Documents Track B Gemini HTTPS calls, data transmitted, and error-path response preview behavior. |
| solution/docs/architecture/database-schema.md | Updates benchmark 13 tensor count (to match current benchmark definition). |
| solution/docs/architecture/data-flow.md | Updates diagrams/labels from K_cap/min to K_max/max and halving rule. |
| solution/checkpoints/stage-4-validation.md | Updates Rust test counts and enumerates the 3 additional Rust tests; updates totals accordingly. |
| solution/README.md | Updates Rust test counts and refreshes benchmark latency/subgraph summary table + wording. |
| solution/CHANGELOG.md | Updates test counts, ADR list, benchmark results table, and lists new Rust tests explicitly. |
| .github/workflows/ci.yml | Removes hard-coded unit test count from CI step name to avoid future staleness. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
Summary
Comprehensive documentation sync — fixes 10 categories of staleness across 14 files.
Fixes
All 18 Rust tests passing. No code changes.