doc: remove backend parameter for trtllm-bench when backend is set to… #6428

nv-guomingz · 2025-07-29T03:01:59Z

It's a supplement PR of #5491 .

This PR just removed the explicit --backend parameter when it use the PyTorch as the value.

Summary by CodeRabbit

Documentation
- Updated multiple documentation files and example READMEs to remove the --backend pytorch option from all relevant command-line examples.
- Simplified benchmark, profiling, and serving command examples for easier usage and clarity.

coderabbitai · 2025-07-29T03:02:10Z

📝 Walkthrough

Walkthrough

All documentation and example files have been updated to remove the explicit --backend pytorch flag from command-line examples. This affects benchmark, serving, evaluation, and profiling commands across multiple documentation pages and README files. No other command options, explanations, or logic are modified.

Changes

Cohort / File(s)	Change Summary
DeepSeek-R1 Blog Documentation `docs/source/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md`	Removed all `--backend pytorch` options and related explanations from benchmark command examples.
Performance Analysis Documentation `docs/source/performance/perf-analysis.md`	Removed `--backend pytorch` from Nsight Systems profiling example command line.
Performance Benchmarking Documentation `docs/source/performance/perf-benchmarking.md`	Deleted `--backend pytorch` from throughput benchmark example commands.
DeepSeek-V3/DeepSeek-R1 Example README `examples/models/core/deepseek_v3/README.md`	Removed `--backend pytorch` from all example commands for benchmarking, serving, evaluation, and advanced usage.
Wide Expert Parallelism Example README `examples/wide_ep/ep_load_balancer/README.md`	Removed `--backend pytorch` from all example `trtllm-bench` commands.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

[BREAKING CHANGE]: change default backend to PyTorch in trtllm-serve #5717: Changes the default backend to PyTorch in trtllm-serve and updates code to reflect this, which is directly related to removing explicit --backend pytorch flags in documentation and examples.
[TRTLLM-6070] docs: Add initial documentation for trtllm-bench CLI. #5734: Adds initial documentation for the trtllm-bench CLI including usage and options; related as the current PR modifies usage examples of the same CLI tool.

Suggested labels

Documentation

Suggested reviewers

kaiyux
Superjomn
litaotju

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ea2eaf1 and 4639092.

📒 Files selected for processing (5)

docs/source/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md (0 hunks)
docs/source/performance/perf-analysis.md (0 hunks)
docs/source/performance/perf-benchmarking.md (1 hunks)
examples/models/core/deepseek_v3/README.md (3 hunks)
examples/wide_ep/ep_load_balancer/README.md (0 hunks)

💤 Files with no reviewable changes (3)

examples/wide_ep/ep_load_balancer/README.md
docs/source/performance/perf-analysis.md
docs/source/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md

✅ Files skipped from review due to trivial changes (1)

docs/source/performance/perf-benchmarking.md

🚧 Files skipped from review as they are similar to previous changes (1)

examples/models/core/deepseek_v3/README.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

✨ Finishing Touches

🧪 Generate unit tests

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

nv-guomingz · 2025-07-29T04:53:27Z

/bot run --stage-list "A10-Build_Docs"

tensorrt-cicd · 2025-07-29T04:58:42Z

PR_Github #13294 [ run ] triggered by Bot

tensorrt-cicd · 2025-07-29T05:42:41Z

PR_Github #13294 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #9931 (Partly Tested) completed with status: 'SUCCESS'

nv-guomingz · 2025-07-29T08:29:06Z

/bot skip --comment “doc build phase already pass”

tensorrt-cicd · 2025-07-29T08:34:21Z

PR_Github #13332 Bot args parsing error: usage: /bot [-h]
{run,kill,skip,submit,reviewers,reuse-pipeline,reuse-review} ...
/bot: error: unrecognized arguments: build phase already pass”

nv-guomingz · 2025-07-29T08:51:32Z

/bot skip --comment “doc build phase already pass”

tensorrt-cicd · 2025-07-29T08:56:57Z

PR_Github #13339 Bot args parsing error: usage: /bot [-h]
{run,kill,skip,submit,reviewers,reuse-pipeline,reuse-review} ...
/bot: error: unrecognized arguments: build phase already pass”

Superjomn

LGTM

… pytorch Signed-off-by: nv-guomingz <[email protected]>

nv-guomingz · 2025-07-29T14:25:41Z

/bot skip --comment “doc build phase already pass”

tensorrt-cicd · 2025-07-29T14:31:34Z

PR_Github #13376 Bot args parsing error: usage: /bot [-h]
{run,kill,skip,submit,reviewers,reuse-pipeline,reuse-review} ...
/bot: error: unrecognized arguments: build phase already pass”

nv-guomingz · 2025-07-29T14:39:12Z

/bot skip --comment "docs change, build phase already passed"

tensorrt-cicd · 2025-07-29T14:44:54Z

PR_Github #13378 [ skip ] triggered by Bot

tensorrt-cicd · 2025-07-29T15:01:19Z

PR_Github #13378 [ skip ] completed with state SUCCESS
Skipping testing for commit 4639092

NVIDIA#6428) Signed-off-by: nv-guomingz <[email protected]> Signed-off-by: Lanyu Liao <[email protected]>

nv-guomingz requested a review from a team as a code owner July 29, 2025 03:02

nv-guomingz requested a review from FrankD412 July 29, 2025 03:02

nv-guomingz requested a review from kaiyux July 29, 2025 03:02

coderabbitai bot requested review from litaotju and Superjomn July 29, 2025 03:02

coderabbitai bot added the Doc <NV>TRTLLM's textual/illustrative materials: API refs, guides, tutorials. Improvement & clarity. label Jul 29, 2025

FrankD412 approved these changes Jul 29, 2025

View reviewed changes

nv-guomingz force-pushed the user/guomingz/trtllm-bench-backend-doc branch from c463fd6 to c225462 Compare July 29, 2025 04:51

nv-guomingz force-pushed the user/guomingz/trtllm-bench-backend-doc branch from c225462 to 8a0eaec Compare July 29, 2025 08:28

nv-guomingz enabled auto-merge (squash) July 29, 2025 08:29

nv-guomingz force-pushed the user/guomingz/trtllm-bench-backend-doc branch from 8a0eaec to ea2eaf1 Compare July 29, 2025 08:51

Superjomn approved these changes Jul 29, 2025

View reviewed changes

doc: remove backend parameter for trtllm-bench when backend is set to…

4639092

… pytorch Signed-off-by: nv-guomingz <[email protected]>

nv-guomingz force-pushed the user/guomingz/trtllm-bench-backend-doc branch from ea2eaf1 to 4639092 Compare July 29, 2025 14:24

coderabbitai bot requested a review from Superjomn July 29, 2025 14:25

nv-guomingz merged commit 7231134 into NVIDIA:main Jul 29, 2025
3 checks passed

nv-guomingz deleted the user/guomingz/trtllm-bench-backend-doc branch July 29, 2025 15:01

coderabbitai bot mentioned this pull request Jul 29, 2025

chore: update trtllm-serve usage doc by removing backend parameter when it use torch as backend. #6419

Merged

lancelly pushed a commit to lancelly/TensorRT-LLM that referenced this pull request Aug 6, 2025

doc: remove backend parameter for trtllm-bench when backend is set to… (

95603c0

NVIDIA#6428) Signed-off-by: nv-guomingz <[email protected]> Signed-off-by: Lanyu Liao <[email protected]>

coderabbitai bot mentioned this pull request Aug 7, 2025

[TRTLLM-5930][doc] 1.0 Documentation. #6696

Merged

coderabbitai bot mentioned this pull request Aug 29, 2025

[None] [doc] Update DeepSeek example doc #7358

Merged

1 task

doc: remove backend parameter for trtllm-bench when backend is set to… #6428

doc: remove backend parameter for trtllm-bench when backend is set to… #6428

Uh oh!

Conversation

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

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 29, 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

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

nv-guomingz commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

nv-guomingz commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

nv-guomingz commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

Superjomn left a comment

Choose a reason for hiding this comment

Uh oh!

nv-guomingz commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

nv-guomingz commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

tensorrt-cicd commented Jul 29, 2025

Uh oh!

Uh oh!

Uh oh!

nv-guomingz commented Jul 29, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 29, 2025 •

edited

Loading