[Doc] Sync KV event medium terminology after #48123 - #51646
Draft
Alex-ai-future wants to merge 1 commit into
Draft
[Doc] Sync KV event medium terminology after #48123#51646Alex-ai-future wants to merge 1 commit into
Alex-ai-future wants to merge 1 commit into
Conversation
The KV event medium wire contract for filesystem and object-store secondary tiers was collapsed from FS / OBJ to a single coarse-grained STORAGE value in PR vllm-project#48123 (commit 77cba02, merged 2026-07-27). The user-facing docs/features/kv_offloading_usage.md still described FS and OBJ as the medium emitted by each tier, which would mislead any KV event subscriber implementing against the doc. This change updates the doc to: - state that both filesystem and object-store tiers emit medium STORAGE; - point readers at the optional tier locality field (introduced in vllm-project#48281) for location semantics instead of the medium; - drop the ambiguous "OBJ does not imply REMOTE" sub-clause, which mixed tier-type terminology with event-medium terminology; - leave the Filesystem (FS) / Object Store (OBJ) section headings, the type: "fs" / type: "obj" config values, and the NIXL OBJ backend name untouched, since those are tier-type or NIXL-backend identifiers, not event-medium values. Refs: vllm-project#47923, vllm-project#48123, vllm-project#48281 No protocol or runtime code change. Doc-only. Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Alex <jihui.huang@daocloud.io>
Contributor
|
Documentation preview: https://vllm--51646.org.readthedocs.build/en/51646/ |
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
The KV event
mediumwire contract for filesystem and object-store secondary tiers was collapsed from per-tierFS/OBJto a single coarse-grainedSTORAGEvalue in #48123 (commit77cba0259f, merged 2026-07-27). The user-facingdocs/features/kv_offloading_usage.mdstill describedFSandOBJas the medium emitted by each tier, which would mislead any KV event subscriber implementing against the doc.This PR updates the doc to:
medium STORAGE.localityfield (introduced in #48281) for location semantics, instead of the medium."OBJ does not imply REMOTE"sub-clause on the object-storelocalityrow, which mixed tier-type terminology with event-medium terminology.Filesystem (FS)/Object Store (OBJ)section headings, thetype: "fs"/type: "obj"config values, and theNIXL OBJ backendname untouched — those are tier-type or NIXL-backend identifiers, not event-medium values.Why this is not duplicating an existing PR
kv_offloading_usage,MEDIUM_STORAGE,kv event medium, andlocalityturned up no other doc fix targeting this drift. The only open PR touching this same file is#49048("Document SimpleCPUOffloadConnector"), which only adds a new top/bottom section (line 5, line 207+); its diff region is disjoint from this PR's edits at lines 116/130/171.Medium/localityas out of scope and confirms theSTORAGE/localityvalues will not change in the upcoming event path refactor.Changes
docs/features/kv_offloading_usage.mdonly, 5 insertions / 5 deletions across three locations:STORAGE, and redirect readers tolocalityfor location semantics.type: "fs")enable_kv_eventsrow —medium \FS`→medium `STORAGE``.type: "obj")enable_kv_eventsrow —medium \OBJ`→medium `STORAGE`; same row'slocalityentry loses the; OBJ does not imply `REMOTE`` sub-clause (now redundant with the overview wording).Test commands run
AI assistance was used
An AI assistant (Claude) drafted the doc edits, the commit message, and this PR description. All factual claims were verified by reading the code and the cited PRs/commits; no claim in this description or the commit was accepted without evidence.