docs: ndarray/nalgebra onboarding, llms.txt conventions, and zero-copy interop - #1655
Merged
Conversation
…y interop (issue #1641) - New getting-started page translating ndarray / nalgebra / ndarray-linalg priors: column-major asymmetry, crate selection, explicit backend values, faer vs BLAS provider decision guide, dot-to-matmul arity, Tensor vs TypedTensor, and zero-copy interop with the measured marginal cost. - llms.txt gains the five-line conventions block, republished skill-reference recipes near the top, warning-shaped trap descriptions, and a link back to the README as the canonical router; README links llms.txt and the recipes. - Skill references gain a borrowing-external-memory recipe (faer/ndarray wrap via TypedTensorView::from_slice) and per-origin traps; mirrors kept in sync. - build_docs_site.sh republishes the skill references; check-docs-site.py asserts README/llms.txt reachability and built-site reference copies.
Contributor
Repository rules reviewRepository rules review (659830c5cad3438b9fdc7705d26b75e97afcca14...44e4e8cb6f931b42817c8644839a81d8be233529) Verdict: pass Findings: - [warn] llm-skipped (External LLM Review) <unknown>: External LLM review was skipped External LLM review is permanently disabled; deterministic checks only. |
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.
Fixes #1641
Rust-native onboarding surface: ndarray/nalgebra priors no longer fall into the silent-transpose trap, llms.txt is actionable at one fetch, and external faer/ndarray memory is wrapped zero-copy.
What changed
docs/getting-started/ndarray-nalgebra-mapping.md(peer ofpytorch-jax-mapping.md): the column-major asymmetry (ndarray row-major dangerous, nalgebra column-major fine), crate-selection entry point, why the backend is an explicit constructed value + the construct-once-reuse idiom, an faer-vs-BLAS decision guide,.dot()→matmularity across the three API tiers,TensorvsTypedTensor, and a zero-copy-interop section stating that adopting tenferro kernels does not require migrating tensor ownership (with the measured +10 crates / +28 s cold build from [Feature]: Guarantee downstream faer and BLAS interop with runnable tutorials #1602).docs/llms.txt, links to the four skill-reference recipes, and the new mapping page — making it the single router to every artifact.TypedTensorView::from_slicewrapping afaer::Matand an ndarray view, plus theTypedTensorViewMut::from_slicewrite-through variant); pitfalls gains per-origin traps (ndarray / nalgebra / PyTorch) and a redirect off the retiredTypedStridedTensorView(Add TypedStridedTensorView for borrowed host strided tensor inputs #886). All mirrors (.claude,.kimi) kept byte-identical.build_docs_site.shrepublishes the skill references;check-docs-site.pyadds reachability assertions (README links llms.txt and the skill; llms.txt links the README) plus a built-site skill-references check, with tests.Verification
python3 scripts/test-check-docs-site.py(new + existing checker tests)python3 scripts/check-doc-snippets.py --check,check-agent-skills.py(snippet/mirror sync)cargo test -p tenferro-tutorial-code(runnable interop snippet + all tutorial binaries)bash scripts/build_docs_site.sh /tmp/tenferro-site-1641— full site build, step [8/9] runs the new checks and passes; acceptance items confirmed (llms.txt lists the mapping page + cheatsheet recipe + README; site servesskill-references/*.mdand the rendered mapping page).bash scripts/check-pr-fast.sh --coverage-reviewed --test 'cargo test -p tenferro-tutorial-code'— passes.repository-rules-review— pass (LLM review skipped, local deterministic review).Independent GPT review of the diff was incorporated (provider-feature additivity and reinterpret-vs-transpose wording corrected; reachability check hardened to parse link targets).