Commit graph

454 commits

Author SHA1 Message Date
Sophie Schoenmeyer
82e2da0819
Update with-python.md with CUDA 12.X instructions (#20442)
### Description
with-python.md does not currently include installation instructions for
CUDA 12.X, so I added the instructions from
https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html#requirements.



### 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-23 14:32:17 -07:00
Sophie Schoenmeyer
be0c6c93f5
Update index.md with table of contents (#20441)
### Description
File previously included TOC placeholder instead of actual TOC



### 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-23 14:32:06 -07:00
Sophie Schoenmeyer
ff5c5c5cdc
Update CUDA-ExecutionProvider.md to add TOC (#20443)
### Description
CUDA-ExecutionProvider.md table of contents previously not showing up
correctly b/c of spacing issue.



### 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-23 14:31:49 -07:00
Nat Kershaw (MSFT)
0ebd6b46ff
Update generate() API docs (#20433)
Light edit of generate() docs
2024-04-23 09:16:55 -07:00
Nat Kershaw (MSFT)
a3eceb52f3
Add build from source for DML (#20384) 2024-04-21 15:00: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
Nat Kershaw (MSFT)
d3551b0069
Add instructions to build generate() API from source on Mac (#20342)
Staged here:
https://natke.github.io/onnxruntime/docs/genai/howto/build-from-source.html#option-3-build-from-source
2024-04-17 09:22:39 -07:00
Nat Kershaw (MSFT)
92cbb4249d
Improve build instructions (#20251) 2024-04-09 19:12:53 -07:00
Nat Kershaw (MSFT)
4a0a4ce205
Improve generate() API build instructions (#20181)
Staged here:
https://natke.github.io/onnxruntime/docs/genai/howto/build-from-source.html
2024-04-05 11:31:26 -07:00
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
Scott McKay
e0a6a9640b
Update CoreML EP docs (#19844)
### Description
Add new flags and MLProgram supported ops.

### Motivation and Context
Update docs
2024-04-04 21:54:09 -07:00
Manix
435e9a33dc
Update quantization.md for QDQ and dynamic quantization old doc (#20130)
- doc suggests that QDQ model are created with dynamic quant, which is
not the case anymore.
- updating and restructuring the doc

### Description
<!-- Describe your changes. -->
- QDQ model format representation doesn't come for dynamic quantization,
but the doc was suggesting.
- May be a couple of years back this support was there but not anymore


### 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. -->
- Clears misunderstanding that QDQ Onnx models can be created with
dynamic quantization.

https://github.com/microsoft/onnxruntime/issues/20125
2024-04-04 21:38:20 -07:00
wangshuai09
216231d197
[CANN] Update the doc of CANN EP (#20138)
This PR update docs of Ascend CANN excution provider doc for #20075 

### Changes
1. Add new option
`dump_om_model`: Whether to dump the OM(Offlined Model for Aasend Npu)
to disk

---------

Co-authored-by: Tianlei Wu <tlwu@microsoft.com>
2024-04-01 21:36:05 -07:00
Nat Kershaw (MSFT)
1ef08b350f
Add install ONNX Runtime from nightly (#20131)
### 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. -->
2024-04-01 21:33:46 -07:00
Yulong Wang
73173cc2c2
[doc] update Web tutorial (#19849)
### Description
This PR re-arranges "tutorial" documentation of ORT web on
onnxruntime.ai

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

### Changes

- Added page:
- [`Using
WebGPU`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/ep-webgpu.html)
- [`Working with Large
Models`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/large-models.html)
- [`Performance
Diagnosis`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/performance-diagnosis.html)
- [`Deploying ONNX Runtime
Web`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/deploy.html)
-
[`Troubleshooting`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/trouble-shooting.html)
(a placeholder for now)
2024-03-26 14:48:21 -07:00
rui-ren
f3efd8d265
a small fix for installation command (#20046)
Previous Command cannot `copy/paste` and install directly in terminal.
2024-03-23 10:22:57 -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
Jeff Mendenhall
180cb20298
Update QNN-ExecutionProvider.md (#20017)
update to link to Qualcomm SDK docs

### 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. -->
2024-03-21 16:30:16 -07:00
Nat Kershaw (MSFT)
2442ba9eec
Fix typo (#20002) 2024-03-20 17:19:20 -07:00
Hector Li
6f9c0a2fe7
Add option to enable FP16 precision for QNN EP (#19971)
add option to enable FP16 precision for QNN EP
2024-03-18 15:58:17 -07:00
Nat Kershaw (MSFT)
ad3653dbfc
Fix typo in GenAI python tutorial (#19962) 2024-03-18 10:47:54 -07:00
Nat Kershaw (MSFT)
2e93b41fab
Update index.md (#19941) 2024-03-17 20:19:06 -07:00
Nat Kershaw (MSFT)
e00773efce
Update phi2-python.md (#19943) 2024-03-15 13:49:05 -07:00
Nat Kershaw (MSFT)
0450035e1a
Add genai docs (#19750) 2024-03-14 15:35:55 -07:00
Yulong Wang
cdf838a194
[doc] fix invalid link in OpenVINO EP doc (#19855)
### Description
fix invalid link in OpenVINO EP doc
2024-03-12 12:13:49 -07:00
sfatimar
780fb2f53f
Update OpenVINO-ExecutionProvider.md (#19794)
### Description
Documentation Update for Release 1.17.1 



### Motivation and Context
This change is required for Documentation Update for Release 1.17.1
Packages.
Alignment with OpenVINO 2023.3.
2024-03-08 10:41:23 -08:00
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
Maanav Dalal
25cd2bfa1a
Fixed youtube cookies (#19765)
### Description
Simple change, should allow removal of all the errors associated with
GDPR (not Adobe, but Adobe isn't seeming to error)

## Note
Will need to change consent banner to using
[this](https://eng.ms/docs/cloud-ai-platform/devdiv/one-engineering-system-1es/1es-docs/wcp/privacy/wcp-cookie-consent-api#cookie-consent-library---javascript)
library in accordance with errors. Is known and will be worked on
hopefully before EOW.

---------

Co-authored-by: MaanavD <maanavdalal@microsoft.com>
2024-03-04 14:51:38 -08:00
Tianlei Wu
b6a1108c80
[Doc] CUDA build options (#19678) 2024-02-29 15:31:47 -08:00
Nat Kershaw (MSFT)
53a2b2b9fe
Improve meta description of YOLOv8 tutorial (#19674) 2024-02-29 15:31:14 -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
Nat Kershaw (MSFT)
1a6b0a9072
Add pose detection tutorial (#19580) 2024-02-26 16:52:00 -08:00
Maanav Dalal
19afa7641b
Adding cookie consent (#19635)
### Description
Adding cookie consent for google analytics (Adobe WIP), daisyui4 changes
and updates, updates to events page, and added MD blog support (for
upcoming blogs).

Staged at: https://maanavd.github.io/onnxruntime/

---------

Co-authored-by: MaanavD <maanavdalal@microsoft.com>
2024-02-26 11:15:05 -08:00
Yulong Wang
cfdb434a08
[doc] Update "Get Started" page for ORT web (#19568)
### Description
This PR re-arranges documentation of ORT web.

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

- split `Doc -> Get Started -> JavaScript` from single page into
multiple pages, to make it easier to split from web, node and
react-native
- remove `Doc -> Get Started -> with Web`. The page was a few links and
now they are moved to other places
- add a few contents into `Doc -> Get Started -> JavaScript -> Web`. Now
this is the main page for ORT web doc.
- rename `Tutorials -> deploy on Web` to `Tutorials -> Web`. "deploy" is
confusing as it's not the accurate term to describe the content.

=================================================================


### Discussions:
TBD


=================================================================


### ORT web documentation work item list:

- [ ] Update `Get Started` page for ORT web at onnxruntime.ai **( this
PR )**
    - to make it easier for users to navigate
- [ ] Update `Tutorials` page for ORT web at onnxruntime.ai
- The purpose of this page is unclear. It contains descriptive
information and step-by-step instructions on an E2E examples. It can be
a good Blog, but not good for documentation, which usually has a
well-structured content.
- The [index
page](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/) has
duplicated contents with its child page ["Build a web application with
ONNX
Runtime"](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/build-web-app.html)
    - Some contents are out-of-dated.
- [ ] Update [`API Usage -
SessionOptions`](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js/api-usage_session-options)
on onnxruntime-inference-examples repo.
- Add explaination and examples if necessary for all new WebGPU session
options.
- [ ] Update [`API usage - ort.env
flags`](https://github.com/microsoft/onnxruntime-inference-examples/blob/main/js/api-usage_ort-env-flags)
on onnxruntime-inference-examples repo.
    - Add all newly introduced flags.
2024-02-22 16:41:35 -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
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
sophies927
30e18950a1
Update operator docs w/ 1.17 info (#19522)
### 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. -->
2024-02-15 09:01:35 -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
Edward Chen
3dc7242272
[gh-pages][reduced-operator-config-file.md] Add documentation about globally allowed types. (#19441)
### Description
<!-- Describe your changes. -->

Add documentation about globally allowed types.


https://edgchen1.github.io/onnxruntime/docs/reference/operators/reduced-operator-config-file.html

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

Document additional configuration file syntax.
2024-02-13 15:53:10 +10: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
Scott McKay
9a8eda4ed0
Add 1.17 mobile package link to operators table (#19360)
### Description
<!-- Describe your changes. -->
Add link to new 1.17 page


### 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-01 11:40:14 +10: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
Scott McKay
e88f9d58f0
Add 1.17 mobile package info. Same as 1.16 (#19339)
### Description
<!-- Describe your changes. -->
Add list of operators/types for 1.17 mobile package.

Unchanged from 1.16. 

### 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-01 09:12:09 +10: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