[None][doc] Fix a invalid link and a typo. #7634

nv-guomingz · 2025-09-09T03:31:07Z

Summary by CodeRabbit

Documentation
- Corrected a typo in the performance benchmarking guide, updating link text from “overiew” to “overview.”
- Fixed a malformed hyperlink in the “State-of-the-Art Performance” section (DeepSeek R1) by removing an extra leading dot so the link opens correctly.
- Clarified wording to use “standard TensorRT LLM argument list.”
- Fixed a grammar issue in the quantization guide ("reduces" → "reduce").

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 Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.
Test cases are provided for new code paths (see test 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: Does NOT update GitHub check status.

--stage-list "A10-PyTorch-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT 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: Does NOT 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: Does NOT update GitHub pipeline status.

--only-multi-gpu-test (OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.

--disable-multi-gpu-test (OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT 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 the stage-list parameter to access the appropriate container environment. Note: Does NOT update GitHub check status.

For guidance on mapping tests to stage names, see docs/source/reference/ci-overview.md
and the scripts/test_to_stage_mapping.py helper.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip 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-pipeline

Reuse 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.

coderabbitai · 2025-09-09T03:31:13Z

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between ef5390e and 25c7855.

📒 Files selected for processing (4)

docs/source/developer-guide/perf-benchmarking.md (1 hunks)
docs/source/features/auto_deploy/advanced/expert_configurations.md (1 hunks)
docs/source/features/quantization.md (1 hunks)
docs/source/overview.md (1 hunks)

 _________________________________________
< Tensor cores warmed; bug cores chilled. >
 -----------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

📝 Walkthrough

Walkthrough

Documentation-only edits: corrected a misspelled link anchor in perf-benchmarking doc and fixed a malformed URL in the overview. No code, API, or control-flow changes.

Changes

Cohort / File(s)	Summary of Changes
Docs: link/typo fixes `docs/source/developer-guide/perf-benchmarking.md`, `docs/source/overview.md`	perf-benchmarking: corrected "overiew" to "overview" in a link; overview: removed a leading dot in a URL (.https:// → https://).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

[https://nvbugs/5423962][fix] Address broken links #6531 — Also fixes broken/malformed documentation links, overlapping in purpose with perf-benchmarking docs.
[None][autodeploy] Doc: fix link path in trtllm bench doc #7007 — Adjusts a hyperlink pointing to the perf-benchmarking page, related to link corrections in this PR.

Suggested labels

Documentation, 1.0_doc

Suggested reviewers

QiJune
litaotju
byshiue

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The description remains the unfilled PR template with no actual summary, explanation of the link and typo fixes, test coverage details, or context provided, leaving all required sections empty.	Please replace the template placeholders with a concise summary of the documentation fixes, add a “Description” section explaining the changes, list any relevant tests under “Test Coverage,” and ensure all required template sections are completed.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title accurately summarizes the primary change of fixing a broken link and a typo in the documentation and follows the “[None][type] Summary” convention in a concise sentence.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Pre-merge checks (2 passed, 1 warning)

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description Check	⚠️ Warning	The pull request description is still the unmodified template without any filled-in title, Description, or Test Coverage sections and lacks a summary of the link fix and typo correction.	Please update the PR title following the required template, complete the Description section with a concise summary of the invalid link correction and typo fix, and populate the Test Coverage section or note that no tests are needed for these documentation changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title accurately summarizes the primary change of fixing a broken link and a typo in the documentation and follows the “[None][type] Summary” convention in a concise sentence.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Tip

You can disable the changed files summary in the walkthrough.

Disable the reviews.changed_files_summary setting in your project's settings in CodeRabbit to disable the changed files summary in the walkthrough.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

nv-guomingz · 2025-09-09T03:31:28Z

/bot skip --comment "docs only change"

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/source/developer-guide/perf-benchmarking.md (1)
11-11: Fix minor grammar; optionally verify anchor exists.

Replace “provides the follows” with “provides the following”. Also, please confirm the #throughput-measurements anchor exists in perf-overview.md.

Apply this diff:
- easier for users to reproduce our officially published [performance overview](./perf-overview.md#throughput-measurements). `trtllm-bench` provides the follows:
+ easier for users to reproduce our officially published [performance overview](./perf-overview.md#throughput-measurements). `trtllm-bench` provides the following:

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between af3f03c and ef5390e.

📒 Files selected for processing (2)

docs/source/developer-guide/perf-benchmarking.md (1 hunks)
docs/source/overview.md (1 hunks)

🧰 Additional context used

🧠 Learnings (3)

📚 Learning: 2025-07-28T17:06:08.621Z

Learnt from: moraxu
PR: NVIDIA/TensorRT-LLM#6303
File: tests/integration/test_lists/qa/examples_test_list.txt:494-494
Timestamp: 2025-07-28T17:06:08.621Z
Learning: 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

📚 Learning: 2025-08-06T13:58:07.506Z

Learnt from: galagam
PR: NVIDIA/TensorRT-LLM#6487
File: tests/unittest/_torch/auto_deploy/unit/singlegpu/test_ad_trtllm_bench.py:1-12
Timestamp: 2025-08-06T13:58:07.506Z
Learning: 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-08-11T20:09:24.389Z

Learnt from: achartier
PR: NVIDIA/TensorRT-LLM#6763
File: tests/integration/defs/triton_server/conftest.py:16-22
Timestamp: 2025-08-11T20:09:24.389Z
Learning: In the TensorRT-LLM test infrastructure, the team prefers simple, direct solutions (like hard-coding directory traversal counts) over more complex but robust approaches when dealing with stable directory structures. They accept the maintenance cost of updating tests if the layout changes.

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/overview.md (1)

21-21: LGTM: malformed URL fixed.

The leading dot was removed; link now appears valid.

tensorrt-cicd · 2025-09-09T03:36:54Z

PR_Github #18141 [ skip ] triggered by Bot

tensorrt-cicd · 2025-09-09T04:14:29Z

PR_Github #18141 [ skip ] completed with state SUCCESS
Skipping testing for commit ef5390e

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

nv-guomingz · 2025-09-09T04:30:28Z

/bot skip --comment "docs only change"

tensorrt-cicd · 2025-09-09T04:36:01Z

PR_Github #18154 [ skip ] triggered by Bot

tensorrt-cicd · 2025-09-09T04:49:26Z

PR_Github #18154 [ skip ] completed with state SUCCESS
Skipping testing for commit 25c7855

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com> Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>

nv-guomingz requested a review from a team as a code owner September 9, 2025 03:31

coderabbitai bot reviewed Sep 9, 2025

View reviewed changes

litaotju approved these changes Sep 9, 2025

View reviewed changes

nv-guomingz enabled auto-merge (squash) September 9, 2025 03:48

nv-guomingz disabled auto-merge September 9, 2025 04:10

nv-guomingz force-pushed the user/guomingz/fix_doc_link_0908 branch from ef5390e to ee7d552 Compare September 9, 2025 04:15

[None][doc] Fix a invalid link and a typo.

25c7855

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

nv-guomingz force-pushed the user/guomingz/fix_doc_link_0908 branch from ee7d552 to 25c7855 Compare September 9, 2025 04:16

nv-guomingz enabled auto-merge (squash) September 9, 2025 04:30

nv-guomingz merged commit 49dcc0d into NVIDIA:release/1.0 Sep 9, 2025
5 checks passed

dominicshanshan pushed a commit to dominicshanshan/TensorRT-LLM that referenced this pull request Sep 9, 2025

[None][doc] Fix a invalid link and a typo. (NVIDIA#7634)

55fcdf2

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>

chzblych pushed a commit that referenced this pull request Sep 22, 2025

[None][doc] Fix a invalid link and a typo. (#7634)

5c54173

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com> Signed-off-by: Wangshanshan <30051912+dominicshanshan@users.noreply.github.com>

nv-guomingz deleted the user/guomingz/fix_doc_link_0908 branch September 30, 2025 08:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[None][doc] Fix a invalid link and a typo. #7634

[None][doc] Fix a invalid link and a typo. #7634

Uh oh!

nv-guomingz commented Sep 9, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 9, 2025 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Uh oh!

nv-guomingz commented Sep 9, 2025

Uh oh!

coderabbitai bot left a comment

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

nv-guomingz commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[None][doc] Fix a invalid link and a typo. #7634

[None][doc] Fix a invalid link and a typo. #7634

Uh oh!

Conversation

nv-guomingz commented Sep 9, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Description

Test Coverage

PR Checklist

GitHub Bot Help

kill

skip

reuse-pipeline

Uh oh!

coderabbitai bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested labels

Suggested reviewers

Pre-merge checks (2 passed, 1 warning)

Pre-merge checks (2 passed, 1 warning)

Uh oh!

nv-guomingz commented Sep 9, 2025

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

nv-guomingz commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

tensorrt-cicd commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nv-guomingz commented Sep 9, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 9, 2025 •

edited

Loading