- Notifications
You must be signed in to change notification settings - Fork1.9k
[https://nvbugs/5519525][fix] fix doc invalid link for bug 5519525#7753
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
[https://nvbugs/5519525][fix] fix doc invalid link for bug 5519525#7753
Uh oh!
There was an error while loading.Please reload this page.
Conversation
coderabbitaibot commentedSep 16, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
📝 WalkthroughWalkthroughUpdated perf-benchmarking documentation: replaced two TensorRT Model Optimizer links and expanded the PyTorch quantization section with hf_quant_config.json schema, kv_cache_quant_algo behavior, trtllm-bench KV-cache-selection logic, a behavior matrix, and a YAML kv_cache_dtype override example plus valid values. Changes
Sequence Diagram(s)sequenceDiagram autonumber participant U as User participant TB as trtllm-bench participant CKPT as Checkpoint (hf_quant_config.json) participant CFG as YAML Config Note over U,TB: Run benchmark in PyTorch flow U->>TB: Invoke benchmark TB->>CKPT: Read hf_quant_config.json CKPT-->>TB: Return compute_quant, kv_cache_quant_algo TB->>CFG: Read kv_cache_dtype (if present) alt YAML kv_cache_dtype provided TB->>TB: Force KV-cache dtype per YAML (auto | fp8) else No YAML override TB->>TB: Determine KV-cache quant using compute_quant + kv_cache_quant_algo rules end TB-->>U: Start benchmark with selected compute & KV-cache quantizationEstimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see thedocumentation for more information. Example: reviews:pre_merge_checks:custom_checks: -name:"Undocumented Breaking Changes"mode:"warning"instructions:| Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal). Please share your feedback with us on thisDiscord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
nv-guomingz commentedSep 16, 2025
/bot skip --comments "docs only change" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/source/developer-guide/perf-benchmarking.md (2)
447-449:Nit: fix punctuation in this sentence.Change “When running
trtllm-bench throughput. The benchmark will …” to a single sentence.-When running `trtllm-bench throughput`. The benchmark will select a KV cache quantization ...+When running `trtllm-bench throughput`, the benchmark will select a KV cache quantization ...
428-444:Optional: add a cross‑reference to the hf_quant_config.json schema.After introducing
hf_quant_config.json, link to the ModelOpt “Unified HuggingFace Checkpoint” page that documents this file and its fields (quantization.quant_algo,quantization.kv_cache_quant_algo). This will help readers align expectations across frameworks. (nvidia.github.io)
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/source/developer-guide/perf-benchmarking.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-09-09T09:40:45.658Z
Learnt from: fredricz-20070104PR: NVIDIA/TensorRT-LLM#7645File: tests/integration/test_lists/qa/llm_function_core.txt:648-648Timestamp: 2025-09-09T09:40:45.658ZLearning: In TensorRT-LLM test lists, it's common and intentional for the same test to appear in multiple test list files when they serve different purposes (e.g., llm_function_core.txt for comprehensive core functionality testing and llm_function_core_sanity.txt for quick sanity checks). This duplication allows tests to be run in different testing contexts.Applied to files:
docs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-08-06T13:58:07.506Z
Learnt from: galagamPR: NVIDIA/TensorRT-LLM#6487File: tests/unittest/_torch/auto_deploy/unit/singlegpu/test_ad_trtllm_bench.py:1-12Timestamp: 2025-08-06T13:58:07.506ZLearning: In TensorRT-LLM, test files (files under tests/ directories) do not require NVIDIA copyright headers, unlike production source code files. Test files typically start directly with imports, docstrings, or code.Applied to files:
docs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-07-28T17:06:08.621Z
Learnt from: moraxuPR: NVIDIA/TensorRT-LLM#6303File: tests/integration/test_lists/qa/examples_test_list.txt:494-494Timestamp: 2025-07-28T17:06:08.621ZLearning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.Applied to files:
docs/source/developer-guide/perf-benchmarking.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Pre-commit Check
🔇 Additional comments (1)
docs/source/developer-guide/perf-benchmarking.md (1)
426-426:Good fix: updated ModelOpt doc link is valid and points to the TensorRT‑LLM deployment section.The new URL resolves and is the right target for exporting/using quantized checkpoints with TensorRT‑LLM. (nvidia.github.io)
tensorrt-cicd commentedSep 16, 2025
PR_Github #18725 Bot args parsing error: usage: /bot skip --comment COMMENT |
Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>
cb3b4af tob53a264Comparenv-guomingz commentedSep 16, 2025
/bot skip --comment "docs only change" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/source/developer-guide/perf-benchmarking.md (1)
446-449:Grammar/flow nit: fix subordinate clause sentence.“When running
trtllm-bench throughput. The benchmark …” is ungrammatical. Merge into a single sentence.-When running `trtllm-bench throughput`. The benchmark will select a KV cache quantization that is best suited-for the compute precision in the checkpoint automatically if `kv_cache_quant_algo` is specified as `null`, otherwise it will-be forced to match the specified non-null KV cache quantization. The following are the mappings that `trtllm-bench` will-follow when a checkpoint does not specify a KV cache quantization algorithm:+When running `trtllm-bench throughput`, the benchmark automatically selects a KV‑cache quantization best suited+to the checkpoint’s compute precision if `kv_cache_quant_algo` is `null`; otherwise, it uses the specified non‑null+KV‑cache quantization. The following mappings apply when a checkpoint does not specify a KV‑cache quantization algorithm:
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/source/developer-guide/perf-benchmarking.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-09-09T09:40:45.658Z
Learnt from: fredricz-20070104PR: NVIDIA/TensorRT-LLM#7645File: tests/integration/test_lists/qa/llm_function_core.txt:648-648Timestamp: 2025-09-09T09:40:45.658ZLearning: In TensorRT-LLM test lists, it's common and intentional for the same test to appear in multiple test list files when they serve different purposes (e.g., llm_function_core.txt for comprehensive core functionality testing and llm_function_core_sanity.txt for quick sanity checks). This duplication allows tests to be run in different testing contexts.Applied to files:
docs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-08-06T13:58:07.506Z
Learnt from: galagamPR: NVIDIA/TensorRT-LLM#6487File: tests/unittest/_torch/auto_deploy/unit/singlegpu/test_ad_trtllm_bench.py:1-12Timestamp: 2025-08-06T13:58:07.506ZLearning: In TensorRT-LLM, test files (files under tests/ directories) do not require NVIDIA copyright headers, unlike production source code files. Test files typically start directly with imports, docstrings, or code.Applied to files:
docs/source/developer-guide/perf-benchmarking.md
📚 Learning: 2025-07-28T17:06:08.621Z
Learnt from: moraxuPR: NVIDIA/TensorRT-LLM#6303File: tests/integration/test_lists/qa/examples_test_list.txt:494-494Timestamp: 2025-07-28T17:06:08.621ZLearning: In TensorRT-LLM testing, it's common to have both CLI flow tests (test_cli_flow.py) and PyTorch API tests (test_llm_api_pytorch.py) for the same model. These serve different purposes: CLI flow tests validate the traditional command-line workflow, while PyTorch API tests validate the newer LLM API backend. Both are legitimate and should coexist.Applied to files:
docs/source/developer-guide/perf-benchmarking.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Pre-commit Check
🔇 Additional comments (2)
docs/source/developer-guide/perf-benchmarking.md (2)
426-426:AI summary appears broader than the actual diff.The AI summary mentions multiple link replacements and added quantization guidance, but the provided diff only shows this single link update. Confirm whether other intended doc edits were already merged elsewhere or should be included here.
426-426:Linkcheck passed — external doc URL returns 200 OK. Verified with curl:https://nvidia.github.io/TensorRT-Model-Optimizer/deployment/1_tensorrt_llm.html -> 200 (no redirect).
tensorrt-cicd commentedSep 16, 2025
PR_Github #18748 [ skip ] triggered by Bot |
tensorrt-cicd commentedSep 16, 2025
PR_Github #18748 [ skip ] completed with state |
64f7cca intoNVIDIA:release/1.0Uh oh!
There was an error while loading.Please reload this page.
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
…VIDIA#7753)Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>
Uh oh!
There was an error while loading.Please reload this page.
Summary by CodeRabbit
Description
Test Coverage
PR Checklist
Please review the following before submitting your PR:
PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.
PR FollowsTRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (seetest instructions)
Any new dependencies have been scanned for license and vulnerabilities
CODEOWNERS updated if ownership changes
Documentation updated as needed
The reviewers assigned automatically/manually are appropriate for the PR.
Please check this after reviewing the above items as appropriate for this PR.
GitHub Bot Help
/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...Provide a user friendly way for developers to interact with a Jenkins server.
Run
/bot [-h|--help]to print this help message.See details below for each supported subcommand.
run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental)]Launch build/test pipelines. All previously running jobs will be killed.
--reuse-test (optional)pipeline-id(OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.--disable-reuse-test(OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.--disable-fail-fast(OPTIONAL) : Disable fail fast on build/tests/infra failures.--skip-test(OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: DoesNOT update GitHub check status.--stage-list "A10-PyTorch-1, xxx"(OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: DoesNOT update GitHub check status.--gpu-type "A30, H100_PCIe"(OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: DoesNOT update GitHub check status.--test-backend "pytorch, cpp"(OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: DoesNOT update GitHub pipeline status.--only-multi-gpu-test(OPTIONAL) : Only run the multi-GPU tests. Note: DoesNOT update GitHub check status.--disable-multi-gpu-test(OPTIONAL) : Disable the multi-GPU tests. Note: DoesNOT update GitHub check status.--add-multi-gpu-test(OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.--post-merge(OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx"(OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".--detailed-log(OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.--debug(OPTIONAL) :Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in thestage-listparameter to access the appropriate container environment. Note: DoesNOT update GitHub check status.For guidance on mapping tests to stage names, see
docs/source/reference/ci-overview.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip testing for latest commit on pull request.
--comment "Reason for skipping build/test"is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.reuse-pipeline
reuse-pipelineReuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.