[TRTLLM-9299][infra] Add third-party docs for python #9366
Conversation
In this change we rename 3rdparty/README.md (which contains the process playboook for C++ dependencies) to 3rdparty/cpp-thirdparty.md and add a new 3rdparty/py-thirdparty.md file which contains the process playbook for python dependencies. We also update the main 3rdparty/README.md file to serve as a starting-point referring to both of these files. Signed-off-by: Josh Bialkowski <[email protected]>
📝 WalkthroughWalkthroughRefactors third-party dependency documentation by condensing the main README to reference specialized guides, then adds comprehensive documentation for integrating C/C++ and Python third-party dependencies into the TensorRT-LLM build and container systems. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10–15 minutes
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
3rdparty/cpp-thirdparty.md (2)
24-24: Clean up GitHub reference links for consistency and formatting.Several reference links have formatting inconsistencies:
- Line 24 ends with a period (should be removed from markdown reference).
- Lines 176 and 240 contain double slashes (
//cppand//3rdparty) and unnecessary?ref_type=headsquery parameters that add no value for documentation readers.For cleaner, more consistent references, remove the trailing period from line 24 and simplify the GitHub URLs in lines 176 and 240 to use standard paths without query parameters.
Also applies to: 38-38, 51-51, 62-62, 81-81, 82-82, 108-108, 109-109, 175-175, 176-176, 240-240, 241-241, 242-242
59-59: Minor wordiness opportunities in static analysis.LanguageTool flagged a few phrases that could be tightened:
- Line 59: "prior to configuring" → "before configuring"
- Line 114: "absolutely required" → "required"
- Lines 127 & 171: "outside of" → "outside"
These are style preferences and the current phrasing is acceptable; apply only if aligning with project conventions.
Also applies to: 114-114, 127-127, 171-171
3rdparty/py-thirdparty.md (1)
27-27: Apply compound adjective formatting: "third-party" (not "3rd party").Line 27 uses "3rd party" where the compound adjective "third-party" would be more consistent with the rest of the documentation (e.g., line 24) and align with standard technical writing conventions.
Apply this fix:
-1. File an OSRB request to fork/contribute to a 3rd party open source package. +1. File an OSRB request to fork/contribute to a third-party open source package.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
3rdparty/README.md(1 hunks)3rdparty/cpp-thirdparty.md(1 hunks)3rdparty/py-thirdparty.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: yibinl-nvidia
Repo: NVIDIA/TensorRT-LLM PR: 6506
File: examples/models/core/mixtral/requirements.txt:3-3
Timestamp: 2025-08-01T15:14:45.673Z
Learning: In TensorRT-LLM, examples directory can have different dependency versions than the root requirements.txt file. Version conflicts between root and examples dependencies are acceptable because examples are designed to be standalone and self-contained.
Learnt from: farshadghodsian
Repo: NVIDIA/TensorRT-LLM PR: 7101
File: docs/source/blogs/tech_blog/blog9_Deploying_GPT_OSS_on_TRTLLM.md:36-36
Timestamp: 2025-08-21T00:16:56.457Z
Learning: TensorRT-LLM container release tags in documentation should only reference published NGC container images. The README badge version may be ahead of the actual published container versions.
📚 Learning: 2025-09-09T18:31:44.336Z
Learnt from: venkywonka
Repo: NVIDIA/TensorRT-LLM PR: 7658
File: .github/CODEOWNERS:160-164
Timestamp: 2025-09-09T18:31:44.336Z
Learning: The teams NVIDIA/trt-llm-release-nim-branch-approval and NVIDIA/trt-llm-release-branch-approval exist in the NVIDIA organization and are valid for use in .github/CODEOWNERS files, even if they may not be accessible via external API queries due to permissions.
Applied to files:
3rdparty/README.md3rdparty/cpp-thirdparty.md
📚 Learning: 2025-08-01T15:14:45.673Z
Learnt from: yibinl-nvidia
Repo: NVIDIA/TensorRT-LLM PR: 6506
File: examples/models/core/mixtral/requirements.txt:3-3
Timestamp: 2025-08-01T15:14:45.673Z
Learning: In TensorRT-LLM, examples directory can have different dependency versions than the root requirements.txt file. Version conflicts between root and examples dependencies are acceptable because examples are designed to be standalone and self-contained.
Applied to files:
3rdparty/py-thirdparty.md
🪛 LanguageTool
3rdparty/cpp-thirdparty.md
[style] ~59-~59: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ring virtual environment initialization prior to configuring the build with cmake. Inclu...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
[style] ~114-~114: ‘absolutely required’ might be wordy. Consider a shorter alternative.
Context: ...d below don't work and git-submodule is absolutely required, please add the submodule under the 3rd...
(EN_WORDINESS_PREMIUM_ABSOLUTELY_REQUIRED)
[style] ~127-~127: This phrase is redundant. Consider using “outside”.
Context: ...equiring an additional step managed outside of CMake. 2. The fetch, patch, and build...
(OUTSIDE_OF)
[style] ~171-~171: This phrase is redundant. Consider using “outside”.
Context: ...dd_library/find_file/find_path` outside of a find module the package. Please add ...
(OUTSIDE_OF)
3rdparty/py-thirdparty.md
[uncategorized] ~27-~27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...quest to fork/contribute to a 3rd party open source package. https://confluence.nvidia.c...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
⏰ 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
🔇 Additional comments (3)
3rdparty/cpp-thirdparty.md (1)
1-337: Excellent comprehensive guide for C/C++ third-party dependency integration.The documentation provides clear, step-by-step guidance across all major integration patterns (Debian packages, pip, tarballs, conan, CMake-based sources). The rationale for preferring FetchContent/ExternalProject over git-submodules is well-articulated, and the license/attribution workflow is thorough. Structure and examples are easy to follow.
3rdparty/README.md (1)
1-13: Clean refactoring of README to hub-and-spoke pattern.The condensed README now serves as an effective entry point, clearly directing readers to language-specific dependency guides. The relative links are properly formatted, and the descriptions accurately summarize each document's scope. This improves discoverability and maintainability.
3rdparty/py-thirdparty.md (1)
1-69: Excellent complementary guide for Python dependency workflows.This document provides clear, actionable steps for the three primary Python dependency scenarios (unmodified, modified, individual sources). The emphasis on transitive dependency tracking in ATTRIBUTIONS-Python.md and the integration with OSRB processes provides good compliance guardrails. The notes on packaging behavior (pip/uv vs. container) add helpful context. Structure parallels the C++ guide well.
|
/bot run |
|
PR_Github #25389 [ run ] triggered by Bot. Commit: |
|
PR_Github #25389 [ run ] completed with state |
3 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.
Description
In this change we rename 3rdparty/README.md (which contains the process playboook for C++ dependencies) to 3rdparty/cpp-thirdparty.md and add a new 3rdparty/py-thirdparty.md file which contains the process playbook for python dependencies.
We also update the main 3rdparty/README.md file to serve as a starting-point referring to both of these files.
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 thestage-listparameter 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.mdand the
scripts/test_to_stage_mapping.pyhelper.kill
killKill all running builds associated with pull request.
skip
skip --comment COMMENTSkip 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-pipelineReuse 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.