Commit graph

87 commits

Author SHA1 Message Date
Phoebe Chen
e31928e7ff
Add Initial Cross-Compilation Documentation for RISC-V Support (#19239)
Update the document for PR: Enable Cross-Compiling Support for ONNX
Runtime on Linux for RISC-V 64-bit.
https://github.com/microsoft/onnxruntime/pull/19238

Signed-off-by: Phoebe Chen <phoebe.chen@sifive.com>
2024-04-05 06:54:18 -07:00
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
Rachel Guo
00d3d477e5
Update ios.md with updated arguments name (#19528)
### 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. -->

#19526
2024-02-15 13:58:02 -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
Caroline Zhu
ad7d0fbc74
Add web documentation + installation instructions (#19342)
### Description
Updated docs section with information on installation and building. 

Live previews of modified pages:
* [Installation
table](https://carzh.github.io/onnxruntime/getting-started) -- under the
Optimize Training tab
* [Build for
training](https://carzh.github.io/onnxruntime/docs/build/training.html)
* [Getting started with
web](https://carzh.github.io/onnxruntime/docs/get-started/with-web.html)
-- added link to E2E demo code
* [Install for on-device
training](https://carzh.github.io/onnxruntime/docs/install/#install-for-on-device-training)
* [Tutorials page for On-device
training](https://carzh.github.io/onnxruntime/docs/tutorials/on-device-training/)
-- this page looks a little odd with just the link to the E2E demo.
potential alternative of creating a separate page that links to the demo
+ mentions that a tutorial will be coming soon?


### Motivation and Context
- Updating docs with information about ORT Training for Web for 1.17
release
2024-01-31 15:29:52 -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
Juarez Bochi
b55feb5696
Fix --use_xcode documentation (#18520) 2023-12-07 14:48:10 -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
Changming Sun
be3c14939f
Update Cross-compiling instructions (#18205) 2023-10-31 16:10:28 -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
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
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
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
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
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
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
Changming Sun
f124846ae8
Update build instructions (#16012) 2023-05-25 10:05:59 -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
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
Nat Kershaw (MSFT)
bd1b8a824c
Remove the generated outputs for the API docs as these are now publis… (#15244) 2023-05-02 11:09:49 -07:00
Nat Kershaw (MSFT)
931d6baca2
Fix website publish trigger (#15285) 2023-03-30 14:37:56 -07:00
ivberg
c7ea60ef39
Update inferencing.md with specific build instructions for VS 2022 (#14905) 2023-03-17 16:52:36 -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
Nat Kershaw (MSFT)
4a89a7b2da
Version 1.14 docs sweep (#14789) 2023-03-14 12:01:21 -07:00
PeixuanZuo
97b1115a59
[ROCm] Update doc for ROCm 5.4 (#14494)
### Description
1. Delete preview label for ROCm/MIGraphX and update ROCm/MIGraphX
supported architecture. https://peixuanzuo.github.io/onnxruntime/
2. Update rocm training guide to ROCm5.4.
https://peixuanzuo.github.io/onnxruntime/docs/build/training.html#gpu--rocm
2023-01-31 17:28:11 -08: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
Rachel Guo
78e22e851f
[doc] Add proguard rules for R8 minimized Android build (#14407) 2023-01-24 10:05:29 -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
Yulong Wang
4a9e20aa30
[doc] update Prerequisites in "Build for Web" (#14357) 2023-01-19 10:40:23 -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
Changming Sun
3e1808dc59
Update ORT inference build instructions (#13326) 2022-10-17 09:42:34 -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
shalvamist
a453835a9b
update for ORT Web build guide (#12247)
* update for ORT Web guide

I reordered a few things and added some more context.
I think we can also add more information on converting ONNX to ORT format fairly easily. maybe in the doc update next iteration :)

* Doc update - Following the github discussion

* Update web.md

Updated the doc - fixed the title hierarchy
Added a small comment regarding the final build products.

* Update web.md

Updated the titles "Build ONNX Runtime for web assembly" --> "Build ONNX Runtime web assembly artifacts"
Updated the "build NPM package" doc section - clarified the different sections of the build process

* Update web.md

Fixed a broken link

* Update web.md

Adding a section to clarify there is one last step for finalizing the build process
2022-09-06 16:32:53 -07:00