Skip to content

[None][doc] Document TensorRT LLM binary compatibility - #17244

Open
zcxGGmu wants to merge 2 commits into
NVIDIA:mainfrom
zcxGGmu:docs/trtllm-binary-compat
Open

[None][doc] Document TensorRT LLM binary compatibility#17244
zcxGGmu wants to merge 2 commits into
NVIDIA:mainfrom
zcxGGmu:docs/trtllm-binary-compat

Conversation

@zcxGGmu

@zcxGGmu zcxGGmu commented Aug 4, 2026

Copy link
Copy Markdown

Summary

  • Add a binary compatibility note to the container documentation.
  • Document that TensorRT LLM Python bindings and native libraries must come from the same release.
  • Call out the specific shared objects that should not be mixed across release tags.

Test Plan

  • Static doc smoke check for the new section and required library names
  • git diff --check
  • Not run: full Sphinx build (python -m sphinx --version fails locally with No module named sphinx)

Refs #10016

Dev Engineer Review

  • Added a Binary Compatibility section to docs/source/installation/containers.md.
  • Documents that TensorRT LLM Python packages, bindings, and native libraries must use the same release.
  • Identifies shared libraries that must not be mixed across release tags.
  • Requires replacing the complete environment or rebuilding when changing releases or adding runtime features.
  • Added the standard 2026 NVIDIA SPDX header.
  • Preserved the (build-containers)= anchor and document title.
  • No code, configuration, API, or test-list changes.
  • git diff --check and static documentation checks passed.
  • Full Sphinx validation was not run because Sphinx was unavailable locally.

QA Engineer Review

No test changes.

Signed-off-by: zq <zhouquan1511@163.com>
@zcxGGmu
zcxGGmu requested a review from a team as a code owner August 4, 2026 06:59
@zcxGGmu
zcxGGmu requested review from arysef and chang-l August 4, 2026 06:59
@coderabbitai

coderabbitai Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: ab3c9e75-f113-4749-9473-54854b0918d2

📥 Commits

Reviewing files that changed from the base of the PR and between c3ebee2 and e0bf62d.

📒 Files selected for processing (1)
  • docs/source/installation/containers.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/source/installation/containers.md

Walkthrough

The container installation documentation adds a license header and binary compatibility guidance. It requires matching TensorRT LLM packages, bindings, and native libraries. It also specifies full environment replacement or rebuilding for upgrades and runtime feature changes.

Changes

Binary compatibility documentation

Layer / File(s) Summary
Document binary compatibility requirements
docs/source/installation/containers.md
Adds the SPDX license header and documents matching TensorRT LLM component versions, affected shared libraries, and full replacement or rebuild procedures.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: arysef, chang-l

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format and clearly describes the documentation change.
Description check ✅ Passed The description explains the change and validation plan, but it omits the template checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/source/installation/containers.md`:
- Line 29: Add the standard NVIDIA copyright header at the beginning of
containers.md, using the updated year 2026 and preserving the existing document
content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 177102b8-24de-4ad5-be84-57aeed62d455

📥 Commits

Reviewing files that changed from the base of the PR and between 6af4e0b and c3ebee2.

📒 Files selected for processing (1)
  • docs/source/installation/containers.md

Comment thread docs/source/installation/containers.md
Signed-off-by: zq <zhouquan1511@163.com>
@zcxGGmu

zcxGGmu commented Aug 5, 2026

Copy link
Copy Markdown
Author

Thanks for the review — I pushed e0bf62db4 addressing the feedback.

Changes made:

  • Added the standard 2026 NVIDIA SPDX copyright/license header to docs/source/installation/containers.md.
  • Preserved the existing (build-containers)= anchor and document title.

Validation:

  • python static documentation guard checks — passed for header, anchor, title, and balanced code fences.
  • git diff --check — passed.
  • Added-line secret scan — passed.

Note: Full Sphinx docs build was not run locally because sphinx is not installed in this environment.

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