Iraut/update nv trt rtx ep doc#25321
Open
ishwar-raut1 wants to merge 3 commits intomicrosoft:gh-pagesfrom
Open
Iraut/update nv trt rtx ep doc#25321ishwar-raut1 wants to merge 3 commits intomicrosoft:gh-pagesfrom
ishwar-raut1 wants to merge 3 commits intomicrosoft:gh-pagesfrom
Conversation
Contributor
|
looks good to me. Thanks. |
-> Grouped Eps of same vendors in bins of 100
Member
|
can you share the rationale behind the nav order number selection/updates ? |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates navigation ordering for execution provider documentation, refines the NVIDIA TensorRT RTX provider page, and enhances the build instructions for TensorRT RTX.
- Standardized
nav_ordervalues across all execution provider Markdown files. - Corrected the TensorRT RTX EP description link and wording.
- Added and formatted build instructions snippet for TensorRT RTX in the build guides.
Reviewed Changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/execution-providers/oneDNN-ExecutionProvider.md | Updated nav_order to fit new documentation ordering. |
| docs/execution-providers/community-maintained/index.md | Updated nav_order for community-maintained providers index. |
| docs/execution-providers/Xnnpack-ExecutionProvider.md | Updated nav_order to align with revised schema. |
| docs/execution-providers/Vitis-AI-ExecutionProvider.md | Updated nav_order to the new numbering. |
| docs/execution-providers/TensorRTRTX-ExecutionProvider.md | Changed nav_order and fixed TensorRT RTX link and description. |
| docs/execution-providers/ROCm-ExecutionProvider.md | Updated nav_order according to new hierarchy. |
| docs/execution-providers/QNN-ExecutionProvider.md | Updated nav_order for consistency across providers. |
| docs/execution-providers/OpenVINO-ExecutionProvider.md | Updated nav_order in line with other Intel providers. |
| docs/execution-providers/NNAPI-ExecutionProvider.md | Updated nav_order. |
| docs/execution-providers/MIGraphX-ExecutionProvider.md | Updated nav_order for AMD MIGraphX EP. |
| docs/execution-providers/EP-Context-Design.md | Updated nav_order for EP context design document. |
| docs/execution-providers/DirectML-ExecutionProvider.md | Updated nav_order for DirectML EP. |
| docs/execution-providers/CoreML-ExecutionProvider.md | Updated nav_order for CoreML EP. |
| docs/execution-providers/CUDA-ExecutionProvider.md | Updated nav_order for CUDA EP. |
| docs/execution-providers/Azure-ExecutionProvider.md | Updated nav_order for Azure EP. |
| docs/build/eps.md | Added TensorRT RTX install link and formatted the build command snippet. |
Comments suppressed due to low confidence (2)
docs/build/eps.md:246
- Correct the spelling of "Install" and remove the extra closing parenthesis in the markdown link.
* Intall TensorRT for RTX from [here](https://developer.nvidia.com/tensorrt-rtx))
docs/execution-providers/EP-Context-Design.md:5
- The
nav_ordervalue is unusually large compared to others. Please verify if this is intended or a typo.
nav_order: 99902
| Replace the --tensorrt_home and --cuda_home with correct paths to CUDA and TensorRT-RTX installations. | ||
|
|
||
| ```bash | ||
| `build.bat --config Release --parallel 32 --build_dir _build --build_shared_lib --use_nv_tensorrt_rtx --tensorrt_rtx_home <path to TensorRT for RTX home> --cuda_home <path to CUDA home> --cmake_generator "Visual Studio 17 2022" --use_vcpkg` |
There was a problem hiding this comment.
Remove the inline backticks around the build command inside the code block to avoid rendering issues.
Suggested change
| `build.bat --config Release --parallel 32 --build_dir _build --build_shared_lib --use_nv_tensorrt_rtx --tensorrt_rtx_home <path to TensorRT for RTX home> --cuda_home <path to CUDA home> --cmake_generator "Visual Studio 17 2022" --use_vcpkg` | |
| build.bat --config Release --parallel 32 --build_dir _build --build_shared_lib --use_nv_tensorrt_rtx --tensorrt_rtx_home <path to TensorRT for RTX home> --cuda_home <path to CUDA home> --cmake_generator "Visual Studio 17 2022" --use_vcpkg |
| description: Instructions to execute ONNX Runtime applications with CUDA | ||
| parent: Execution Providers | ||
| nav_order: 1 | ||
| nav_order: 3 |
There was a problem hiding this comment.
[nitpick] This nav_order uses a single-digit value while others follow a three-digit scheme; consider aligning for consistency.
Suggested change
| nav_order: 3 | |
| nav_order: 003 |
Contributor
Author
I want to group the EPs running on the same vendor. EPs were scattered, so I have arranged them together. |
Contributor
|
@jywu-msft Can we add this PR for 1.23? |
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
4 participants
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.
Description
@ankan-ban @gedoensmax