[TRTC-1965] [feat] Add config db and docs

[venkywonka]

Description

• [x] Clean #9272 schema and rebase this PR on top
• [x] Include config db packaging
• [ ] Reflect #9104 in docs
• [x] Add script to generate RST table
• [x] Expose the table in deployment guides (DSR1, gpt-oss) and landing page
• [x] Add a test to ensure the rst table is synchronized with recipe db

@coderabbitai summary

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

• Update tava architecture diagram if there is a significant design change in PR.

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

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #25663 [ run ] triggered by Bot. Commit: 1b1c3d0

[tensorrt-cicd]

PR_Github #25663 [ run ] completed with state FAILURE. Commit: 1b1c3d0 LLM/main/L0_MergeRequest_PR #19449 (Blue Ocean) completed with status: ABORTED

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #25762 [ run ] triggered by Bot. Commit: 1b1c3d0

[tensorrt-cicd]

PR_Github #25762 [ run ] completed with state SUCCESS. Commit: 1b1c3d0 /LLM/main/L0_MergeRequest_PR pipeline #19536 completed with status: 'FAILURE'

[venkywonka]

/bot run

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #26500 [ run ] triggered by Bot. Commit: a7caee1

[tensorrt-cicd]

PR_Github #26502 [ run ] triggered by Bot. Commit: a7caee1

[tensorrt-cicd]

PR_Github #26500 [ run ] completed with state ABORTED. Commit: a7caee1

[tensorrt-cicd]

PR_Github #26502 [ run ] completed with state SUCCESS. Commit: a7caee1 /LLM/main/L0_MergeRequest_PR pipeline #20151 completed with status: 'FAILURE'

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #26646 [ run ] triggered by Bot. Commit: 3e9f3cf

[tensorrt-cicd]

PR_Github #26646 [ run ] completed with state FAILURE. Commit: 3e9f3cf /LLM/main/L0_MergeRequest_PR pipeline #20272 completed with status: 'FAILURE'

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #26653 [ run ] triggered by Bot. Commit: 4410ad8

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #26656 [ run ] triggered by Bot. Commit: e2c3952

[tensorrt-cicd]

PR_Github #26653 [ run ] completed with state ABORTED. Commit: 4410ad8 LLM/main/L0_MergeRequest_PR #20279 (Blue Ocean) completed with status: ABORTED

[tensorrt-cicd]

PR_Github #26656 [ run ] completed with state SUCCESS. Commit: e2c3952 /LLM/main/L0_MergeRequest_PR pipeline #20282 completed with status: 'SUCCESS' Pipeline passed with automatic retried tests. Check the rerun report for details.

[FrankD412]

Since we're moving away from presenting these recipes in a CLI, does it make sense that these recipes are packaged within the tensorrt_llm package now? I know that there's been progress towards making TRT-LLM installable via a wheel entirely, so these would be packaged in the wheel but never explicitly used by TRT-LLM.

[coderabbitai[bot]]

📝 Walkthrough

Walkthrough

This pull request establishes a YAML-based deployment configuration database and documentation generation infrastructure. It adds data models for recipe management, a utility script to generate deployment documentation from YAML scenarios, and updates deployment guides with specific Docker image tags (1.2.0rc5) and references to preconfigured recipes. The changes enable consistent documentation of GPU deployment profiles across multiple models.

Changes

Cohort / File(s)	Summary
Docker Image Tag Updates docs/source/commands/trtllm-serve/run-benchmark-with-trtllm-serve.md, docs/source/deployment-guide/deployment-guide-for-deepseek-r1-on-trtllm.md, docs/source/deployment-guide/deployment-guide-for-gpt-oss-on-trtllm.md, docs/source/deployment-guide/deployment-guide-for-llama3.3-70b-on-trtllm.md, docs/source/deployment-guide/deployment-guide-for-llama4-scout-on-trtllm.md, docs/source/quick-start-guide.md	Updated TensorRT-LLM container image tag from placeholder x.y.z to concrete version 1.2.0rc5 across multiple deployment documentation files.
Configuration Database Infrastructure tensorrt_llm/configure/database.py, tensorrt_llm/configure/database/scenario_list.yaml, setup.py	Introduced new database module with Pydantic models (RecipeConstraints, Recipe, RecipeList) for managing deployment scenarios loaded from YAML. Added scenario_list.yaml containing configuration entries for multiple models across various GPUs and performance targets. Updated package data in setup.py to include YAML files under configure/database/.
Documentation Generation and Indexing scripts/generate_config_table.py, docs/source/deployment-guide/comprehensive_table.rst, docs/source/deployment-guide/index.rst, .gitignore	Added Python utility script to parse scenario database and generate reStructuredText documentation. Generated comprehensive deployment table with GPU profiles, latency targets, and serve commands. Updated deployment guide index to reference both curated examples and comprehensive database. Unignored comprehensive_table.rst in .gitignore.
Deployment Guide Enhancements docs/source/deployment-guide/deployment-guide-for-deepseek-r1-on-trtllm.md, docs/source/deployment-guide/deployment-guide-for-gpt-oss-on-trtllm.md	Added "Preconfigured Recipes" sections with include directives linking to comprehensive configuration tables; updated formatting (italic vs. bold descriptions).
Code Updates tensorrt_llm/llmapi/llm_args.py	Added validator method coerce_env_overrides_to_str to BaseLlmArgs to normalize environment override keys and values to strings before validation.
Test Coverage tests/unittest/tools/test_generate_config_table.py	Added unit test to validate synchronization between scenario_list.yaml and generated comprehensive_table.rst documentation.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

• Attention areas:
  • Data model correctness in tensorrt_llm/configure/database.py (RecipeConstraints, Recipe, RecipeList): verify Pydantic field definitions, validation behavior, and pandas conversion logic
  • scripts/generate_config_table.py: review YAML parsing, performance profile heuristics (Min Latency / Balanced / Max Throughput assignment), and RST output formatting
  • Consistency between scenario_list.yaml structure and database model expectations; verify all entries conform to schema
  • Validator method in llm_args.py: ensure env_overrides coercion handles edge cases and doesn't inadvertently modify user-provided values
  • Test coverage in test_generate_config_table.py: verify it adequately catches drift between database and generated documentation

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	PR description includes high-level checklist items but lacks detailed explanation of the issue, solution, test coverage, and PR title formatting.	Add a properly formatted PR title ([ticket][type] summary), detailed description explaining the issue and solution, and explicit test coverage section.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Title check	✅ Passed	The title '[TRTC-43] [feat] Add config db and docs' accurately summarizes the main changes, which include adding a configuration database, documentation files, and related utilities.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[venkywonka]

/bot run

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #27453 [ run ] triggered by Bot. Commit: 2251fec

[tensorrt-cicd]

PR_Github #27453 [ run ] completed with state DISABLED L0 testing is limited to prioritized users. User venkywonka is not in the prioritized list. L0 testing cannot be triggered.

[venkywonka]

/bot run

[tensorrt-cicd]

PR_Github #27549 [ run ] triggered by Bot. Commit: c36cc31

[tensorrt-cicd]

PR_Github #27549 [ run ] completed with state FAILURE. Commit: c36cc31 LLM/main/L0_MergeRequest_PR #21026 (Blue Ocean) completed with status: ABORTED