Commit graph

144 commits

Author SHA1 Message Date
Ye Wang
705e0e79db
update docs to include multi-cudagraph support (#19818)
### Description
<!-- Describe your changes. -->

docs for https://github.com/microsoft/onnxruntime/pull/19636

### 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-03-07 12:51:49 -08:00
Tianlei Wu
b6a1108c80
[Doc] CUDA build options (#19678) 2024-02-29 15:31:47 -08:00
PeixuanZuo
4b9a7e270e
[Doc] Update latest ROCm version (#19665)
Update latest ROCm version
2024-02-29 15:07:22 +08:00
Nat Kershaw (MSFT)
401a08884e
Fix XNNPACK code snippet rendering (#19685) 2024-02-27 19:47:29 -08:00
kailums
4f39cf083e
[doc] add config options for rocm ep (#19643)
Add config options for ROCM ep in docs.

### Motivation and Context
Since we don't have any config options described in rocm ep docs, so i
add some config descriptions according to cuda ep.
2024-02-26 20:46:55 -08: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
Tianlei Wu
154a0beaba
[Doc] Add use_tf32 cuda provider option (#19548)
### Description
Add document of use_tf32 cuda provider option.
2024-02-20 13:58:39 -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
ivberg
7e64928b06
Added docs for ONNX 1.17 covering logging, tracing, and QNN EP Profiling (#19428)
### Description
Added docs for ONNX 1.17 covering logging, tracing, and QNN EP Profiling

### Motivation and Context
- ONNX Logging has not been documented
- ONNX Tracing with Windows has barely been documented
- ONNX 1.17 has new tracing and QNN EP Profiling

PRs: #16259,  #18201, #18882, #19397
2024-02-07 10:47:15 -08:00
Adrian Lizarraga
519fa389a9
[Gh pages] Update QNN EP documentation (quantization/python APIs) (#19435)
### Description
Preview:
https://adrianlizarraga.github.io/onnxruntime/docs/execution-providers/QNN-ExecutionProvider.html#running-a-model-with-qnn-eps-htp-backend-python

- Adds QNN EP documentation:
  - Create a quantized QDQ model using python quantization utilities
  - Run quantized QDQ model on Windows ARM64 using python ORT APIs.
- Updates QNN EP provider options
- Adds list of supported ONNX operators
- Provides instructions for using the new arm64 python wheel


### Motivation and Context
The aim is to make it easier for users to try QNN EP.
2024-02-06 12:36:15 -08:00
Tianlei Wu
fde74cbb00
[Doc] update onnxruntime-gpu pip installation for cuda 12 (#19404)
### Description
Update doc for cuda 12 GPU package pip installation
2024-02-05 11:00:11 -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
sophies927
fa643d0ed6
Update releases-servicing.md for ORT 1.17 (#19312)
### Description
Need to update docs w/ compatibility / version info for ORT 1.17 release - one link is broken but will work once release is official



### 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. -->

---------

Co-authored-by: MaanavD <maanavdalal@microsoft.com>
Co-authored-by: Maanav Dalal <maanavdalal@gmail.com>
2024-01-31 14:40:03 -08:00
Jian Chen
c189c5e22a
Update ORT web page documents to install CUDA 12 (#19337)
### Description

This pull request introduces changes to the
`docs/execution-providers/CUDA-ExecutionProvider.md` file, which
provides documentation for the CUDA Execution Provider. The changes
mainly involve reformatting the text to improve readability and updating
the content to reflect the latest changes in the CUDA Execution
Provider.

* Formatting and Readability Improvements:
* The text has been reformatted to improve readability, with long lines
of text broken down into shorter lines.
[[1]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R10-R41)
[[2]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L47-R118)
[[3]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R127-R163)
[[4]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R172-R175)
[[5]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L153-R233)
[[6]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L185)
[[7]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L215-R279)
[[8]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L256-R320)
[[9]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L265-R348)
[[10]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L379)
* Code snippets have been updated for better clarity and readability.
[[1]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R127-R163)
[[2]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R172-R175)
[[3]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L153-R233)

* Content Updates:
* The CUDA Execution Provider's documentation has been updated to
reflect the latest changes in the provider. This includes updates to the
CUDA Execution Provider's configuration options and performance tuning
recommendations.
[[1]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R10-R41)
[[2]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L47-R118)
[[3]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R127-R163)
[[4]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144R172-R175)
[[5]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L153-R233)
[[6]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L185)
[[7]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L215-R279)
[[8]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L256-R320)
[[9]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L265-R348)
[[10]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L379)

* Removals:
* Some unnecessary lines of text have been removed from the document.
[[1]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L215-R279)
[[2]](diffhunk://#diff-c0b7353d9f98e4bba18b2e9c915bc837eb69846c55ed0e8e0b7314119690e144L379)

---------

Co-authored-by: sophies927 <107952697+sophies927@users.noreply.github.com>
Co-authored-by: Tianlei Wu <tlwu@microsoft.com>
2024-01-31 13:16:02 -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
Tianlei Wu
c0a085a129
[CUDA] update python doc for user_compute_stream (#19245)
### Description
Update python doc about user_compute_stream in CUDA python API for
https://github.com/microsoft/onnxruntime/pull/19229.

### 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-01-26 10:34:59 -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
Hector Li
4a6f170af0
Update QNN docs according to context cache configuration changes (#18888)
### Description
Update QNN docs according to context cache configuration changes
2023-12-20 17:50:01 -08:00
Scott McKay
c3d6ab7816
Update NNAPI-ExecutionProvider.md supported ops (#16841)
### Description
<!-- Describe your changes. -->
Update NNAPI supported operators with latest info



### 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. -->
2023-12-20 09:22:05 +10:00
fanz-xlnx
7f42487b72
Update Vitis-AI-ExecutionProvider.md (#18706) 2023-12-07 14:49:33 -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
Maximilian Müller
e64b07c4c7
Update CUDA EP docs with NHWC and other new config options (#18547) 2023-11-23 09:13:20 -08:00
Hector Li
a8bce5b3bf
[QNN EP] QNN EP doc update (#18399)
### Description
Add more EP options enabled recently
2023-11-13 14:03:29 -08:00
George Wu
9bbb897822
[TensorRT EP] update link to TensorRT install instructions (#18167) 2023-10-30 11:07:53 -07:00
Preetha Veeramalai
2f66a5061e
Update documentation for OVEP Rel-1.16 (#18060)
### Description
Update OVEP Document for 5.1 release
2023-10-28 14:39:33 -07:00
Nat Kershaw (MSFT)
812874539c
Update CUDA dependencies for 1.16 (#18062) 2023-10-28 14:23:18 -07:00
Nat Kershaw (MSFT)
d910f96f08
Update CoreML-ExecutionProvider.md (#17873) 2023-10-11 11:13:56 -07:00
Faith Xu
cd20cac27f
[website] Fix sidebar ordering (#17620)
### Description
- Fixes ordering of EPs in sidebar
- Also fixes #17607 


### 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. -->
2023-09-20 14:11:50 -07:00
Xavier Dupré
71d60b408a
Fix links to notebooks broken because the notebooks were moved (#17446) 2023-09-07 10:49:30 -07:00
RandySheriffH
43da400aa6
Fix inner links (#17381) 2023-08-31 17:16:50 -07:00
RandySheriffH
e532835a3b
Document AzureEP 1.16 (#17289)
1. List all supported ops.
2. Demo usage in two modes.
3. Limitations.

---------

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2023-08-30 12:48:36 -07:00
BoarQing
3a4d91fafa
[VitisAI] fix doc after the support of Visual Studio 2019 is removed. (#17250)
### Description
<!-- Describe your changes. -->
Update 2019 to 2022


### 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. -->
It is required because Visual Studio is no longer a valid cmake
generator for onnxruntime.

Co-authored-by: Yueqing Zhang <yueqingz@amd.com>
2023-08-22 10:08:14 -07:00
Sheil Kumar
d910737bdf
Update DirectML-ExecutionProvider.md (#17229)
Update DirectML-ExecutionProvider.md to reflect the current update to
1.12.1 and support up to opset 17.
2023-08-21 09:11:14 -07:00
Scott McKay
c6ac91ee86
Update CoreML-ExecutionProvider.md supported operators (#16842) 2023-08-10 15:32:40 -07:00
Tianlei Wu
e1b7cd00f8
Update CUDA EP Requirements of ORT 1.15.* (#17081)
Add CUDA and cuDNN versions for ORT 1.15.
Add VC Runtime 

### 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/16967
2023-08-09 13:34:08 -07:00
Vinayak Nayak
67862b7c58
Fix typo in OpenVINO-ExecutionProvider.md (#17026)
### Description
Fixed typo (alvailable -> available) in OpenVINO-ExecutionProvider.md
file.



### Motivation and Context
This change will make the reading experience of docs better.
2023-08-07 10:10:42 -04:00
andyluo7
e7920e46c2
Update Vitis-AI-ExecutionProvider.md (#16951)
Update the download links

### Description
Update the download link of updated ONNXRT Vitis AI EP .zip archive
Update the contents of updated ONNXRT Vitis AI EP .zip archive 



### Motivation and Context
Recently we updated the Vitis AI EP for compiler enhancement and bug
fix.
The download URL of new .zip archive is changed so we need to update
this md file.
2023-07-31 22:59:22 -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
Maanav Dalal
2bec00816b
Added (hidden) converter team page. (#16507)
Co-authored-by: MaanavD <maanavdalal@microsoft.com>
2023-07-03 15:28:11 -05:00
Ted Themistokleous
a4a5006077
Fix name for ROCMExecutinProvider in ROcm-ExecutionProvider docs (#16534)
Invalid EP name which causes confusion for users who use
ROCMExecutionProvider

Co-authored-by: Ted Themistokleous <tthemist@amd.com>
2023-06-30 11:33:43 +08: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
Preetha Veeramalai
ea3af6cadb
Update documentation for OVEP v5.0 release (#16441)
### Description
Documentation updates



### Motivation and Context
Update the OpenVINO Execution Provider and build documentations for
1.15.0 release.
2023-06-23 10:39:20 -07:00
Baiju Meswani
307d5afe5f
Add On Device Training Tutorial with ONNX Runtime (#16167) 2023-06-15 16:01:26 -07:00
Jeff Mendenhall
28d1c4473f
Update Blog page and Move Vitis AI EP from community maintained to main EP list (#16290)
### Description
Move Vitis AI EP from community maintained to main EP list



### 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. -->
2023-06-10 07:25:52 -07:00
Takeshi Watanabe
74bab849ff
Fix typo in QNN-ExecutionProvider.md (#16144) 2023-05-29 21:19:09 -07:00
FFFrog
c2f03c14b6
[CANN] Update the doc of CANN EP (#15809)
#### Description
This PR update docs of Ascend CANN execution provider.

#### Changes
1. Add new options.
[https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#configuration-options](https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#configuration-options)
2. Add new category.
[https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#performance-tuning](https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#performance-tuning)
2023-05-25 21:47:30 -07:00
Hector Li
39fa3a15c4
fix typo (#16111)
### Description
fix typo
2023-05-25 18:09:07 -07:00