KEMBAR78
[None][doc] Refine deployment guide by renaming TRT-LLM to TensorRT L… by nv-guomingz · Pull Request #8214 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@nv-guomingz
Copy link
Collaborator

@nv-guomingz nv-guomingz commented Oct 9, 2025

…LM and removing backend parameter.

1.0.0rc6 already set the default backend to PyTorch for trtllm-serve, so no need to specify it explicitly.

Summary by CodeRabbit

  • Documentation
    • Standardized terminology from “TRT-LLM” to “TensorRT LLM” across multiple quick-start deployment guides.
    • Updated section titles and narrative text to consistently reference “TensorRT LLM Server.”
    • Revised example commands by removing the deprecated “--backend pytorch” flag for clarity.
    • Adjusted example outputs and status messages to match the new naming.
    • Minor phrasing and readability improvements in troubleshooting and test sections.

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.

…LM and removing backend parameter.

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>
@nv-guomingz nv-guomingz requested a review from a team as a code owner October 9, 2025 06:13
@nv-guomingz
Copy link
Collaborator Author

/bot run

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 9, 2025

📝 Walkthrough

Walkthrough

Documentation updates across four deployment guides: standardized terminology from “TRT-LLM” to “TensorRT LLM,” adjusted section headings, removed the “--backend pytorch” flag from example trtllm-serve commands, and updated narrative/status examples accordingly. No code, API, or behavioral changes.

Changes

Cohort / File(s) Summary of changes
Docs: Terminology + command examples
docs/source/deployment-guide/quick-start-recipe-for-deepseek-r1-on-trtllm.md, docs/source/deployment-guide/quick-start-recipe-for-gpt-oss-on-trtllm.md, docs/source/deployment-guide/quick-start-recipe-for-llama3.3-70b-on-trtllm.md, docs/source/deployment-guide/quick-start-recipe-for-llama4-scout-on-trtllm.md
Renamed “TRT-LLM” to “TensorRT LLM” in headings and text; removed “--backend pytorch” from trtllm-serve examples; updated status/example response wording to match new terminology. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description Check ⚠️ Warning The pull request description does not follow the repository template because it lacks the properly formatted title at the top, leaves both the “Description” and “Test Coverage” sections empty, and retains template placeholders instead of real content. Please add a title that follows the “[JIRA ticket/…][type] Summary” format or use the @coderabbitai summary shortcut, move the provided narrative into the “Description” section, populate the “Test Coverage” section with relevant tests, and remove or replace the template comments before merging.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The pull request title follows the required template by including “[None][doc]” and succinctly describes the main change of renaming “TRT-LLM” to “TensorRT LLM” in the deployment guide, making it clear and directly related to the content of the changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • 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.

@tensorrt-cicd
Copy link
Collaborator

PR_Github #20858 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #20858 [ run ] completed with state SUCCESS
/LLM/main/L0_MergeRequest_PR pipeline #15775 completed with status: 'SUCCESS'

@nv-guomingz nv-guomingz merged commit a193867 into NVIDIA:main Oct 9, 2025
9 of 11 checks passed
kris1025 pushed a commit to kris1025/TensorRT-LLM that referenced this pull request Oct 14, 2025
NVIDIA#8214)

Signed-off-by: nv-guomingz <137257613+nv-guomingz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants