Repository navigation
docs: describe the memory model as built, and fold the loose files into Antora - #1106
Merged
Merged
Conversation
…to Antora The storage model, the packed-weight contract and the planning tools were documented in design records under `docs/design/` and in issue threads. Antora is the docs site, so they belong in it. - `explanation/memory-model.adoc` — Storage owns bytes, Format says what they mean, Layout says where they are, Scope says how long they live, and TensorView is what a kernel receives. Mermaid class diagram, the decode-step dispatch flow, the two-pool device check, what the observability stream carries, and the numbers measured on an ARMv8.2 Cortex-A55 board. Known limits are stated, not implied. - `explanation/packed-weight-layout.adoc` — the normative block-order contract: the two orders, where the order lives, how to convert, the load-boundary orientation rule, what a downstream repository consumes, and the five rules. Kdocs and error messages point here. - `how-to/plan-model-memory.adoc` — `skainet plan`, the device profiles, the two-pool fit check, mapped staging on Android, plan-vs-actual. - `explanation/eager-execution.adoc` — the backends-and-kernels map that was a loose Markdown file, now a page with the kernel × provider and platform tables and the current gaps. - `reference/architecture.adoc` — arc42 refreshed: a memory-model building block (§5.3), the runtime view redrawn as two mermaid flows including the view/dispatch path, cross-cutting entries for scoped memory, visible conversions, the block-order contract and the single observability stream, five new decision rows, the memory quality criteria, current risks, and glossary entries. Deleted after folding their content in: `docs/design/memory/` (six records), `docs/eager-execution-backends-and-kernels.md`, and `docs/export/minerva.md` — whose bundle layout and graph-source sections moved into the Minerva how-to. References in kdocs, error messages, README, SKEEP-003 and the kernel matrix now point at the pages. `docs/.docker/README.md` stays: it documents the image next to it. Gate: scripts/pr-gate.sh — all legs passed. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
📖 Documentation Preview The documentation has been built successfully for this PR. Generated Files:
Artifacts:
This comment will be updated automatically when the PR is updated. |
|
📖 Documentation Preview The documentation has been built successfully for this PR. Generated Files:
Artifacts:
This comment will be updated automatically when the PR is updated. |
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
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.
Closes the documentation half of #932: the storage model, the packed-weight contract and the planning tools existed only in design records under
docs/design/and in issue threads. Antora is the docs site, so they belong in it — and the loose Markdown files are gone.New pages
explanation/memory-model.adoc— the model as built:Storageowns bytes,Formatsays what they mean,Layoutsays where they are,Scopesays how long they live, andTensorViewis what a kernel receives. Mermaid class diagram, the decode-step dispatch flow, the two-pool device check, what the observability stream carries, and the numbers measured on an ARMv8.2 Cortex-A55 board. Known limits are stated rather than implied — packed weights still reach the managed heap, mapping is whole-file only.explanation/packed-weight-layout.adoc— the normative block-order contract, promoted from a design record. The two orders, where the order lives, how to convert, the load-boundary orientation rule, what a downstream repository consumes, and the five rules. Kdocs and error messages now point here.how-to/plan-model-memory.adoc—skainet plan, the device profiles, the two-pool fit check, mapped staging on Android, and plan-vs-actual, with real output rather than descriptions of output.explanation/eager-execution.adoc— the backends-and-kernels map that was a loose Markdown file, now a page with the kernel × provider and platform tables and the current gaps.arc42 refreshed
reference/architecture.adocdescribes what is there now:Tensor/TensorDatasit aboveTensorView/Storage/Format/Layout/Scope.KernelKey→ look up → insert a visible adapter → reference kernel).matmulWeightTransposed, andquantPolicy × staging.Diagrams are mermaid throughout, per the repo's offline-mermaid Antora image.
Loose files: folded in, then deleted
docs/design/memory/memory-architecture-proposal.md,…-milestones-prd.mddocs/design/memory/packed-weight-layout.mdexplanation/packed-weight-layout.adocdocs/design/memory/m2-acceptance.md,spike-…,baseline-…docs/eager-execution-backends-and-kernels.mdexplanation/eager-execution.adocdocs/export/minerva.mdhow-to/minerva-export.adocdocs/.docker/README.mdstays — it documents the Docker image sitting next to it, not the product.References in kdocs, error messages,
README.md, SKEEP-003 and the kernel matrix now point at the pages.CHANGELOG.mdkeeps its historical mention, since it records what was true at that release.Gate
scripts/pr-gate.sh— all legs passed (the.ktfiles touched are kdoc and error-message text).🤖 Generated with Claude Code