Repository navigation
docs: align backend guides and buffer lifetimes after remote CXL - #123
Draft
youngrok-XCENA wants to merge 6 commits into
Draft
youngrok-XCENA wants to merge 6 commits into
youngrok-XCENA wants to merge 6 commits into
Conversation
3 of 6 tasks
youngrok-XCENA
marked this pull request as draft
October 23, 2026 08:57
This branch has not been deployed
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.
Summary
After #107, readers encounter conflicting descriptions of CXL mapping, RDMA transfers, worker staging and cache sharing as they move from the homepage to installation, examples and detailed design. Some API and recovery descriptions also promise behavior the current backends do not provide.
Align those guides with the merged implementation, including the actual allocation/store sequence, distinct buffer lifetimes and backend-specific limits. Existing benchmark measurements remain unchanged and are scoped to the configurations actually measured.
Also restore this PR's test dependency installation: the package mirror advertises newer Ruff/virtualenv versions whose wheels return 404, so CI resolves against a known successful dependency snapshot.
Key Changes
cxlandremote_cxlpayload paths in the primary README, homepage and architecture Mermaid diagrams, including GPU copies, worker CPU staging, RDMA and the memory-node agent. Keep directly mapped CXL diagrams under explicit backend headings.cpu/currentmixedstorage from shared-pool reuse, and require compatible immutable weights, namespace, layout and pool for sharing.HOLD, NIC registration, deregistration,UNHOLDand region return. Separate server read leases, local staging leases and RM holds, including keeper retention, revocation of server leases during reclamation, and uncertain cleanup.cxl/ TCP-loopback P2P setup; it does not establishremote_cxlperformance or a general RDMA advantage.Test Plan
pytest -v)sphinx-build -E -W --keep-going -b html docs <output>; all 28 source pages build with zero warnings.git diff --checkpass.The diff contains 31 Markdown files, Sphinx configuration, two Python files with docstring-only edits, and two CI files. Physical-device and serving tests were not rerun. The combined head runs its own CI; the earlier green #125 run establishes the dependency patch's validation history, not a test result for this new head. This PR remains Draft pending user approval.
Related Issues
Follow-up to #107. Includes and supersedes the CI repair previously proposed in #125.
📦 Release Note (for auto-generation / write in English)
NEW
CHANGED
FIXED
IMPORTANT NOTES