Repository navigation
Update the TensorRT backend docs page - #24136
Draft
shoumikhin wants to merge 1 commit into
Draft
shoumikhin wants to merge 1 commit into
shoumikhin wants to merge 1 commit into
Conversation
The TensorRT backend page had drifted away from Torch-TensorRT, which builds the delegate. It pointed readers at a nightly build from early October in a "Feature availability" section. It said that CUDA graph replay never runs for engines on the shared activation scratch, which nightly builds now do. It carried its own install command, one of several that disagreed with each other. It also repeated most of the Torch-TensorRT deployment guide, so every change to the delegate had to be made in two places, and the backends table listed TensorRT as Linux only. The page keeps the usual backend sections but says less in each: features, target and development requirements, export, runtime integration, and a short list of performance options. For installing, it links to the install section of the Torch-TensorRT guide instead of carrying a command, and each option links to its section of that guide. The stale section is gone. What still needs a Torch-TensorRT nightly build is marked as such: engines in a separate data file, optimization profiles, CUDA graph replay on the shared scratch, and setting runtime options from Python. The page and the backends table now list Windows, marked as needing a nightly build because the Torch-TensorRT 2.15 release candidate publishes no Windows delegate, and the page states the limits the CUDA backend has there. Tested on Linux x86-64 with an H100: ran every Python block of the page in order with nightly Torch-TensorRT, which exports and runs the plain, coalesced and GPU-resident programs, and built and ran the C++ example against the installed wheels with the CMake recipe from the page. Checked these 2.15 differences against the Torch-TensorRT 2.15.0 release candidate: the re-export default, the missing data file option, the Python runtime options, and a CPU input to a GPU-resident program. Windows was not tested. The page builds with Sphinx and MyST with no warnings.
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/executorch/24136
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 950de92 with merge base 00f0654 ( This comment was automatically generated by Dr. CI and updates every 15 minutes. |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a draft because some links on the page go to Torch-TensorRT guide sections that only exist after pytorch/TensorRT#4927 merges and the Torch-TensorRT docs site is rebuilt. It should also wait until the install command in the Torch-TensorRT guide installs Torch-TensorRT 2.15 with its delegate, because this page describes 2.15 and newer.
The TensorRT backend page had drifted away from Torch-TensorRT, which builds and ships the delegate. It pointed readers at a nightly build from early October in a "Feature availability" section, and it said that CUDA graph replay never runs for engines on the shared activation scratch, which nightly builds now do. It carried its own install command, one of several that disagreed with each other. It also repeated most of the Torch-TensorRT deployment guide, so every change to the delegate had to be made in two places, and the backends table listed TensorRT as Linux only.
The page keeps the usual backend sections but says less in each: features, target and development requirements, export, runtime integration, and a short list of performance options. For installing, it links to the install section of the Torch-TensorRT guide, and each performance option links to its section of that guide. The page says it describes Torch-TensorRT 2.15 and newer, and marks what still needs a nightly build: engines in a separate data file, optimization profiles, CUDA graph replay on the shared scratch, setting runtime options from Python, and Windows, because the 2.15 release candidate publishes no Windows delegate. It also states the limits of the CUDA backend on Windows.
Tested on Linux x86-64 with an H100: ran every Python block of the page in order with nightly Torch-TensorRT, which exports and runs the plain, split and GPU-resident programs, and built and ran the C++ example against the installed packages with the CMake recipe from the page. Checked these 2.15 differences against the Torch-TensorRT 2.15.0 release candidate: the re-export default, the missing data file option, the Python runtime options, and a CPU input to a GPU-resident program. Windows was not tested. The page builds with Sphinx and MyST with no new warnings.