Skip to content

Conversation

@Superjomn
Copy link
Collaborator

@Superjomn Superjomn commented Oct 14, 2025

Summary by CodeRabbit

The page outline changes:
image

  • Documentation
    • Added an “API Change Principles” guide covering clear argument/knob naming, hierarchical configuration, preferring runtime arguments over environment variables, and best practices for stability, deprecation, annotation, and migration.
    • Expanded guidance on documenting and managing API changes for consistency and clarity.
    • No functional or behavioral changes to the product.

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.

Details

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.

@Superjomn Superjomn requested a review from a team as a code owner October 14, 2025 04:05
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

📝 Walkthrough

Walkthrough

Documentation update adding an "API Change Principles" section that covers knob naming, hierarchical configuration, preference for LlmArgs over environment variables, and guidance on API stability, annotation, and migration. No code changes.

Changes

Cohort / File(s) Summary of Changes
Docs: API change guidelines
docs/source/developer-guide/api-change.md
Added guidance on knob naming, configuration hierarchy, preferring LlmArgs over env vars, and practices for API stability, annotation, and migration.

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 is largely incomplete. While the PR title "[None][doc] Add LLM-API API change principle" is present and follows the required format, the critical Description and Test Coverage sections are entirely empty—containing only placeholder HTML comments with no actual content. The author appears to have submitted the template itself without filling in the required explanatory sections. The PR Checklist includes one checked item but no substantive explanation of what changes are being made, why they are necessary, or what tests validate the documentation changes. The author should update the PR description by completing the Description section with a clear explanation of the "API Change Principles" being documented and the rationale for these additions, and the Test Coverage section with information about any documentation validation or review processes. The Description should reference the specific content added to docs/source/developer-guide/api-change.md and explain how it benefits the project's API design guidelines.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly indicates that this is a documentation change to add an API change principle and correctly uses the conventional “[None][doc]” prefix, succinctly summarizing the main intent of the PR.
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.

@Superjomn
Copy link
Collaborator Author

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

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21299 [ run ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

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

@Superjomn Superjomn force-pushed the api.api-principle branch 3 times, most recently from 3732de4 to 9ea0f73 Compare November 3, 2025 02:21
@Superjomn
Copy link
Collaborator Author

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

Signed-off-by: Yan Chunwei <328693+Superjomn@users.noreply.github.com>
@Superjomn
Copy link
Collaborator Author

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

@tensorrt-cicd
Copy link
Collaborator

PR_Github #23316 [ run ] triggered by Bot. Commit: 6fd4e81

@tensorrt-cicd
Copy link
Collaborator

PR_Github #23317 [ run ] triggered by Bot. Commit: 6fd4e81

@tensorrt-cicd
Copy link
Collaborator

PR_Github #23316 [ run ] completed with state ABORTED. Commit: 6fd4e81
LLM/main/L0_MergeRequest_PR #17569 (Blue Ocean) completed with status: ABORTED

Copy link
Collaborator

@QiJune QiJune left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tensorrt-cicd
Copy link
Collaborator

PR_Github #23317 [ run ] completed with state SUCCESS. Commit: 6fd4e81
/LLM/main/L0_MergeRequest_PR pipeline #17570 (Partly Tested) completed with status: 'SUCCESS'

@Superjomn
Copy link
Collaborator Author

/bot skip --comment "just doc change"

Copy link
Collaborator Author

@Superjomn Superjomn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated.

@Superjomn Superjomn enabled auto-merge (squash) November 3, 2025 09:12
@tensorrt-cicd
Copy link
Collaborator

PR_Github #23368 [ skip ] triggered by Bot. Commit: 6fd4e81

@tensorrt-cicd
Copy link
Collaborator

PR_Github #23368 [ skip ] completed with state SUCCESS. Commit: 6fd4e81
Skipping testing for commit 6fd4e81

@Superjomn Superjomn merged commit 271a981 into NVIDIA:main Nov 3, 2025
6 of 7 checks passed
fredricz-20070104 pushed a commit to fredricz-20070104/TensorRT-LLM that referenced this pull request Nov 5, 2025
Signed-off-by: Yan Chunwei <328693+Superjomn@users.noreply.github.com>
Signed-off-by: FredricZ-2007 <226039983+fredricz-20070104@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.

4 participants