Commit graph

422 commits

Author SHA1 Message Date
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
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
RandySheriffH
e679d998ad
Doc TP API and cuda resources (#19172)
Doc TP API and cuda resources.

---------

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2024-01-17 16:01:09 -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
Tianlei Wu
7720b66295
Fix nightly python package links in document (#18770)
### Description
Fix nightly python package links.

### Motivation and Context
https://github.com/microsoft/onnxruntime/issues/15608
https://github.com/microsoft/onnxruntime/pull/18712
2023-12-20 23:27:00 -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
Furkan Salık
1fb1dcee69
Fix duplicate 'dotnet add package' in Nuget package installation commands (#18824) 2023-12-18 14:58:49 -08:00
fanz-xlnx
7f42487b72
Update Vitis-AI-ExecutionProvider.md (#18706) 2023-12-07 14:49:33 -08:00
Juarez Bochi
b55feb5696
Fix --use_xcode documentation (#18520) 2023-12-07 14:48:10 -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
matyash12
1850869861
Typo (#18327)
fix typo  elctron =>  electron
2023-11-07 13:04:11 -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
Jordan
126c35b202
Update quantization preprocessing command in docs (#18146)
Command was split from `shape_inference.py` to address import sequence
warnings in 8004db4bf1 and was not
updated.

Anyone following the docs prior to this change would have encountered;

```
root@Raze:~# python -m onnxruntime.quantization.shape_inference --help
/usr/lib/python3.10/runpy.py:126: RuntimeWarning: 'onnxruntime.quantization.shape_inference' found in sys.modules after import of package 'onnxruntime.quantization', but prior to execution of 'onnxruntime.quantization.shape_inference'; this may result in unpredictable behaviour
  warn(RuntimeWarning(msg))
```

Instead of the expected;

```
root@Raze:~# ./onnxtesting/bin/python -m onnxruntime.quantization.preprocess --help
usage: preprocess.py [-h] --input INPUT --output OUTPUT [--skip_optimization SKIP_OPTIMIZATION] [--skip_onnx_shape SKIP_ONNX_SHAPE]
                     [--skip_symbolic_shape SKIP_SYMBOLIC_SHAPE] [--auto_merge] [--int_max INT_MAX] [--guess_output_rank]
                     [--verbose VERBOSE] [--save_as_external_data] [--all_tensors_to_one_file]
                     [--external_data_location EXTERNAL_DATA_LOCATION]
                     [--external_data_size_threshold EXTERNAL_DATA_SIZE_THRESHOLD]

Model optimizer and shape inferencer[continues]
```
2023-10-30 09:12:34 -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
Maanav Dalal
918f4aa1fa
Website revamp final (#17638)
Co-authored-by: MaanavD <maanavdalal@microsoft.com>
Co-authored-by: Prasanth Pulavarthi <prasanth.pulavarthi@microsoft.com>
Co-authored-by: Sophie Schoenmeyer <sschoenmeyer@microsoft.com>
Co-authored-by: sophies927 <107952697+sophies927@users.noreply.github.com>
Co-authored-by: Parinita Rahi <101819959+parinitarahi@users.noreply.github.com>
Co-authored-by: kshama-msft <66488860+kshama-msft@users.noreply.github.com>
2023-10-27 17:26:41 -07:00
Nat Kershaw (MSFT)
082ce696c0
Editorial pass of C# tutorial (#17704) 2023-10-11 17:27:04 -07:00
Nat Kershaw (MSFT)
d910f96f08
Update CoreML-ExecutionProvider.md (#17873) 2023-10-11 11:13:56 -07:00
Sayan Shaw
fb7a2e08fd
Add SentencePieceTokenizer and GPT2Tokenizer examples for Extensions Python converter API docs (#17708)
Co-authored-by: Sayan Shaw <sayanshaw@microsoft.com>
2023-10-05 15:37:09 -07:00
Arthur Kim
6b12dc5f6f
Python API has no AddConfigEntry and kOrtSessionOptionsConfigAllowIntraOpSpinning (#17712)
### Description
<!-- Describe your changes. -->


bcc6205161/include/onnxruntime/core/session/onnxruntime_session_options_config_keys.h (L94C74-L94C105)

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


@ivberg
2023-09-26 23:33:46 -07:00
Dmitri Smirnov
f3fa223ee8
Update C# Pages in view of the new preferred inference API (#17642)
### Description
Re-work C# code samples with OrtValue API.
Bring `C# Tutorial: Basic` to index. 

The site is currently published
[here](https://yuslepukhin.github.io/onnxruntime)


### Motivation and Context
Direct all future usage to `Ortvalue` API
2023-09-26 10:35:20 -07:00
Scott McKay
acc1b8b5ea
Update some op docs for release (#17626)
### Description
<!-- Describe your changes. -->
Update some ops docs for 1.16 release


### 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-25 14:57:39 -07:00
ivberg
701728956e
Update ORT Performance threading docs (#16995) 2023-09-25 14:36:50 -07:00
Caroline Zhu
e0c98ce56b
[website] Updated ORT-training installation instructions (#17538)
### Description
Live preview [here](https://carzh.github.io/onnxruntime/).

* updates CUDA option in training to be a specific CUDA version
* updates with the now-preferred devops source for stable version for
1.16.0

### Motivation and Context
* updates installation command for stable ORT training
2023-09-21 15:13:08 -07:00
Vincent Wang
07eed73d94
Update Docs for rel-1.16.0 (#17588)
Update docs for release 1.16.0.
2023-09-21 09:01:31 -07:00