Skip to content

docs(vllm): consolidate README guidance - #412

Merged
atnair-amd merged 7 commits into
mainfrom
atnair/consolidate-readmes
Sep 11, 2026
Merged

docs(vllm): consolidate README guidance#412
atnair-amd merged 7 commits into
mainfrom
atnair/consolidate-readmes

Conversation

@atnair-amd

@atnair-amd atnair-amd commented Sep 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • reduce the vLLM configuration README to a pointer at the CVS docs, matching the JAX MaxText pattern
  • remove cvs/lib/inference/utils/vllm_benchmark_scripts/README.md; it is unused and has no documentation page
  • remove stale developer markdown that still described the old vLLM schema: cvs/lib/inference/utils/AGENTS.md, docs/cell-key-format.md, docs/derived-metrics.md, cvs/lib/inference/ADDING_A_SUITE.md, and cvs/lib/utils/docs/placeholder-substitution.md

Validation

  • make fmt-check
  • make lint
  • make ut (1,869 tests passed; 1 skipped)
  • verified both linked RST files exist

The directory README duplicated the configuration reference and how-to
pages, so it drifted from them. Point at both instead, matching the
jaxmaxtext config README.
The helper directory carries no published documentation page and nothing
referenced this file.
@atnair-amd
atnair-amd marked this pull request as ready for review September 10, 2026 22:36
Drop the leftover inference-utils guides that still described the old
vLLM schema, and unlink them from remaining comments.
@cursor
cursor Bot force-pushed the atnair/consolidate-readmes branch from 01480b0 to b9d8a5a Compare September 10, 2026 23:02
atnair-amd and others added 3 commits September 10, 2026 23:10
The page title stays Run vLLM Inference Tests; only the TOC entry is
the shorter sidebar name.
Point pick-config-file at the shipped mi3xx Llama 3.3 70B configs, describe
the current MI3xx catalog in What is CVS, and replace leftover serve_args
and sequence_combinations wording in the vLLM configuration reference.
@atnair-amd atnair-amd self-assigned this Sep 10, 2026
@atnair-amd
atnair-amd merged commit 72cf93d into main Sep 11, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants