docs: rebuild the unified HF deployment support matrix from the deploy test suite (NVBug 6550792) - #2087
docs: rebuild the unified HF deployment support matrix from the deploy test suite (NVBug 6550792)#2087Edwardf0t1 wants to merge 2 commits into
Conversation
…y test suite (NVBug 6550792) The deployment support matrix listed 9 model families and no VLMs, while tests/examples/hf_ptq/test_deploy.py already deploy-tests 81 checkpoints across TRT-LLM, vLLM, and SGLang — including Qwen2.5-VL, Qwen3-VL, Phi-4-multimodal, and Nemotron Omni. QA could not use the doc to scope testing, and users could not tell what is actually supported. The matrix also existed in three places that had drifted apart: only the .rst listed Qwen3-VL, only the README listed Qwen3.5 MoE, and the agent skill reference had neither. - Rebuild the matrix in docs/source/deployment/3_unified_hf.rst from test_deploy.py, split into language / vision-language / speculative decoding / diffusion tables, with a three-state legend so a cell distinguishes "validated in CI" from "expected but untested". - Replace the duplicate tables in examples/hf_ptq/README.md and the deployment skill reference with links, leaving one copy to maintain. - Fix stale prose in the deployment tabs that still claimed FP8-only support on vLLM v0.6.5 and a source build of SGLang main from Jan 2025. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Zhiyu Cheng <zhiyuc@nvidia.com>
📝 WalkthroughWalkthroughThe deployment documentation now contains the canonical unified support matrix, updated framework requirements, and guidance for unlisted models. Supporting references link to the documentation and deployment validation test. ChangesUnified deployment support
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
There was a problem hiding this comment.
Warning
CodeRabbit couldn't request changes on this pull request because it doesn't have sufficient GitHub permissions.
Please grant CodeRabbit Pull requests: Read and write permission and re-run the review.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/source/deployment/3_unified_hf.rst`:
- Around line 139-149: Document the conditional EAGLE test prerequisite
consistently: in docs/source/deployment/3_unified_hf.rst lines 139-149, add that
EAGLE coverage requires MODELOPT_LOCAL_EAGLE_MODEL and an existing local drafter
directory; in .agents/skills/deployment/references/support-matrix.md lines 5-12,
qualify EAGLE coverage with the same prerequisite; and in
examples/hf_ptq/README.md lines 597-600, qualify the statement that every entry
loads and runs. Preserve the meaning that Y indicates coverage when the
prerequisite is available.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 19ce3c6f-7119-4d00-8414-269841f99320
📒 Files selected for processing (3)
.agents/skills/deployment/references/support-matrix.mddocs/source/deployment/3_unified_hf.rstexamples/hf_ptq/README.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2087 +/- ##
==========================================
- Coverage 67.15% 66.98% -0.18%
==========================================
Files 521 521
Lines 59857 59857
==========================================
- Hits 40199 40097 -102
- Misses 19658 19760 +102
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…EAGLE coverage - Raise the documented TensorRT-LLM minimum from v0.17.0 to v1.2.0. 0.17 is stale: CI runs 1.3.0rc20 and the deploy tests use llmapi APIs (EagleDecodingConfig, CudaGraphConfig) that do not exist in 0.17. Also fix the same stale claim in the hf_ptq and diffusers support-matrix footnotes. - Use the repo's usual checkmarks in the matrix instead of Y/~. - Note that EAGLE3 drafter coverage is conditional on MODELOPT_LOCAL_EAGLE_MODEL; those tests skip when it is unset, so the drafter table's checkmarks are weaker than the other tables'. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Zhiyu Cheng <zhiyuc@nvidia.com>
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/source/deployment/3_unified_hf.rst (2)
183-187: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winReplace the stale
Yreference.The tables and legend now use
✅, but Line 183 still says “everyYabove”. Change this to “every checkmark above” or “every✅above”.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/source/deployment/3_unified_hf.rst` around lines 183 - 187, Update the deployment documentation sentence referring to “every ``Y`` above” so it instead refers to the current checkmark notation, using “every checkmark above” or “every ``✅`` above”; leave the surrounding checkpoint and link references unchanged.
170-173: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winScope the Blackwell requirement to the serving paths.
- In
docs/source/deployment/3_unified_hf.rst, state that the Blackwell and CUDA 13 requirements apply to unified HF serving.- In
examples/diffusers/README.md, state that the Blackwell and TensorRT-LLM v1.2 requirements apply to the TensorRT-LLM table. The Wan 2.2 VAE NVFP4 path supports SM80+ GPUs.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/source/deployment/3_unified_hf.rst` around lines 170 - 173, Scope the hardware and software requirements to the relevant serving paths: in docs/source/deployment/3_unified_hf.rst lines 170-173, state that the Blackwell GPU and CUDA 13 requirements apply to unified HF serving; in examples/diffusers/README.md line 81, state that Blackwell and TensorRT-LLM v1.2 are required for the TensorRT-LLM table while documenting that the Wan 2.2 VAE NVFP4 path supports SM80+ GPUs.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/source/deployment/3_unified_hf.rst`:
- Around line 183-187: Update the deployment documentation sentence referring to
“every ``Y`` above” so it instead refers to the current checkmark notation,
using “every checkmark above” or “every ``✅`` above”; leave the surrounding
checkpoint and link references unchanged.
- Around line 170-173: Scope the hardware and software requirements to the
relevant serving paths: in docs/source/deployment/3_unified_hf.rst lines
170-173, state that the Blackwell GPU and CUDA 13 requirements apply to unified
HF serving; in examples/diffusers/README.md line 81, state that Blackwell and
TensorRT-LLM v1.2 are required for the TensorRT-LLM table while documenting that
the Wan 2.2 VAE NVFP4 path supports SM80+ GPUs.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 8bd6d1e9-8eaa-4f03-b2fc-f1d672583f56
📒 Files selected for processing (3)
docs/source/deployment/3_unified_hf.rstexamples/diffusers/README.mdexamples/hf_ptq/README.md
🚧 Files skipped from review as they are similar to previous changes (1)
- examples/hf_ptq/README.md
What does this PR do?
Type of change: documentation
Fixes NVBug 6550792 / OMNIML-5693.
The Unified HF Checkpoint Deployment Model Support Matrix listed 9 model families and no VLMs, while
tests/examples/hf_ptq/test_deploy.pyalready deploy-tests 81 checkpoints (218 model×backend combinations) across TRT-LLM, vLLM, and SGLang — includingQwen2.5-VL,Qwen3-VL-235B-A22B,Phi-4-multimodal, andNemotron-3-Nano-Omni. QA (the filer) could not use the doc to scope testing, and users could not tell what is actually supported.Filing also surfaced that the matrix lived in three places that had drifted apart:
examples/hf_ptq/README.mddocs/…/3_unified_hf.rst.agents/…/support-matrix.mdChanges
Rebuilt the matrix in
docs/source/deployment/3_unified_hf.rstdirectly fromtest_deploy.py, split into four tables — language models, vision-language/multimodal, speculative decoding drafters, diffusion — with a three-state legend:Y— covered by the release deployment test suite (loads the exported checkpoint in the framework and runs generation)~— documented as working previously but not in the current suite; expected to work, unvalidated-— not currently coveredThe
~state is what lets the table grow honestly: entries carried over from the old matrix (Qwen 2.5, QwQ-32B, Mixtral) are not silently promoted to "validated", and export-succeeds is never conflated with serves-correctly.Removed the two duplicate copies, replacing them with links, so there is one table to keep current.
Fixed stale prose in the deployment tabs that still claimed FP8-only support on vLLM v0.6.5 and a source build of SGLang main from Jan 2025 — both contradicted the version table 50 lines above them.
Also added the Blackwell/
sm_103CUDA-13 note and a "models not listed here" section explaining that the frameworks load unified HF checkpoints generically, so an unlisted model often deploys with no modelopt change.Usage
N/A — documentation only.
Testing
docutilsparse of the modified.rst: no warnings or errors from the new content; all 5 tables parse.Ycell againsttests/examples/hf_ptq/test_deploy.pyby AST-parsing theModelDeployerList(...)calls rather than reading the file by eye.pre-commit run --files …passes (markdownlint-cli2and the threersthooks included).Before your PR is "Ready for review"
CONTRIBUTING.md: N/AAdditional Information
Known follow-up: this PR removes the three-way drift structurally, but nothing yet enforces that the doc matrix tracks
test_deploy.py. A generator plus a CI check would close that for good; filing separately rather than growing a doc fix.For the filer (@kenny Kang): the
Ycells are exactly the scope the release deploy suite covers, andtest_deploy.pycarries the checkpoint, TP size, and minimum SM version per entry. If QA can validate any~cells, those flip toY.🤖 Generated with Claude Code
Summary by CodeRabbit