Commit graph

49 commits

Author SHA1 Message Date
Tianlei Wu
a62200665e
[Doc] Update CUDA and cuDNN installation (#20035)
(1) Add CUDA and cuDNN installation section to ORT installation.
(2) For build, TRT EP refers to CUDA EP for CUDA/cuDNN installation to avoid duplication.
(3) Add comments about CUDA/cuDNN compatiblility
2024-03-22 16:38:08 -07: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
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
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
Maximilian Müller
e64b07c4c7
Update CUDA EP docs with NHWC and other new config options (#18547) 2023-11-23 09:13:20 -08:00
Yifan Li
9c227d1432
Update jetson instruction (#18204)
### Description
* Update instruction based on latest jetpack 5.1.2+ORT 1.16
* Add instructions of installing CUDA 11.8/latest CMake
* Add tips of building ORT on jetson

Check
https://yf711.github.io/onnxruntime/docs/build/eps.html#nvidia-jetson-tx1tx2nanoxavier
for preview
2023-11-02 14:18:25 -07: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)
ea25f19229
Fix broken OpenVINO link (#17579)
Co-authored-by: nakersha <natalie.kershaw@microsoft.com>
2023-09-18 16:56:59 -07: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
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
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
Edward Chen
a6c1fdddaf
[docs] Remove old references to Nuphar EP. (#15774) 2023-06-08 16:46:16 -07:00
George Wu
9e6613db1e
Add initial QNN EP docs (#16053)
remove SNPE EP and add initial QNN EP docs. (more updates coming pending
Qualcomm online docs)
2023-05-23 11:38:45 -07:00
mingyueliuh
efbf2d0810
update doc for Vitis-AI execution provider upgrade (#15821)
### Description
Documentation and Vitis AI EP synchronous upgrade



### Motivation and Context

---------

Co-authored-by: mingyue <mingyue@amd.com>
2023-05-19 09:16:53 -07:00
Nat Kershaw (MSFT)
4a89a7b2da
Version 1.14 docs sweep (#14789) 2023-03-14 12:01:21 -07:00
Ted Themistokleous
5601b10644
Update information for ROCm 5.4 for MIGraphX and ROCm Builds (#13813)
-Add MIGraphX-EP page for install/example
-Update version info for ROCm version for both MIGraphx and ROCm EPs to
5.4 -Update hooks to the latest ROCm Pytorch supported (1.12.1 -> 1.13)
-Remove (Preview) from MIGraphx and ROCm EP notes
-Update ROCm & MIGraphX EP.md files with ROCm version and pytorch links

### Description
<!-- Describe your changes. -->
Update documentation about ROCm and MIGraphx with newest ROCm 5.4 stack


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

Update things for whats able to be supported.

Co-authored-by: Ted Themistokleous <tthemist@amd.com>
2023-01-26 12:18:48 -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
RandySheriffH
1391f81c3f
Document Affinity & CloudEP (#14137) 2023-01-23 11:24:33 -08:00
JiCheng
88928251eb
[Xnnpack] update doc (#13624)
### Description
- iOS support
- MatMul && GEMM
- Resize
- ConvTranspose


A deployment [link](https://wejoncy.github.io/onnxruntime/) for
showcase.
### 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-01-19 19:14:48 -08:00
EunHo Lee
65dbfe1907
Fix documentation typos (#14084) 2023-01-06 13:11:23 -08:00
FFFrog
b521f49c43
[CANN] Update the doc of CANN EP (#13875)
#### Description
This PR update docs of Ascend CANN excution provider.

#### Changes
1. Add some new ops.
[https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#supported-ops](https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#supported-ops)
2. Add detailed option description.
[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)
3. Fix the link problem caused by document structure adjustment.
2022-12-14 10:11:56 -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
Cheng
a01de6db92
[xnnpack] Add EP Doc (#13021)
**Description**: Describe your changes.

Xnnpack EP

Preview:
https://wejoncy.github.io/onnxruntime/

**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: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2022-10-07 15:08:22 -07:00
sfatimar
9341c87957
Update docx ov ep v4.2 release (#13222)
Description
[OpenVINO-EP] Documentation update for v4.2 Release with OpenVINO 2022.2
version

Motivation and Context
The code PR is already merged:

https://github.com/microsoft/onnxruntime/pull/13023
https://github.com/microsoft/onnxruntime/pull/13069
Openvino GPU Unit/Python Tests fix failure  #13122

Co-authored-by: mayavijx <mayax.vijayan@intel.com>
2022-10-07 08:55:34 -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
yf711
746130073b
Add instruction of new build option to link TensorRT builtin parser (#12615)
* Add instruction of new build option to link TensorRT builtin parser

* Add instruction of new build option to link TensorRT builtin parser
2022-08-17 08:26:17 -07:00
chethanpk
678106ad9f
Updated OneDNN build documentation (#12446)
Modified OneDNN documentation to include build instructions for using open-source OpenCL-SDK

Signed-off by: chethan.palangotu.keshava@intel.com
2022-08-03 12:53:14 -07:00
George Wu
70a3468850
initial docs for SNPE EP (#11705)
* SNPE EP docs

* minor corrections

* fixes

* c++

* remove

* Update docs/execution-providers/SNPE-ExecutionProvider.md

Co-authored-by: manashgoswami <magoswam@microsoft.com>

* review comments

Co-authored-by: manashgoswami <magoswam@microsoft.com>
2022-06-03 14:19:57 -07:00
sfatimar
b51e301eaa
Gh pages uep 4.1 2022.1 (#11649)
* Update OpenVINO-ExecutionProvider.md

Updated to support Python Packages on PyPi.org

* Update eps.md

Updated OpenVINO

* Update eps.md
2022-05-31 08:15:19 -07:00
sfatimar
370c4c5672
Ov ep docx update 22.2 (#11296)
* Update eps.md

* Update OpenVINOExecutionProvider.md

* Update OpenVINOExecutionProvider.md
2022-04-27 09:49:44 -07:00
Maajid khan
173f7f623c
OpenVINO-EP v4.0 Release documentation update (#11125)
* Update docx w.r.t v4.0 Release

updates documentation w.r.t OV-EP
v4.0 Release with OpenVINO 2022.1
version.

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Added new announcements

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Fixed typos

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Add Release page link

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2022-04-08 09:53:49 -07:00
George Wu
d699805e24
update TensorRT EP docs for ORT 1.11 (#11055) 2022-03-30 14:07:06 -07:00
Nat Kershaw (MSFT)
f696d17906
Add STVM to website installation matrix (#10064) 2021-12-16 16:35:08 -08:00
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -08: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
Maajid khan
da6f161717
[OpenVINO EP] v3.3 Release Documentation update (#9589) 2021-11-17 12:39:06 -08:00
Nat Kershaw (MSFT)
14825b3461
Add automatic link checking to docs website (and fix broken links) (#9566) 2021-10-27 10:43:10 -07: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
Maajid khan
69e077eb61
[OpenVINO-EP] V3.2 Release Documentation update (#9233)
* Updated docx for OpenVINO EP V3.2 Release

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Added Docx for blogs/Tutorials for OV-EP

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Added docx for Yolov4 Python sample

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* updated the graph partitioning docx

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Added sample example for external_data feature

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-10-12 18:03:16 -07:00
stevenlix
9fa90d762b
Fix issues in execution provider docs (#9201)
* fix syntax issue

* update tensorrt version
2021-09-27 13:42:20 -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
Maajid khan
6e4f49eca8
[OpenVINO-EP] Documentation update UEP v3.1 Release (#9084)
* Update OpenVINO-ExecutionProvider.md

Updated information on 1.9

* Updated UEP documentation to the latest

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Corrected the c# section links

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

Co-authored-by: sfatimar <sahar.fatima@intel.com>
2021-09-20 07:56:09 -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/how-to/build/eps.md (Browse further)