[doc] feat: split GPU/NPU install docs - #515
Merged
SamitHuang merged 2 commits intoSep 7, 2026
Merged
Conversation
Split docs/start/install.md into an NVIDIA GPU page (kept at the same path so existing links still work) and a new docs/start/install_npu.md for Ascend NPU, matching the flowgrpo_quickstart.md / flowgrpo_quickstart_npu.md split already used in this repo. Each page is self-contained with a one-line cross-link to the other, and the NPU-specific Docker section moves to the new page. On the GPU page, correct the kernels version documented for the gpu extra from 0.14.1 to 0.16.0 to match pyproject.toml. Docker/CI 0.14.1 overrides (docker/Dockerfile.cuda default, gpu-smoke-prepare action) are intentionally left as-is since they are documented overrides, not the project extra default. Fixes verl-project#226 Relates to verl-project#440: fixes the docs-reported kernels version, but does not close verl-project#440 since docker/Dockerfile.cuda's KERNELS_VERSION default and its "defaults match pyproject.toml extras" header comment are still inconsistent with 0.16.0. Co-authored-by: Cursor <cursoragent@cursor.com> Signed-off-by: chi030303 <106855944+chi030303@users.noreply.github.com>
chi030303
force-pushed
the
doc/split-gpu-npu-install
branch
from
September 2, 2026 14:41
88788c9 to
3aa2e5a
Compare
6 tasks
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The doc split is consistent with existing intra-doc linking patterns and the GPU kernels==0.16.0 documentation matches pyproject.toml’s gpu extra.
Pull request overview
This PR splits the mixed GPU/NPU installation documentation into two hardware-specific pages (keeping the existing docs/start/install.md path for GPU link stability) and updates the GPU install page’s documented kernels version to match the gpu extra in pyproject.toml.
Changes:
- Split install docs into NVIDIA GPU (
docs/start/install.md) and Ascend NPU (docs/start/install_npu.md) with cross-links between them. - Update GPU install docs to state
kernels==0.16.0for thegpuextra (matchingpyproject.toml). - Update docs navigation and NPU quickstart to point to the new NPU install page.
File summaries
| File | Description |
|---|---|
| docs/start/install.md | GPU-specific install page; adds cross-link to NPU page and corrects kernels version to 0.16.0. |
| docs/start/install_npu.md | New NPU-specific install page containing the previously mixed-in NPU instructions and Docker guidance. |
| docs/start/flowgrpo_quickstart_npu.md | Updates the quickstart to link to the new NPU install page. |
| docs/index.md | Adds start/install_npu.md to the Getting Started toctree. |
Review details
- Files reviewed: 4/4 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Keep the hardware-specific pages, and take main's Python 3.11, vLLM 0.28 extras, and FA fail-fast docs. Signed-off-by: chi030303 <106855944+chi030303@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
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.
What does this PR do?
Fixes #226.
Split
docs/start/install.mdinto hardware-specific pages, following this repo'sflowgrpo_quickstart.md/flowgrpo_quickstart_npu.mdnaming:docs/start/install.md— NVIDIA GPU (existing path kept so links still work)docs/start/install_npu.md— Ascend NPUEach page is self-contained with a one-line cross-link at the top. The Getting Started toctree lists both. The NPU FlowGRPO quickstart now points at
install_npu.md.On the GPU page, the extras table / FA3 section document
kernels==0.16.0to match the currentgpuextra inpyproject.toml(the table onmainstill says0.14.1; see #440). This PR does not change Docker/CI pins; #497 is already unifying those to0.16.0. Do not close #440 from this PR —docker/Dockerfile.cuda'sKERNELS_VERSIONdefault and its "defaults match pyproject.toml extras" header comment are still inconsistent with0.16.0, and that part of #440 is unresolved.Checklist Before Starting
[doc] feat: split GPU/NPU install docsTest
Docs-only. No new CI, no training.
cd docs && make html—start/install.htmlandstart/install_npu.htmlrender; cross-links open; GPU extras showkernels==0.16.0tests/special_sanity/check_docs_time_info.pypassedSKIP=autogen-trainer-cfg pre-commit run --files docs/start/install.md docs/start/install_npu.md docs/index.md docs/start/flowgrpo_quickstart_npu.md— applicable hooks passed. The skipped hook regenerates trainer configs and needsomegaconf/ a full install; this docs-only change does not affect it.API and Usage Example
No API change. GPU users keep using
docs/start/install.md; NPU users usedocs/start/install_npu.md.Design & Code Changes
docs/index.md: addstart/install_npu.mdunder Getting Starteddocs/start/flowgrpo_quickstart_npu.md: install link →install_npu.mdChecklist Before Submitting
SKIP=autogen-trainer-cfg; see Test)AI-assisted contribution disclosure
This PR was prepared with AI assistance (Cursor agent). I (the submitter) reviewed every changed line, ran the test commands listed above myself in this environment, and can defend/discuss the change.