Commit graph

44 commits

Author SHA1 Message Date
jingyanwangms
a9d566c711
Update TensorRT Documentation (#22829)
### Description
Update TensorRT Documentation



### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
2024-11-13 21:42:28 -08:00
Sophie Schoenmeyer
b57e2e121d
Update EP version info after ORT 1.20 (#22715)
### Description
<!-- Describe your changes. -->
Included new version info for CUDA, TensorRT, and DirectML execution
providers following ORT 1.20 release publish.


### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
2024-11-04 13:25:42 -08:00
Tianlei Wu
bc1bce956a
[Doc] Update GPU package installation (#22204)
### Description
* Add CUDA/CuDNN requirements for 1.19.x
* Update installation guide for cuda 11 package and nightly.
* Remove a sentence for ROCm: `Alternatively, each major ORT release has
a corresponding C/C++ ROCm package, found
[here](https://github.com/microsoft/onnxruntime/releases/).` since
onnxruntime_rocm package is not available in recent releases.

### Motivation and Context
Doc is not up to date.
2024-09-24 13:57:20 -07:00
Yifan Li
85c3f0fe0b
[TensorRT EP] [documentation] Set cuda 12 as default for ORT 1.19 (#21758) 2024-09-24 10:21:29 -07:00
Abdullah Shafin
b91a3aeb5c
Fix typo in docs: TensorRT-ExecutionProvider.md (#22128)
### Description
While reading the docs, I came across a typo. This PR proposes to fix it.

### Motivation and Context
Improve documentation.
2024-09-18 14:08:31 -07:00
Maximilian Müller
7d89749e0c
[TensorRT Docs] Extending engine embedding docs (#20848)
Adding to the docs a link on how to embed an externally compiled engine
and also mention that in case of an embedded engine the builder resource
is not needed.
2024-06-03 13:31:13 -07:00
Yifan Li
73df4e5337
[TensorRT EP] Update doc (#20857)
### Description
<!-- Describe your changes. -->
* Reorganize table and group items by scenarios
* Add `trt_engine_hw_compatible` doc
* Update jetson instruction with TensorRT 10 info

### UI comparison
After:
https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations
Before:
https://onnxruntime.ai/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations
2024-05-29 21:51:35 -07:00
Chi Lo
e3e4f215f1
[TensorRT EP] TRT EP cache docs (#20785)
Add a section for how to use three major TRT EP caches: TRT timing
cache, TRT engine cache and Embedded engine model /EPContext model.
Some materials are from my GTC slides.
2024-05-24 18:53:59 -07:00
Yifan Li
f131eb9993
[TensorRT EP] Update doc to TRT10 (#20580)
### Description
<!-- Describe your changes. -->
* Update TRT version to 10.0


### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
2024-05-07 10:05:46 -07:00
Yifan Li
55edff104f
[TensorRT EP] Update instruction of user_compute_stream (#20343)
### Description
<!-- Describe your changes. -->
Update instruction and add sample code

### Preview the change:

https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#execution-provider-options

### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
2024-04-17 13:45:06 -07:00
Ye Wang
69ca776a80
Fix TRT doc (#19658)
### Description
<!-- Describe your changes. -->



### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->

https://github.com/microsoft/onnxruntime/issues/19641
2024-02-26 18:17:17 -08:00
Yifan Li
44b7002e3b
[TensorRT EP] Add missing doc for trt_timing_cache_path (#19478)
### Description
<!-- Describe your changes. -->
The usage of `trt_timing_cache_path` is missing in TRTEP doc.

To review the change:
https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations


### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
2024-02-13 12:37:27 -08:00
Yifan Li
c4bcf6c80d
[TensorRT EP] Add description for new option trt_engine_cache_prefix (#19362)
### Description
Add description for new option trt_engine_cache_prefix


### Preview

https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations
2024-02-02 23:37:34 -08:00
George Wu
89faa6b76f
QNN EP, TensorRT EP doc updates for ort 1.17 (#19331)
update docs for ORT 1.17
2024-01-30 14:31:45 -08:00
Maanav Dalal
ff6b7f25a1
Added requested Mac x64/arm64 instructions. (#19263)
### Description
<!-- Describe your changes. -->
Added newly introduced API combinations to getting-started table.


### Motivation and Context
Attempting to get merged before / in time for ORT 1.17 release

---------

Co-authored-by: MaanavD <maanavdalal@microsoft.com>
Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
2024-01-29 16:17:46 -08:00
Maximilian Müller
e394a8e045
[Docs] Adding CUDA Graph docs for TRT (#19064)
### Description

Adding docs for the flag `trt_cuda_graph_enable`.
2024-01-09 17:11:48 -08:00
Maximilian Müller
766400b477
[Docs] TensorRT update docs to V2 API (#18569)
### Description
I mainly wanted to update the docs to V2 API. I think my spellchecker
did quite a few adjusts to whitespaces hope that's fine.
@chilo-ms for viz
2023-11-28 10:11:47 -08:00
George Wu
9bbb897822
[TensorRT EP] update link to TensorRT install instructions (#18167) 2023-10-30 11:07:53 -07:00
Xavier Dupré
71d60b408a
Fix links to notebooks broken because the notebooks were moved (#17446) 2023-09-07 10:49:30 -07:00
Yifan Li
ff415eac34
Improve TRT doc and advance EP session option (#16868)
### Description
Move EP session option usage in the front of TRT EP configuration
chapter, as it's preferred method of configuring TRT EP.

#### Major:
* Add more description for TRT EP session options
* Mark TRT environment variable as deprecated and fold the content

#### Minor:
* Fix incorrect types in one-to-one mapping table
* Fold long code example to shorten the paragraph


### Preview
After change:
https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations
Before change:
https://onnxruntime.ai/docs/execution-providers/TensorRT-ExecutionProvider.html#execution-provider-options
2023-07-28 11:15:01 -07:00
Yifan Li
e7464cd41d
Fix corrupt markdown table (#16767)
### Description
* Update table markdown following
https://just-the-docs.com/docs/ui-components/tables to fix UI

* Preview:
*
https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#requirements

### Motivation and Context
https://github.com/microsoft/onnxruntime/issues/16759
2023-07-20 12:18:04 +02:00
Yifan Li
b4592d69c2
Clarify TRTEP doc (#16537)
### Description
* Clarify TRTEP version info


### Motivation and Context
https://github.com/microsoft/onnxruntime/issues/15118: issue to request
https://github.com/microsoft/onnxruntime/pull/16465: previous PR to
update trtep doc
2023-07-06 17:45:54 -07:00
yf711
f240999167
Update trtep doc with ort 1.15 (#16465)
### Description
* TRT/cuda/cuDNN version updated
* Update the instruction of using trt builtin parser (new default
option) and using open-sourced onnx-trt parser (non-default)
* Add more comments to examples

Rendered version: 
1. https://yf711.github.io/onnxruntime/docs/build/eps.html#tensorrt
2.
https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html
2023-06-23 12:05:11 -07:00
Chi Lo
91ab2ac743
Update TRT EP doc (#15907) 2023-05-11 13:39:04 -07:00
Chi Lo
81da3a1f08
Update docs for new TRT EP provider options (#15825)
Update TRT EP documentation for newly added TRT EP provider options
2023-05-10 11:14:22 -07:00
Faith Xu
3681048474
[Docs] Update performance sections (#15071)
### Description
Staged: https://faxu.github.io/onnxruntime/docs/performance/

Main changes:
- Restructure performance section to break into sub-categories
- Move CUDA specific perf tuning tips to [CUDA EP
page](https://faxu.github.io/onnxruntime/docs/execution-providers/CUDA-ExecutionProvider.html#performance-tuning)
- Update [Transformer optimizer
page](https://faxu.github.io/onnxruntime/docs/performance/transformers-optimization.html)
to remove version-specific content... will be supported along with
https://github.com/microsoft/onnxruntime/pull/14964
- Fix links to point to new pages
2023-03-17 15:39:22 -07:00
Prasanth Pulavarthi
f69691fb1d Revert "Revert "Merge branch 'gh-pages' of https://github.com/microsoft/onnxruntime into gh-pages""
This reverts commit 20c745c749.
2023-03-10 17:02:38 -08:00
Prasanth Pulavarthi
20c745c749 Revert "Merge branch 'gh-pages' of https://github.com/microsoft/onnxruntime into gh-pages"
This reverts commit 063f84744e, reversing
changes made to 6f2f1e8dac.
2023-03-10 16:58:21 -08:00
yf711
5464c93bc9
[doc] Update TRTEP doc (#14911) 2023-03-08 16:44:25 -08:00
Edward Chen
e17d43dbdd
[doc] Update mobile custom build instructions, update ORT GitHub URLs to use 'main' (#14409) 2023-01-24 10:46:24 -08:00
Nat Kershaw (MSFT)
f9895177e1
Add 1.13 TRT compatibility (#14331)
Fixes #14090
2023-01-20 17:38:44 -08:00
Faith Xu
d4497b9ecd
[Docs] Update EP ordering (#13564)
### Description
- Update EP ordering and distinguish between MS-maintained and
community-maintained EPs
- Update CUDA version table for v1.13
- Staged preview:
https://faxu.github.io/onnxruntime/docs/execution-providers/
2022-11-07 10:02:01 -08:00
FFrog
7fd9523934
add doc about CANN EP (#13239)
#### Description
This PR adds docs of Ascend CANN excution provider.

#### Changes

- Preview Github page:
[https://fffrog.github.io/](https://fffrog.github.io/)

- Add onnxruntime build with CANN:
[https://fffrog.github.io/docs/build/eps.html#cann](https://fffrog.github.io/docs/build/eps.html#cann)

- Add CANN ExecutionProvider Page:
[https://fffrog.github.io/docs/execution-providers/CANN-ExecutionProvider.html](https://fffrog.github.io/docs/execution-providers/CANN-ExecutionProvider.html)
2022-10-18 10:18:09 -07:00
PeixuanZuo
ce1bc9b49c
[Add] add Rocm ep doc (#12971)
**Description**: Describe your changes.
add rocm ep doc.
Perview Github page : https://ytaous.github.io/onnxruntime/

Added items
Home page
- [ ] Update matrix on home page: https://ytaous.github.io/onnxruntime/
- [ ] Link "Installation Instruction Follow build instructions from
here" to onnxruntime build with ROCm(inference) page.(This link now
point to preview page, will change later)

Installation
- [ ] Update installation page:
https://ytaous.github.io/onnxruntime/docs/install/#training-install-table-for-all-languages

Build onnxruntime
- [ ] Add onnxruntime build with ROCm(inference):
https://ytaous.github.io/onnxruntime/docs/build/eps.html#amd-rocm
- [ ] Update onnxruntime build with ROCm(training):
https://ytaous.github.io/onnxruntime/docs/build/training.html#gpu--rocm

ExecutionProvider
- [ ] Add ROCm ExecutionProvider navitagation:
https://ytaous.github.io/onnxruntime/docs/execution-providers/
- [ ] Add ROCm-ExecutionProvider page:
https://ytaous.github.io/onnxruntime/docs/execution-providers/ROCm-ExecutionProvider.html

Performance
- [ ] Add enable_rocm_profiling introcduction:
https://ytaous.github.io/onnxruntime/docs/performance/tune-performance.html#profiling-and-performance-report
- [ ] Add graph-optimation for ROCm ep:
https://ytaous.github.io/onnxruntime/docs/performance/graph-optimizations.html#extended-graph-optimizations

Co-authored-by: Ethan Tao <ettao@microsoft.com@orttrainingdev7.d32nl1ml4oruzj4qz3bqlggovf.px.internal.cloudapp.net>
Co-authored-by: ytaous <4484531+ytaous@users.noreply.github.com>
2022-09-20 12:04:20 -07:00
Nat Kershaw (MSFT)
fd48acae6d
Add correct version for TRT (#12475) 2022-08-04 16:45:26 -07:00
Faith Xu
f39fbbf6f7
[Website/Docs] Add quote and reorganize docs navigation (#12355) 2022-07-29 12:44:36 -07:00
Faith Xu
0e1e488824
[website] updates for 1.12 (#12262)
* v1.12 docs updates

* fix typo

* add TVM EP updates to matrix

* More matrix updates

* remove xamarin example text
2022-07-22 10:04:40 -07:00
George Wu
d699805e24
update TensorRT EP docs for ORT 1.11 (#11055) 2022-03-30 14:07:06 -07:00
George Wu
fe3e672400
updates to CUDA and TensorRT EP documentation (#9932)
* updates to TRT, CUDA documentation

* update trt options python example.
2021-12-03 21:48:12 -08:00
Nat Kershaw (MSFT)
91e029d4f3
SEO audit of docs website (#9780) 2021-11-18 11:00:48 -08:00
Faith Xu
6c8c8a9b12
[Docs] Update CUDA/TRT versions and menu format fixes (#9317)
* update cuda/trt versions

* update API doc links

* remove api doc parentage

* fix menu

* fix broken links

* open api links in new window
2021-10-14 11:28:17 -07:00
stevenlix
e01d4c1d27
Update TensorRT doc (#9112)
* Update TensorRT-ExecutionProvider.md

* Update eps.md

* Update TensorRT-ExecutionProvider.md
2021-09-20 07:56:41 -07:00
Chi Lo
603ea0e2cf
Fix merge conflicts (#9104) 2021-09-17 14:01:15 -07:00
Cassie
a0f3e30de6
Docs update: updated nav, get started sections, home page, apis (#9060)
* initial setup and rename "how to" to "setup"

* move API to main nav

* move api to main nav

* add get starated, rework nav order

* rename to install move mds out of install section

* update api nav and home page

* add install docs and python qs updates

* python get started work

* remove c and obj c for now

* move java, python, and obj-c docs under api folder

* move java api html to iframe (ugh)

* remove api docs w/o details, move api text getstar

* remove api docs wo detail updates get started

* remvoe iframes

* move eco system to main nav

* fix api buttons

* added more examples moved intro to ORT

* fix links

* fix get started titles

* fix get started titles

* fix more links

* fix more links

* more link fixes

* fix nav remove inferencing and training subnav

* fix top nav remove inference and training nav

* fix title

* fix tutorials nav hierarchy

* fix python api button

* add tenorflow keras example

* fix quickstart toc

* add imports fix spacing

* fix links

* update nav and python get started page

* move ort training example, add coming soon for iot

* update C# get started

* fix spacing on quantization

* Add some js get started content

* fix formatting

* fix typo

* removed onnx-pytorch and onnx-tf

* updated pip install torch and added links iot page

* added pytorch tutorial heirarchy

* updated web to docs soon added release blog link

* add web link
2021-09-15 16:23:42 -05:00
Renamed from docs/reference/execution-providers/TensorRT-ExecutionProvider.md (Browse further)