Skip to content

Add documentation for NV TensorRT RTX ExecutionProvider #24829

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 9, 2025

Conversation

ankan-ban
Copy link
Contributor

Description

Add documentation for NV TensorRT RTX ExecutionProvider

Motivation and Context

The EP is already online. This is for adding some basic documentation for the options / features exposed by the EP.

@ankan-ban
Copy link
Contributor Author

Tagging @chilo-ms @gedoensmax @ishwar-raut1 for review.

@ankan-ban
Copy link
Contributor Author

@chilo-ms @jywu-msft any comments or suggestions ? (Not sure why the tests are failing).

@jywu-msft jywu-msft requested a review from Copilot June 3, 2025 19:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds documentation for the NV TensorRT RTX ExecutionProvider, providing detailed instructions and code examples for both C++ and Python users.

  • Introduces a new markdown file with installation, build, usage, configurations, and performance tuning sections.
  • Provides illustrative code snippets and explanations for session options and EP caching mechanisms.
Comments suppressed due to low confidence (2)

docs/execution-providers/TensorRTRTX-ExecutionProvider.md:18

  • There is an extra preposition in the phrasing; consider revising to "to accelerate ONNX models on RTX GPUs".
to accelerate ONNX model in on RTX GPUs.

docs/execution-providers/TensorRTRTX-ExecutionProvider.md:63

  • [nitpick] The link appears to reference a file with a slightly different name than the current document; consider updating it to 'TensorRTRTX-ExecutionProvider.md' for consistency.
Here are examples and different [scenarios](./TensorRT-RTXExecutionProvider.md#scenario) to set NV TensorRT RTX EP session options:

@jywu-msft
Copy link
Member

LGTM. there are some known existing bad links which cause the failure. need to fix those. but should be unrelated to your doc

jywu-msft
jywu-msft previously approved these changes Jun 4, 2025
@jywu-msft
Copy link
Member

we need to fix the other broken link checks, but looks like there are some errors for the new page you adding

For the Links > Internal check, the following failures were found:

  • At ./_site/docs/execution-providers/TensorRTRTX-ExecutionProvider.html:1:

    internally linking to /docs/build/eps.html#tensorrtrtx; the file exists, but the hash 'tensorrtrtx' does not

  • At ./_site/docs/execution-providers/TensorRTRTX-ExecutionProvider.html:62:

    internally linking to #explicit-shape-range-for-dynamic-shape-input; the file exists, but the hash 'explicit-shape-range-for-dynamic-shape-input' does not

    will you also add NV TensorRT RTX to https://github.com/microsoft/onnxruntime/blob/gh-pages/docs/build/eps.md ?

* Add build instructions for TRT-RTX (only windows for now)
* Fix broken link
@ankan-ban
Copy link
Contributor Author

we need to fix the other broken link checks, but looks like there are some errors for the new page you adding

For the Links > Internal check, the following failures were found:

  • At ./_site/docs/execution-providers/TensorRTRTX-ExecutionProvider.html:1:
    internally linking to /docs/build/eps.html#tensorrtrtx; the file exists, but the hash 'tensorrtrtx' does not
  • At ./_site/docs/execution-providers/TensorRTRTX-ExecutionProvider.html:62:
    internally linking to #explicit-shape-range-for-dynamic-shape-input; the file exists, but the hash 'explicit-shape-range-for-dynamic-shape-input' does not
    will you also add NV TensorRT RTX to https://github.com/microsoft/onnxruntime/blob/gh-pages/docs/build/eps.md ?

Sorry about that. Fixed.

@ankan-ban
Copy link
Contributor Author

@jywu-msft , Any more concerns for this first revision of the documentation? Can this be merged now?

@jywu-msft jywu-msft merged commit 929bb34 into microsoft:gh-pages Jun 9, 2025
1 of 2 checks passed
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