Skip to content

[Doc] Update README and docs for v0.30.0 - #8175

Merged
hsliuustc0106 merged 2 commits into
mainfrom
codex-docs-v0.30.0
Sep 27, 2026
Merged

hsliuustc0106 merged 2 commits into
mainfrom
codex-docs-v0.30.0

Conversation

@hsliuustc0106

Copy link
Copy Markdown
Collaborator

Follows the pattern of #6858 (v0.28.0 doc update) for the v0.30.0 release.

Documentation

  • README.md: added the 2026/09 news bullet for 0.30.0 (unified full-duplex framework around engine-owned sessions for MiniCPM-o 4.5/AURA, cross-stage KV and multimodal payload transfer via Mooncake/NIXL, LingBot World interactive world-model serving, realtime MiniMax H3 Turbo on Blackwell/Ascend 950) and refreshed the supported-model examples: Tencent AuK and Breeze-TTS-2 under TTS, LingBot World and MAGI-2 under diffusion, π0.5 under robot-policy.
  • docs/README.md: same model-example refresh as the root README.
  • docs/getting_started/installation/README.md, gpu.md, gpu/cuda.inc.md, gpu/rocm.inc.md: dropped the "until 0.30.0 artifacts are published" caveats now that the release is out; pre-built wheel commands, the wheels-available list, and the docker run examples moved from 0.28.0 to 0.30.0 (vllm/vllm-omni:v0.30.0, vllm/vllm-omni-rocm:v0.30.0).
  • docs/getting_started/installation/npu/npu.inc.md: source clone moved from v0.30.0rc1 to the final v0.30.0 tag.
  • docs/configuration/README.md, docs/configuration/environment_variables.md: vLLM configuration/env-var references bumped from 0.29 to 0.30.

Verified: the 0.30.0 wheel is live on PyPI, wheels.vllm.ai/rocm/0.30.0/rocm723 returns HTTP 200, both new docs.vllm.ai/en/v0.30.0 links return HTTP 200, and the recipe links in the news bullet resolve in-tree. Docker Hub was unreachable from the review machine, so the v0.30.0 image tags are asserted from the release workflow that publishes them alongside the GitHub release (same as #6858 did on its release day); happy to re-verify once the network allows.

cc @hsliuustc0106

Announce the v0.30.0 release in the README news section (unified
full-duplex framework, cross-stage KV/multimodal transfer, LingBot
World interactive serving, MiniMax H3 Turbo on Blackwell/Ascend 950)
and refresh the supported-model examples (Tencent AuK, Breeze-TTS-2,
LingBot World, MAGI-2, pi0.5; drop removed dots.tts-era examples).

Point the pre-built wheel and image instructions at the published
0.30.0 artifacts (PyPI wheel verified; ROCm 0.30.0/rocm723 wheel index
verified), update the vLLM configuration and environment-variable
references from 0.29 to 0.30, and move the NPU source-clone tag from
v0.30.0rc1 to the final v0.30.0 release.

Signed-off-by: hsliu_ustc <hsliu_ustc@noreply.gitcode.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-26T09:57:46.027151Z c88408d PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@vllm-omni-review-bot

Copy link
Copy Markdown

This PR matches CODEOWNERS paths: /docs/.

Code owners: @david6666666 @Gaohan123

Routing: @david6666666 via CODEOWNERS; @Gaohan123 via CODEOWNERS

@hsliuustc0106, please review your own changes and leave a short self-review comment describing what you checked. PRs without author self-review may not be assigned a reviewer.

Please take a look when you have a chance. If you would like an automated review, mention @vllm-omni-review-bot in a comment.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: c88408d825

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

--env "HF_TOKEN=$HF_TOKEN" \
-p 8091:8091 \
vllm/vllm-omni-rocm:v0.28.0 \
vllm/vllm-omni-rocm:v0.30.0 \

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Keep ROCm examples on a published image tag

For ROCm users following the recommended Docker setup, this newly substituted tag is not produced by the repository's release pipeline, so docker run will fail unless someone performs an undocumented out-of-band upload. I checked .buildkite/release/release-pipeline.yml: both release-image jobs build docker/Dockerfile.cuda, while .buildkite/release/scripts/publish-release-images.sh hardcodes vllm/vllm-omni; a repo-wide search found no publisher for vllm/vllm-omni-rocm. The same document also says availability of these prebuilt ROCm images is still tracked in issue #7405, so retain an actually published tag or add the ROCm publication step before advertising v0.30.0.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andyluo7 @FayeSpica @xuechendi PTAL for hardware specfic images

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 77dab60. Verified the finding against the repo before fixing: .buildkite/release/release-pipeline.yml builds only docker/Dockerfile.cuda, publish-release-images.sh pushes only vllm/vllm-omni, and #7405 (open) tracks the out-of-band ROCm uploads — v0.28.0 is the latest tag confirmed live on Docker Hub (linux/amd64, digest 0ffd58d3c299).

The two docker run examples are back on v0.28.0, and the pre-built-images section now states that the prebuilt ROCm image is published separately from the release pipeline with newer-tag availability tracked in #7405, so the tag lagging the 0.30.0 wheels reads as intentional. The source-build path stays on the upstream vllm/vllm-openai-rocm:v0.30.0 base, which is published. Happy to flip the run examples to v0.30.0 as soon as that tag lands on the Hub.

@vllm-omni-review-bot

Copy link
Copy Markdown
Omni ReviewBot routing record

Assigned Direct under experiment vllm-omni-strict-5050-20260829.

@vllm-omni-review-bot vllm-omni-review-bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Omni ReviewBot review

PR description

This documentation-only change retargets the public install and configuration pages from the 0.28.0 / 0.30.0rc1 pins to the published 0.30.0 release. The root and docs landing pages add a September 2026 news item and refresh the supported-model examples to names already listed in the in-tree recipe catalog. Users following pip, git-clone, or Docker commands are now pointed at 0.30.0 artifacts; the ROCm official-image commands still sit beside an open published-tag caveat.

Change flow

flowchart TD
  Release["[EXISTING] GitHub v0.30.0 release"]:::existing --> News["[CHANGED] README.md and docs/README.md<br/>news plus model-example lists"]:::changed
  Release --> Install["[CHANGED] Installation CUDA/ROCm/NPU docs<br/>drop 0.28.0 caveats; pin 0.30.0"]:::changed
  Release --> Config["[CHANGED] Configuration docs<br/>vLLM 0.29 links to 0.30"]:::changed
  News --> Readers["[EXISTING] Docs and README readers"]:::existing
  Install --> Users["[EXISTING] pip, docker, and source clone"]:::existing
  Config --> Users
  classDef existing fill:#e5e7eb,stroke:#6b7280,color:#111827
  classDef changed fill:#fef3c7,stroke:#d97706,color:#451a03,stroke-width:2px
  classDef new fill:#dcfce7,stroke:#16a34a,color:#052e16,stroke-width:2px
  classDef removed fill:#fee2e2,stroke:#dc2626,color:#450a0a,stroke-width:2px
Loading

CI at c88408d8259d (2026-09-26T20:24:23.796419+00:00): required check(s) blocking: buildkite/vllm-omni (missing), and -5 more. Observed Buildkite: buildkite/omni-release (passed), and -2 more.

Findings

  • [P1] Do not advertise vllm/vllm-omni-rocm:v0.30.0 while #7405 still tracks unpublished tags — docs/getting_started/installation/gpu/rocm.inc.md:168
    The same ROCm page still says prebuilt vllm/vllm-omni-rocm published-tag availability is tracked in #7405 (lines 93-94), then the recommended official-image path tells users to docker run ... vllm/vllm-omni-rocm:v0.30.0 (line 168, repeated at 189). This PR dropped the "until artifacts are published" caveats elsewhere because 0.30.0 is out, but it does not establish that the ROCm Hub tag exists: the author noted Docker Hub was unreachable and inferred tags from the release workflow. A user who follows the official ROCm docker run will fail on a missing tag, while the source-build path that uses vllm/vllm-openai-rocm:v0.30.0 remains the documented fallback. Keep the source-build examples, and do not advertise vllm/vllm-omni-rocm:v0.30.0 until that tag is published (or add the ROCm publish step and drop the #7405 caveat).
    Existing thread: #8175 (comment)

@vllm-omni-review-bot

Copy link
Copy Markdown

Omni ReviewBot: finding feedback

[p1] Do not advertise vllm/vllm-omni-rocm:v0.30.0 while #7405 still tracks unpublished tags — docs/getting_started/installation/gpu/rocm.inc.md:168

The same ROCm page still says prebuilt vllm/vllm-omni-rocm published-tag availability is tracked in #7405 (lines 93-94), then the recommended official-image path tells users to docker run ... vllm/vllm-omni-rocm:v0.30.0 (line 168, repeated at 189). This PR dropped the "until artifacts are published" caveats elsewhere because 0.30.0 is out, but it does not establish that the ROCm Hub tag exists: the author noted Docker Hub was unreachable and inferred tags from the release workflow. A user who follows the official ROCm docker run will fail on a missing tag, while the source-build path that uses vllm/vllm-openai-rocm:v0.30.0 remains the documented fallback. Keep the source-build examples, and do not advertise vllm/vllm-omni-rocm:v0.30.0 until that tag is published (or add the ROCm publish step and drop the #7405 caveat).

This finding appears in the bot's COMMENT review, but GitHub could not place it as an inline diff comment. If you are the PR author and disagree, react 👎 to this comment. The disagreement will be shown to the maintainer; it does not approve or merge the PR.

The release pipeline builds and publishes only the CUDA image
(.buildkite/release/release-pipeline.yml builds docker/Dockerfile.cuda;
publish-release-images.sh targets vllm/vllm-omni). The prebuilt ROCm
image is uploaded out-of-band, and v0.28.0 is the latest tag confirmed
live on Docker Hub (#7405). Revert the two docker run examples to
v0.28.0 and state why the tag lags the 0.30.0 wheels, so users do not
hit a missing-tag pull failure. Source-build examples stay on the
upstream vllm/vllm-openai-rocm:v0.30.0 base, which is published.

Signed-off-by: hsliu_ustc <hsliu_ustc@noreply.gitcode.com>
@hsliuustc0106

Copy link
Copy Markdown
Collaborator Author

Self-review (author):

  • Version pins were checked against the actually-published state: vllm-omni 0.30.0 wheel on PyPI, wheels.vllm.ai/rocm/0.30.0/rocm723 (HTTP 200), and both docs.vllm.ai/en/v0.30.0 configuration / env-var links (HTTP 200).
  • The vLLM-Omni 0.30.x → vLLM 0.30.x pairing matches the release notes (rebased onto vLLM 0.30.0 in [Rebase] Rebase to vLLM 0.30.0 #7820).
  • Recipe links in the README news bullet resolve in-tree (MiniMax-H3, MiniCPM-o-4_5, LingBot-World-2.0), and every model name in the refreshed examples comes from the v0.30.0 release notes.
  • The ROCm docker run examples intentionally stay on v0.28.0: the release pipeline publishes only the CUDA image and ROCm tags are uploaded out-of-band ([Docs][ROCm] Fix unavailable prebuilt image tags in installation guide #7405). Noted in the doc in 77dab60.
  • Docs-only change, no code paths touched; the remaining npu.inc.md markdownlint findings pre-date this PR and CI's pre-commit lane skips markdownlint-cli2.

@hsliuustc0106 hsliuustc0106 added the documentation Improvements or additions to documentation label Sep 26, 2026
@hsliuustc0106
hsliuustc0106 merged commit 7ab582a into main Sep 27, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants