KEMBAR78
[None][chore] AutoDeplopy: Update expert section on yaml configuration in README by lucaslie · Pull Request #8370 · NVIDIA/TensorRT-LLM · GitHub
Skip to content

Conversation

@lucaslie
Copy link
Member

@lucaslie lucaslie commented Oct 14, 2025

Summary by CodeRabbit

  • Documentation
    • Updated terminology from “YAML Configs” to “YAML Extra Configs” across examples.
    • Revised configuration precedence illustrations to reflect Extra Configs; clarified Default Config remains fixed.
    • Aligned nested config examples to use yaml-extra and args.yaml-extra.
    • Clarified loading of default.yaml via the yaml_default field (field-based mechanism).
    • Added note that yaml_default can overwrite the entire Inference Optimizer pipeline.
    • Improved wording on how built-in defaults merge with user configs and the impact of overwriting via yaml-default.

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.

Signed-off-by: Lucas Liebenwein <11156568+lucaslie@users.noreply.github.com>
@lucaslie lucaslie requested review from a team as code owners October 14, 2025 15:32
@lucaslie lucaslie self-assigned this Oct 14, 2025
@lucaslie
Copy link
Member Author

/bot skip --comment "readme changes only"

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

📝 Walkthrough

Walkthrough

Documentation-only update in examples/auto_deploy/README.md: replaces “YAML Configs” with “YAML Extra Configs,” revises precedence and nested configuration examples, clarifies use of the yaml_default field (including full pipeline overwrite), and adjusts wording on default merges and overwrite effects.

Changes

Cohort / File(s) Change Summary
Docs: Auto Deploy config terminology and precedence
examples/auto_deploy/README.md
Updated terminology to “YAML Extra Configs”; adjusted precedence illustrations; aligned nested keys to yaml-extra and args.yaml-extra; clarified loading via yaml_default for default.yaml; noted yaml_default can overwrite the entire pipeline; minor clarifications on defaults merging and overwrite behavior.

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 PR description is just the unused template with no actual summary, description of the change, test coverage details, or completed checklist items, so it fails to provide the required information. Please fill in the Description section with a concise explanation of what was changed and why, add relevant Test Coverage details, and ensure the PR Checklist items are addressed or marked as complete.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly indicates that this is a chore updating the YAML configuration guidance in the README, which aligns with the documentation changes in the pull request. It correctly uses the “[None][chore]” format and highlights the primary change to the auto‐deploy documentation.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent 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 0d20a8f and b04a9f6.

📒 Files selected for processing (1)
  • examples/auto_deploy/README.md (3 hunks)
🧰 Additional context used
🪛 LanguageTool
examples/auto_deploy/README.md

[grammar] ~283-~283: There might be a mistake here.
Context: ...riority) - Direct command line arguments 1. YAML Extra Configs - Files specified v...

(QB_NEW_EN)


[grammar] ~284-~284: There might be a mistake here.
Context: ... Files specified via --yaml-extra and --args.yaml-extra 1. YAML Default Config - (**do not change...

(QB_NEW_EN)


[grammar] ~285-~285: There might be a mistake here.
Context: ...iles specified via --yaml-default and --args.yaml-default 1. Default Settings (lowest priority) - B...

(QB_NEW_EN)

⏰ 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

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 #21370 [ skip ] triggered by Bot

@tensorrt-cicd
Copy link
Collaborator

PR_Github #21370 [ skip ] completed with state SUCCESS
Skipping testing for commit b04a9f6

@lucaslie lucaslie merged commit 43c46a0 into NVIDIA:main Oct 14, 2025
8 of 9 checks passed
govind-ramnarayan pushed a commit to nv-auto-deploy/TensorRT-LLM that referenced this pull request Oct 21, 2025
…n in README (NVIDIA#8370)

Signed-off-by: Lucas Liebenwein <11156568+lucaslie@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.

2 participants