Commit graph

370 commits

Author SHA1 Message Date
Nat Kershaw (MSFT)
19687c00ee
Fix custom op docs (#17571) 2023-09-15 19:20:10 -07:00
RandySheriffH
54ebb4ded7
Doc custom op lifetime (#17576) 2023-09-15 19:14:19 -07:00
Caroline Zhu
dc06ffedac
Add training artifacts to the ORT build for web docs (#17455)
### Description
Updates the ORT build for web documentation to include the training WASM
artifacts


### Motivation and Context
* We are adding training bindings for web
* [This PR](https://github.com/microsoft/onnxruntime/pull/16521)
extended the WASM API wrapper to include training, allowing for training
artifacts (`ort-training-wasm-simd.wasm` and
`ort-training-wasm-simd.js`) to be built, and was merged in last week
* [This PR](https://github.com/microsoft/onnxruntime/pull/17319) will
add the training artifacts to the web pipeline & updates the
pull-wasm-artifacts script to also pull training artifacts.

This PR should not be merged in until the [pipeline
PR](https://github.com/microsoft/onnxruntime/pull/17319) is merged.
2023-09-11 10:00:49 -07:00
Xavier Dupré
71d60b408a
Fix links to notebooks broken because the notebooks were moved (#17446) 2023-09-07 10:49:30 -07:00
Nat Kershaw (MSFT)
09f9e6d6fa
Test staging website from a branch (#17440) 2023-09-06 22:04:25 -07:00
Edward Chen
3963d364dc
Fix typo in sample code. (#17426) 2023-09-05 15:19:13 -07:00
Edward Chen
2cced52151
Add documentation for installing ORT Extensions on Android and iOS. (#17397)
### Description
<!-- Describe your changes. -->

Add documentation for installing ORT Extensions on Android and iOS.
Some other minor doc updates.

https://edgchen1.github.io/onnxruntime/docs/extensions/

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

Documentation.
2023-09-05 11:39:36 -07:00
Nat Kershaw (MSFT)
ae98203d4c
Minor edits to extensions (#17396) 2023-09-01 16:30:53 -07:00
Sayan Shaw
cdba245a6e
Added initial ORT Extensions docs for onnxruntime website (#16723)
## Preview staged site
[here](https://sayanshaw24.github.io/onnxruntime/docs/extensions/).

**TODO**: In the future, make PR to add/update descriptions for the
following new/deprecated ops:

**NLP Ops**
- BlingFireSentenceBreaker
- BpeTokenizer

**String Ops**
- StringSplit
- StringUpper
- StringLower
- StringECMARegexSplitWithOffsets
- StringRaggedTensorToDense
- StringMapping

**Math Ops**
- Inverse
- NegPos
- SegmentExtraction
- SegmentSum

**Tensor Ops**
- RaggedTensorToSparse
- RaggedTensorToDense

---------

Co-authored-by: Sayan Shaw <sayanshaw@microsoft.com>
Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2023-09-01 15:56:33 -07:00
RandySheriffH
43da400aa6
Fix inner links (#17381) 2023-08-31 17:16:50 -07:00
RandySheriffH
73e0000190
Doc custom op lite (#17287)
Doc custom op lite for a few key improvements:

1. lite interface.
2. cuda & rocm support.
3. one op, varied data type.

---------

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2023-08-30 12:48:46 -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
Vrajang Parikh
de3393b725
Update macOS and iOS custom build documentation for training (#17223)
### Description
Add instructions for macOS build and training pods

Preview: https://vraspar.github.io/onnxruntime/docs/build/training.html,
https://vraspar.github.io/onnxruntime/docs/build/custom.html#ios

---------

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
Co-authored-by: Baiju Meswani <baijumeswani@gmail.com>
2023-08-18 15:09:29 -07:00
Vrajang Parikh
fcd241f145
Add iOS On Device Training Tutorial with ONNX Runtime (#17146)
### Description

This pull request introduces comprehensive tutorial for performing on
device training on iOS devices using Objective-C/Swift on device
training APIs.

Preview:
https://vraspar.github.io/onnxruntime/docs/tutorials/on-device-training/ios-app.html
Example App:
https://github.com/microsoft/onnxruntime-training-examples/tree/master/on_device_training/mobile/ios/MyVoice

---------

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
Co-authored-by: Baiju Meswani <baijumeswani@gmail.com>
2023-08-17 00:58:22 -07:00
Scott McKay
c6ac91ee86
Update CoreML-ExecutionProvider.md supported operators (#16842) 2023-08-10 15:32:40 -07:00
Vrajang Parikh
ab90551852
add installation instruction for training pods (#17080)
### Description

Add instruction to install training CocoaPods


### Preview

https://vraspar.github.io/onnxruntime/docs/install/#training-phase---on-device-training

---------

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
Co-authored-by: Baiju Meswani <bmeswani@microsoft.com>
2023-08-10 10:16:30 -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
Sayan Shaw
85719a2a9d
remove unneeded no-toc from superres (#16682)
Co-authored-by: Sayan Shaw <sayanshaw@microsoft.com>
2023-07-13 17:10:32 -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
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
Nat Kershaw (MSFT)
1b61ac0517
Update compatibility.md for release 1.15 (#16389) 2023-06-16 11:53:50 -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
Edward Chen
a6c1fdddaf
[docs] Remove old references to Nuphar EP. (#15774) 2023-06-08 16:46:16 -07:00
Yulong Wang
e62689f7ce
[doc] update document for webgpu (#16245)
### Description

update document for webgpu

Preview: https://fs-eire.github.io/onnxruntime/docs/
2023-06-06 13:00:33 -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
Hector Li
c55e38aac1
add link to nuget package for QNN EP (#16110)
### Description
Add link to Qnn nuget pacakge
2023-05-25 16:49:31 -07:00
Nat Kershaw (MSFT)
63e53a3f00
Update releases (#16108) 2023-05-25 16:09:56 -07:00
Changming Sun
f124846ae8
Update build instructions (#16012) 2023-05-25 10:05:59 -07:00
Changming Sun
467d0347b0
Update doc links for operators and kernels (#16101) 2023-05-25 10:05:12 -07:00
RandySheriffH
627112921e
Update docs for AzureEP and threading (#16061)
1. Remove zlib and re2 deps for AzureEP.
2. Explain --use_lock_free_queue usage.

---------

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2023-05-23 15:32:54 -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
Quenton Hall
8b82f5ec2d
Update Vitis-AI-ExecutionProvider.md (#16020)
Update Ryzen AI demo link in Vitis AI Execution Provider
2023-05-22 21:20:39 -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
Anastasia Kuporosova
89d77df4cc
Update OpenVINO Execution Provider doc (#15679)
### Description
Update OpenVINO Execution Provider documentation for python


### Motivation and Context
`onnxruntime-openvino` doesn't have dependency on OpenVINO Python API
itself, it needs OpenVINO libs.
Moreover, `add_openvino_libs_to_path()` meant to be internal, right now
it doesn't work and will be deprecated in the upcoming OpenVINO release.
The recommended way is to install an archive with libraries and run
setupvars to add OpenVINO libraries to PATH.
2023-05-18 07:33:30 -07:00
Baiju Meswani
25125b5b91
Training related changes to the onnxruntime website (#15900)
Changes include:

- Added a new page for `On-Device Training` overview:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/get-started/on-device-training.html)
- Added a new section for `On-Device Training` installation:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/install/#install-for-on-device-training)
- Added a new section for `On-Device Training` build from source:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/build/training.html#build-for-on-device-training)
- Updated Large Model Training overview, installation, build pages to
reflect what is currently accurate.

Website preview: https://baijumeswani.github.io/onnxruntime/


Pending website work:
- Update links for released packages for training.
- Add tutorial for on-device training
- Add links to the blog posts that detail on device training.
2023-05-17 14:45:52 -07:00
Rachel Guo
e2dda61278
[doc] Add instructions for configuration of react native with extensions (#15881) 2023-05-16 12:52:40 -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