Skip to content

Drop the "newer than 2.15" marks from the TensorRT backend page - #24214

Merged
shoumikhin merged 1 commit into
pytorch:mainfrom
shoumikhin:tensorrt-docs-215-marks
Oct 28, 2026
Merged

shoumikhin merged 1 commit into
pytorch:mainfrom
shoumikhin:tensorrt-docs-215-marks

Conversation

@shoumikhin

@shoumikhin shoumikhin commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

The TensorRT backend page marked two features as needing a Torch-TensorRT build newer than 2.15: keeping the engines in a separate .ptd data file, and optimization profiles. Both are already in Torch-TensorRT 2.15, so the marks sent readers to a nightly build they do not need.

This change drops the marks and lists both as plain features, the same way the Torch-TensorRT guide describes them. The links to the guide sections are unchanged. Two intro lines now say that the engines are stored in the .pte by default, since the .ptd option is no longer marked as newer.

Checked on the Torch-TensorRT release/2.15 branch:

  • .ptd engines: external_engine_data in torch_tensorrt.save, and the delegate reads the engine from the data file passed at load time (data_path= in Python, Module(pte, ptd) in C++).
  • Optimization profiles: torch_tensorrt.Input(profiles=...) at export, and OptimizationProfileGuard in the delegate header.
  • The linked export scripts and reference runner programs, including the multi-profile ones, are the same files on release/2.15 as on main, so the links work for 2.15.

Docs only; no code changes.

Copilot AI balanced review requested due to automatic review settings October 27, 2026 20:57
@pytorch-bot

pytorch-bot Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/24214

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 13e0a80 with merge base 0549e1e (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Oct 27, 2026
@shoumikhin

Copy link
Copy Markdown
Contributor Author

@claude /pr-review

@claude

claude Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Claude finished @shoumikhin's task in 11m 1s —— View job


No blocking issues: the PR's 2.15 check doesn't cover part of each feature (low-confidence request to confirm), and two intro lines need a small wording fix.

Full review

PR Review: #24214

Summary

The PR drops the "newer than 2.15" marks from docs/source/backends/tensorrt/tensorrt-overview.md and lists .ptd engine files and optimization profiles as plain 2.15 features. The check in the PR description covers only one side of each feature. The other side could not be confirmed here, because CI has no access to the Torch-TensorRT sources. Two intro lines also still say the engines are always stored in the .pte.

API Design

  • Parts of what the marks covered are not confirmed for 2.15 (low confidence). tensorrt-overview.md:37-39, 431-442, 451-452. The description cites external_engine_data in torch_tensorrt.save (the export side) and OptimizationProfileGuard (the run side). The removed marks also covered:

    • the 2.15 delegate loading engines from the .ptd (data_path= in Python, Module(pte, ptd) in C++);
    • building one engine with several profiles at export time, which is what export_multi_profile.py (line 451) does;
    • the removed note on line 452, "the two multi-profile programs need a build newer than 2.15", which is about the reference runner programs. Both of these links point at pytorch/TensorRT main, not release/2.15.

    If any of these landed after release/2.15 was cut, a 2.15 user who follows these sections hits a failure, and the page no longer warns them. Please confirm all three are on release/2.15. If the main copies of the two examples could use newer APIs, point those two links at release/2.15. This could not be checked from CI, so it may already be fine.

Code Quality

  • tensorrt-overview.md:6 ("the engines are stored in the .pte file") and :19 ("One file holds the program and its engines") describe the default as the only behavior. That was true for 2.15 while the .ptd option was marked as newer, but line 37 now lists it as a 2.15 feature. Add "by default" to both lines. Fix this →

Recommendation

Approve

Nothing blocks. The 2.15 question needs only a one-line confirmation from the author, and the wording fix is minor.

The TensorRT backend page marked two features as needing a Torch-TensorRT build newer than 2.15:
keeping the engines in a separate .ptd data file, and optimization profiles. Both are in
Torch-TensorRT 2.15, so the marks sent readers to a nightly build they do not need.

The page now lists both as plain features, like the Torch-TensorRT guide does, and says that
the engines go in the .pte by default.
@shoumikhin
shoumikhin force-pushed the tensorrt-docs-215-marks branch from a41cb18 to 13e0a80 Compare October 28, 2026 00:37
Copilot AI balanced review requested due to automatic review settings October 28, 2026 00:37

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

@shoumikhin

Copy link
Copy Markdown
Contributor Author

Thanks, both points are addressed.

  1. Confirmed on the Torch-TensorRT release/2.15 branch. The delegate reads its engines from a .ptd file passed at load time (data_path= in Python, Module(pte, ptd) in C++). torch_tensorrt.Input(profiles=...) builds one engine with several profiles at export. The two multi-profile runner programs are there and built by the runner's CMake file. The linked export scripts and runner programs are the same files on release/2.15 and main, so the links stay on main.
  2. Added "by default" to both intro lines.

@shoumikhin
shoumikhin merged commit 8ecf0fb into pytorch:main Oct 28, 2026
214 checks passed
@shoumikhin

Copy link
Copy Markdown
Contributor Author

@pytorchbot cherry-pick --onto release/1.6 -c docs

@pytorchbot

Copy link
Copy Markdown
Collaborator

Cherry picking #24214

The cherry pick PR is at #24221

Details for Dev Infra team Raised by workflow job

Erik-Lundell pushed a commit to Erik-Lundell/executorch that referenced this pull request Oct 28, 2026
…rch#24214)

The TensorRT backend page marked two features as needing a
Torch-TensorRT build newer than 2.15: keeping the engines in a separate
`.ptd` data file, and optimization profiles. Both are already in
Torch-TensorRT 2.15, so the marks sent readers to a nightly build they
do not need.

This change drops the marks and lists both as plain features, the same
way the Torch-TensorRT guide describes them. The links to the guide
sections are unchanged. Two intro lines now say that the engines are
stored in the `.pte` by default, since the `.ptd` option is no longer
marked as newer.

Checked on the Torch-TensorRT `release/2.15` branch:

- `.ptd` engines: `external_engine_data` in `torch_tensorrt.save`, and
the delegate reads the engine from the data file passed at load time
(`data_path=` in Python, `Module(pte, ptd)` in C++).
- Optimization profiles: `torch_tensorrt.Input(profiles=...)` at export,
and `OptimizationProfileGuard` in the delegate header.
- The linked export scripts and reference runner programs, including the
multi-profile ones, are the same files on `release/2.15` as on `main`,
so the links work for 2.15.

Docs only; no code changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. release notes: docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants