Skip to content

[TRTLLM-13782][doc] Remove legacy TensorRT docs and add migration guide#15767

Merged
Wanli-Jiang merged 2 commits into
NVIDIA:mainfrom
Wanli-Jiang:user/williamj/deprecated-trt-backend-step1p2
Jul 2, 2026
Merged

[TRTLLM-13782][doc] Remove legacy TensorRT docs and add migration guide#15767
Wanli-Jiang merged 2 commits into
NVIDIA:mainfrom
Wanli-Jiang:user/williamj/deprecated-trt-backend-step1p2

Conversation

@Wanli-Jiang

@Wanli-Jiang Wanli-Jiang commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Step 1.2 of removing the legacy TensorRT backend. Low-touch, docs-only:

  1. Delete the docs that are purely about the TensorRT engine mechanism.
  2. Keep every other legacy doc at its main content — no rewriting.
  3. Banner only the kept docs that are still specifically about the obsolete
    TensorRT engine mechanism; leave the rest untouched.
  4. Add a concise migration guide.
  • Scope: docs/ only. Zero Python/C++ source touched.
  • 30 files changed, +114 / −1522. Commit 46c9fb74f4.

Breakdown

Action Count
Deleted (pure-TRT files) 16
Modified — caution banner (obsolete TRT mechanism) 6
Modified — small link/de-link fix (no banner) 3
Modified — infra (toctree / notes / cross-ref) 4
Added (migration guide) 1
Total changed 30
Kept UNCHANGED from main (no banner, no edit) 19

1. Deleted (16) — pure TensorRT-backend files

File (docs/source/…) Why
commands/trtllm-build.rst autodoc for the removed trtllm-build CLI
legacy/python-api/tensorrt_llm.{functional,layers,models,plugin,quantization,runtime}.rst (6) autodoc of removed TRT modules
legacy/advanced/gpt-runtime.md TRT C++ runtime API
legacy/advanced/graph-rewriting.md TRT INetworkDefinition/ILayer graph rewriting
legacy/advanced/lora.md TRT LoRA-plugin build + weight conversion
legacy/advanced/open-sourced-cutlass-kernels.md TRT build-time kernel selection
legacy/advanced/weight-streaming.md trtllm-build weight streaming (no PyTorch support)
legacy/architecture/core-concepts.md TRT Builder/INetworkDefinition/plugins
legacy/reference/support-matrix.md TRT-engine model + hw/sw build matrix
legacy/tensorrt_quickstart.md TRT-engine quickstart (dead literalinclude)
legacy/performance/…/useful-build-time-flags.md TRT build-time / optimization-profile / plugin tuning

2. Bannered (6) — kept, but obsolete TRT engine mechanism

Each = main content + a caution admonition (below), placed after the H1.

The legacy TensorRT backend has been removed and is no longer supported. This page is retained for cross-reference only.
File Why bannered
architecture/checkpoint.md TRT checkpoint format + trtllm-build
architecture/workflow.md convert → trtllm-build → engine workflow
reference/precision.md QuantMode flags + TRT quant recipes/support matrix
reference/memory.md build-time activation memory / device_memory_size_v2 / TrtGptModel
performance/…/fp8-quantization.md tuning via BuildConfig.plugin_config (reduce-fusion / gemm / low-latency-gemm)
reference/troubleshooting.md register_network_output / trtllm-build engine debugging

3. Other modified

Small fixes (no banner):

File Fix
key-features.md LoRA bullet → ../features/lora.md (advanced/lora.md deleted)
architecture/add-model.md fixed pre-existing malformed workflow[./workflow.md] link
performance/…/tuning-max-batch-size-and-max-num-tokens.md de-linked 2 refs to the deleted useful-build-time-flags.md

(fp8-quantization.md, bannered above, similarly de-linked 3 such refs.)

Infra:

File Change
index.rst replace tensorrt_quickstart with the migration guide in the toctree
performance/…/index.rst drop the useful-build-time-flags toctree entry
release-notes.md add [BREAKING CHANGE] TensorRT backend removed note
torch/arch_overview.md drop stale PyExecutor "alternative backend" sentence

4. Added

legacy/tensorrt-backend-removal.md — concise migration guide: what changed
(removed-surface table), how to migrate (Python + CLI), and an index of the
retained reference docs.

5. Kept unchanged (19) — no banner

The remaining legacy docs are byte-identical to main. Their capability is still
live in the PyTorch backend or they are general knowledge / infrastructure:
gpt-attention, executor, expert-parallelism, kv-cache-management,
kv-cache-reuse, speculative-decoding, disaggregated-service,
lowprecision-pcie-allreduce, model-weights-loader,
perf-analysis, perf-benchmarking, benchmarking-default-performance,
deciding-model-sharding-strategy, introduction, useful-runtime-flags,
multimodal-feature-support-matrix, torch, and both dev-on-cloud/*.

6. Integrity

  • No dangling links to any of the 16 deleted files (swept).
  • Banners sit after each doc's H1, so pre-existing (label)= anchors still resolve.
  • All 23 retained-doc links in the migration guide resolve.
  • pre-commit passed (docs-only). No source touched.

Summary by CodeRabbit

  • New Features

    • Added a migration guide for users moving off the removed TensorRT backend.
    • Added documentation for low-precision AllReduce and updated the docs landing page.
  • Breaking Changes

    • TensorRT backend support has been removed; PyTorch is now the supported execution path.
  • Documentation

    • Updated links to point to current performance, attention, and KV cache guidance.
    • Removed many legacy docs pages and outdated API references.

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)

  • If PR introduces API changes, an appropriate PR label is added - either api-compatible or api-breaking. For api-breaking, include BREAKING in the PR title.

  • 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

To see a list of available CI bot commands, please comment /bot help.

@Wanli-Jiang Wanli-Jiang marked this pull request as ready for review June 30, 2026 08:21
@Wanli-Jiang Wanli-Jiang requested a review from a team as a code owner June 30, 2026 08:21
@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Removes all legacy TensorRT backend documentation pages, adds a new migration guide (tensorrt-backend-removal.md) detailing removed APIs and migration steps, wires it into the index under a "Migration" toctree, adds a breaking-change release note, and updates cross-references in blogs and feature docs to point to current locations.

Changes

TensorRT Backend Removal Documentation

Layer / File(s) Summary
New migration guide and index wiring
docs/source/legacy/tensorrt-backend-removal.md, docs/source/index.rst, docs/source/release-notes.md
Adds the full migration guide covering removed APIs, CLI tools, breaking-change contract table, before/after migration examples, and next-steps links. Replaces the "Use TensorRT Engine" toctree with a "Migration" section pointing to the new guide. Inserts a breaking-change bullet in the release notes.
Cross-reference and feature doc updates
docs/source/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md, docs/source/blogs/XQA-kernel.md, docs/source/features/lowprecision-allreduce.md, docs/source/index.rst, docs/source/torch/arch_overview.md, docs/source/torch/kv_cache_manager.md
Updates links in blogs and torch docs away from removed legacy pages; rewrites the lowprecision-allreduce usage section with an explicit allreduce_strategy snippet; adds features/lowprecision-allreduce.md to the features toctree.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, but it does not follow the required template and omits a Test Coverage section. Add the required title format plus the Description and Test Coverage sections, and keep the PR Checklist completed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change: removing legacy TensorRT docs and adding a migration guide.
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: 3

🤖 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/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md`:
- Around line 417-423: The performance tuning guidance mentions for both
max_batch_size and max_num_tokens are plain text and do not point readers to the
actual tuning guide. Update the relevant references in this blog section so the
“performance tuning guidance” text links directly to the existing tuning-guide
documentation, using the same link target wherever the guidance is referenced in
this passage.

In `@docs/source/legacy/tensorrt-backend-removal.md`:
- Around line 52-54: The link in the legacy TensorRT backend removal docs points
to a drifting GitHub tree URL instead of the local LLM API examples page. Update
the reference in the documentation snippet near the PyTorch model usage note to
use the in-repo LLM API docs link, keeping the mention of the LLM Python API
examples and the example names like quickstart_advanced.py and
quickstart_multimodal.py intact.

In `@docs/source/torch/arch_overview.md`:
- Around line 20-21: Update the architecture overview wording for the PyExecutor
path so it describes the PyTorch backend implementation directly rather than
calling it an alternative backend; revise the text near PyExecutor/Executor to
say the PyTorch backend uses PyExecutor as its implementation and remove any
“alternative backend” phrasing, keeping the description aligned with the current
LLM backend flow.
🪄 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: 8191e2d0-93a9-40da-88db-7e96e00a4f6c

📥 Commits

Reviewing files that changed from the base of the PR and between 2ed55d8 and 766073e.

⛔ Files ignored due to path filters (2)
  • docs/source/features/images/8x_l20_L40S_node_architecture.png is excluded by !**/*.png
  • docs/source/legacy/advanced/images/disaggregated-service_usage.png is excluded by !**/*.png
📒 Files selected for processing (52)
  • docs/source/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md
  • docs/source/blogs/XQA-kernel.md
  • docs/source/commands/trtllm-build.rst
  • docs/source/features/lowprecision-allreduce.md
  • docs/source/index.rst
  • docs/source/legacy/advanced/disaggregated-service.md
  • docs/source/legacy/advanced/executor.md
  • docs/source/legacy/advanced/expert-parallelism.md
  • docs/source/legacy/advanced/gpt-attention.md
  • docs/source/legacy/advanced/gpt-runtime.md
  • docs/source/legacy/advanced/graph-rewriting.md
  • docs/source/legacy/advanced/kv-cache-management.md
  • docs/source/legacy/advanced/kv-cache-reuse.md
  • docs/source/legacy/advanced/lora.md
  • docs/source/legacy/advanced/open-sourced-cutlass-kernels.md
  • docs/source/legacy/advanced/speculative-decoding.md
  • docs/source/legacy/advanced/weight-streaming.md
  • docs/source/legacy/architecture/add-model.md
  • docs/source/legacy/architecture/checkpoint.md
  • docs/source/legacy/architecture/core-concepts.md
  • docs/source/legacy/architecture/model-weights-loader.md
  • docs/source/legacy/architecture/workflow.md
  • docs/source/legacy/dev-on-cloud/build-image-to-dockerhub.md
  • docs/source/legacy/dev-on-cloud/dev-on-runpod.md
  • docs/source/legacy/key-features.md
  • docs/source/legacy/performance/perf-analysis.md
  • docs/source/legacy/performance/perf-benchmarking.md
  • docs/source/legacy/performance/performance-tuning-guide/benchmarking-default-performance.md
  • docs/source/legacy/performance/performance-tuning-guide/deciding-model-sharding-strategy.md
  • docs/source/legacy/performance/performance-tuning-guide/fp8-quantization.md
  • docs/source/legacy/performance/performance-tuning-guide/index.rst
  • docs/source/legacy/performance/performance-tuning-guide/introduction.md
  • docs/source/legacy/performance/performance-tuning-guide/tuning-max-batch-size-and-max-num-tokens.md
  • docs/source/legacy/performance/performance-tuning-guide/useful-build-time-flags.md
  • docs/source/legacy/performance/performance-tuning-guide/useful-runtime-flags.md
  • docs/source/legacy/python-api/tensorrt_llm.functional.rst
  • docs/source/legacy/python-api/tensorrt_llm.layers.rst
  • docs/source/legacy/python-api/tensorrt_llm.models.rst
  • docs/source/legacy/python-api/tensorrt_llm.plugin.rst
  • docs/source/legacy/python-api/tensorrt_llm.quantization.rst
  • docs/source/legacy/python-api/tensorrt_llm.runtime.rst
  • docs/source/legacy/reference/memory.md
  • docs/source/legacy/reference/multimodal-feature-support-matrix.md
  • docs/source/legacy/reference/precision.md
  • docs/source/legacy/reference/support-matrix.md
  • docs/source/legacy/reference/troubleshooting.md
  • docs/source/legacy/tensorrt-backend-removal.md
  • docs/source/legacy/tensorrt_quickstart.md
  • docs/source/legacy/torch.md
  • docs/source/release-notes.md
  • docs/source/torch/arch_overview.md
  • docs/source/torch/kv_cache_manager.md
💤 Files with no reviewable changes (44)
  • docs/source/legacy/reference/precision.md
  • docs/source/legacy/key-features.md
  • docs/source/legacy/performance/performance-tuning-guide/index.rst
  • docs/source/legacy/tensorrt_quickstart.md
  • docs/source/legacy/advanced/expert-parallelism.md
  • docs/source/legacy/python-api/tensorrt_llm.functional.rst
  • docs/source/legacy/python-api/tensorrt_llm.runtime.rst
  • docs/source/legacy/python-api/tensorrt_llm.plugin.rst
  • docs/source/legacy/advanced/disaggregated-service.md
  • docs/source/legacy/reference/support-matrix.md
  • docs/source/legacy/performance/performance-tuning-guide/introduction.md
  • docs/source/legacy/performance/perf-benchmarking.md
  • docs/source/legacy/advanced/weight-streaming.md
  • docs/source/legacy/performance/performance-tuning-guide/tuning-max-batch-size-and-max-num-tokens.md
  • docs/source/legacy/python-api/tensorrt_llm.models.rst
  • docs/source/legacy/performance/performance-tuning-guide/useful-runtime-flags.md
  • docs/source/legacy/python-api/tensorrt_llm.layers.rst
  • docs/source/legacy/advanced/graph-rewriting.md
  • docs/source/legacy/performance/performance-tuning-guide/benchmarking-default-performance.md
  • docs/source/legacy/python-api/tensorrt_llm.quantization.rst
  • docs/source/legacy/reference/multimodal-feature-support-matrix.md
  • docs/source/legacy/performance/perf-analysis.md
  • docs/source/commands/trtllm-build.rst
  • docs/source/legacy/architecture/model-weights-loader.md
  • docs/source/legacy/advanced/open-sourced-cutlass-kernels.md
  • docs/source/legacy/architecture/checkpoint.md
  • docs/source/legacy/advanced/lora.md
  • docs/source/legacy/advanced/gpt-runtime.md
  • docs/source/legacy/reference/troubleshooting.md
  • docs/source/legacy/advanced/executor.md
  • docs/source/legacy/architecture/workflow.md
  • docs/source/legacy/performance/performance-tuning-guide/useful-build-time-flags.md
  • docs/source/legacy/advanced/kv-cache-management.md
  • docs/source/legacy/advanced/speculative-decoding.md
  • docs/source/legacy/torch.md
  • docs/source/legacy/advanced/gpt-attention.md
  • docs/source/legacy/reference/memory.md
  • docs/source/legacy/architecture/core-concepts.md
  • docs/source/legacy/dev-on-cloud/build-image-to-dockerhub.md
  • docs/source/legacy/advanced/kv-cache-reuse.md
  • docs/source/legacy/architecture/add-model.md
  • docs/source/legacy/performance/performance-tuning-guide/deciding-model-sharding-strategy.md
  • docs/source/legacy/performance/performance-tuning-guide/fp8-quantization.md
  • docs/source/legacy/dev-on-cloud/dev-on-runpod.md

Comment thread docs/source/blogs/Best_perf_practice_on_DeepSeek-R1_in_TensorRT-LLM.md Outdated
Comment thread docs/source/legacy/tensorrt-backend-removal.md Outdated
Comment thread docs/source/torch/arch_overview.md Outdated
@Wanli-Jiang Wanli-Jiang force-pushed the user/williamj/deprecated-trt-backend-step1p2 branch 2 times, most recently from 66887fe to 9f9523b Compare June 30, 2026 08:54
@Wanli-Jiang

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56578 [ run ] triggered by Bot. Commit: 9f9523b Link to invocation

Comment thread docs/source/torch/arch_overview.md
Comment thread docs/source/legacy/tensorrt-backend-removal.md Outdated
@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56578 [ run ] completed with state SUCCESS. Commit: 9f9523b
/LLM/main/L0_MergeRequest_PR pipeline #45410 completed with status: 'SUCCESS'

CI Report

Link to invocation

@Wanli-Jiang Wanli-Jiang force-pushed the user/williamj/deprecated-trt-backend-step1p2 branch 2 times, most recently from 46c9fb7 to a73a87f Compare July 1, 2026 08:27
Comment thread docs/source/release-notes.md Outdated

@nv-guomingz nv-guomingz left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Overall LGTM, awesome work.

@Wanli-Jiang

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56888 [ run ] triggered by Bot. Commit: a73a87f Link to invocation

@Wanli-Jiang Wanli-Jiang force-pushed the user/williamj/deprecated-trt-backend-step1p2 branch from a73a87f to 97bfcb0 Compare July 1, 2026 08:53
…tion guide

Prune the docs/source/legacy/ TensorRT-era documentation now that the TensorRT
backend is removed.

Delete the docs that are purely about the TensorRT engine mechanism:
commands/trtllm-build.rst, the six python-api autodoc stubs, advanced/gpt-runtime,
advanced/graph-rewriting, advanced/lora, advanced/open-sourced-cutlass-kernels,
advanced/weight-streaming, architecture/core-concepts, reference/support-matrix,
tensorrt_quickstart, and performance/.../useful-build-time-flags.

Keep every other legacy doc at its original content for cross-reference. Add a
caution banner to the six kept docs still specifically about the obsolete TensorRT
engine mechanism (checkpoint, workflow, precision, memory, fp8-quantization,
troubleshooting); leave the rest unbannered. A few link/toctree fixes are forced
by the deletions.

Add docs/source/legacy/tensorrt-backend-removal.md migration guide (removed-surface
table, how-to-migrate, retained-doc index), add a release-note entry, and drop the
stale PyExecutor "alternative backend" sentence in torch/arch_overview.md.

No Python/C++ source touched.

Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
Enable the MyST `html_inline` extension in docs/source/conf.py and wrap the
"[BREAKING CHANGE] TensorRT backend removed" label in an inline
`<span style="color: red">` so it renders red in the HTML documentation.

Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
@Wanli-Jiang Wanli-Jiang force-pushed the user/williamj/deprecated-trt-backend-step1p2 branch from 97bfcb0 to 0a23609 Compare July 1, 2026 08:56
@Wanli-Jiang

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56892 [ run ] triggered by Bot. Commit: 0a23609 Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56888 [ run ] completed with state ABORTED. Commit: a73a87f

Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56892 [ run ] completed with state FAILURE. Commit: 0a23609
/LLM/main/L0_MergeRequest_PR pipeline #45701 completed with status: 'FAILURE'

CI Report

⚠️ Action Required:

  • Please check the failed tests and fix your PR
  • If you cannot view the failures, ask the CI triggerer to share details
  • Once fixed, request an NVIDIA team member to trigger CI again

CI Agent Failure Analysis

Link to invocation

@Wanli-Jiang

Copy link
Copy Markdown
Collaborator Author

/bot run --disable-fail-fast

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56897 [ run ] triggered by Bot. Commit: 0a23609 Link to invocation

@tensorrt-cicd

Copy link
Copy Markdown
Collaborator

PR_Github #56897 [ run ] completed with state SUCCESS. Commit: 0a23609
/LLM/main/L0_MergeRequest_PR pipeline #45706 completed with status: 'SUCCESS'

CI Report

Link to invocation

@Wanli-Jiang Wanli-Jiang merged commit 281acfd into NVIDIA:main Jul 2, 2026
7 checks passed
evezhier pushed a commit to evezhier/TensorRT-LLM that referenced this pull request Jul 2, 2026
…de (NVIDIA#15767)

Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@users.noreply.github.com>
BrianLi23 pushed a commit to BrianLi23/TensorRT-LLM that referenced this pull request Jul 9, 2026
…de (NVIDIA#15767)

Signed-off-by: Wanli Jiang <35160485+Wanli-Jiang@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.

3 participants