Commit graph

65 commits

Author SHA1 Message Date
Shubham Bhokare
d5908da9c3
[docs] Fix fp16 mixed precision example to reflect correct input variable names (#22250)
### Description
Correct variable name from `test_data` to `feed_dict` to fix example
code in mixed precision example docs.



### Motivation and Context
Fixes #21822
2024-10-01 11:21:14 -07:00
Michael Tyler
7faa4b1eb4
Update documentation for Arm Compute Library (#22232)
### Description
This PR updates the documentation regarding the ACL execution provider
to reflect the changes made in #22032.
It also updates various references to Arm's trademarks in accordance
with the Arm trademark use guidelines.



### Motivation and Context
Ensures documentation is accurate following recent changes.

---------

Signed-off-by: Michael Tyler <michael.tyler@arm.com>
2024-09-30 18:56:27 -07:00
Jing Fang
6265c3acf2
Add 4bit quantizer to onnx runtime doc (#21835)
### Description
Introduce how to use matmul_4bits_quantizer to do weight only
quantization.

### Motivation and Context
Add 4bit quantizer to onnx runtime doc
2024-08-26 18:12:13 -07:00
Satoshi Yoshikawa
99bfaa3a97
Correct Spelling and Proper Capitalization in Documentation (#21790)
This pull request addresses several spelling errors and inconsistencies
in the capitalization of proper nouns within the documentation.

### Motivation and Context
To improve the quality of the documentation, spelling errors and
capitalization mistakes have been corrected. This ensures that the
content is more accurate and easier to read.
2024-08-19 08:47:58 -07:00
Maanav Dalal
77df36bde1
NimbleEdge and ONNXRuntime Blog June 17 (#21040)
DRAFT PR until images and thumbnail are provided

---------

Co-authored-by: Scott McKay <Scott.McKay@microsoft.com>
Co-authored-by: Emma Ning <43255631+EmmaNingMS@users.noreply.github.com>
2024-06-17 10:39:01 -07:00
Tianlei Wu
736ed7aeb7
[Doc] Fix links in Device Tensor Doc (#21039) 2024-06-13 15:25:44 -07:00
Maximilian Müller
f20db76f54
Add device tensor documentation for GPU execution providers (#20837)
This documentation adds documentation on:
- how to allocate CUDA device tensors from C++ and python
- how to use DML device tensors from C++ and python
- it also shows how to leverage existing GPU allocations in ORT 
- how to overlap PCI copies and GPU execution using CUDA streams
- how to overlap PCI copies and GPU execution using D3D12 Command Lists
and custom resources
---------

Co-authored-by: Tianlei Wu <tlwu@microsoft.com>
2024-06-12 09:11:25 -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
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
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
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
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
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
ivberg
701728956e
Update ORT Performance threading docs (#16995) 2023-09-25 14:36:50 -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
Baiju Meswani
307d5afe5f
Add On Device Training Tutorial with ONNX Runtime (#16167) 2023-06-15 16:01:26 -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
leqiao-1
471a31cce4
modify olive doc section (#15593) 2023-05-04 11:34:47 -07:00
Ye Wang
3764093df0
update docs for a new cuda provider option: enable_skip_layer_norm_strict_mode (#15770) 2023-05-02 17:54:59 -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
ivberg
c88ced49d3
Update tune-performance.md with tooling info for opening .json perf traces (#14906)
### Description
-WPA OSS plugins
-Pertetto UI which is recommended by Google over deprecated
chrome://tracing experience


### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- I tried both chrome://tracing and Perfetto to open the .json and it's
not a great expreince. If on Windows, WPA is a MUCH better experience
and easier to work with the data/report. Also Google recommends Perfetto
vs chrome://tracing so updated that as well
2023-04-06 14:59:32 -07:00
leqiao-1
8f04e2bea5
olive doc update (#15261)
Olive v2 has been released, and we need to update the doc related to
Olive v1.
2023-03-29 12:49:06 -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
Prasanth Pulavarthi
f69691fb1d Revert "Revert "Merge branch 'gh-pages' of https://github.com/microsoft/onnxruntime into gh-pages""
This reverts commit 20c745c749.
2023-03-10 17:02:38 -08:00
Prasanth Pulavarthi
20c745c749 Revert "Merge branch 'gh-pages' of https://github.com/microsoft/onnxruntime into gh-pages"
This reverts commit 063f84744e, reversing
changes made to 6f2f1e8dac.
2023-03-10 16:58:21 -08:00
Yulong Wang
dbbd0e7372
[doc] revise example C++ code of using file path (#14872)
### Description
revise example C++ code of using file path.

normalize the example code to use macros `ORTCHAR_T` and `ORT_TSTR`
defined in onnxruntime_c_api.h so that the code works in both Windows
and UNIX.

This PR resolves #14859
2023-03-09 11:04:59 -08:00
Faith Xu
bd9b15fd4d
[Docs] Docs updates (#14824)
### Description
Staged: https://faxu.github.io/onnxruntime/docs/

Changes:
- ~~New dedicated section on sidebar for
[Mobile](https://faxu.github.io/onnxruntime/docs/mobile/) and
[Web](https://faxu.github.io/onnxruntime/docs/web/)~~ New dedicated
pages for
[Mobile](https://faxu.github.io/onnxruntime/docs/get-started/with-mobile.html)
and
[Web](https://faxu.github.io/onnxruntime/docs/get-started/with-web.html)
under Getting Started section
- [Transformers
optimizer](https://faxu.github.io/onnxruntime/docs/performance/transformers-optimization.html)
documentation
- Move contrib op section from "Custom Operators" page to ["Contrib
operators"
page](https://faxu.github.io/onnxruntime/docs/reference/operators/ContribOperators.html)
- Update [releases
page](https://faxu.github.io/onnxruntime/docs/reference/releases-servicing.html)
2023-03-08 11:54:58 -08:00
Maanav Dalal
9913bf5a8a
Website Visual Updates & Fixing Broken Links (#14430) 2023-01-27 13:10:22 -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
kshama-msft
7901974190
Fix typo Reference -> Performance (#13581) 2023-01-19 16:23:59 -08: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
acid-space-cowboy
c0e3e10f34
Minor updates to include QDQ Dynamic (#12839)
Minor updates in the ONNX quantization representation format section to reflect the addition of QDQ Dynamic feature.
2022-09-02 11:18:36 -07:00
Chen Fu
f3a9b9b2fd
quantization doc (#12808) 2022-09-01 09:45:26 -07:00
Faith Xu
552b70f82a
[Website] Add ORT at MS page and doc fixes (#12518)
* add ort at microsoft page

* remove openmp references

* update EP table

* update ort-at-microsoft page

* fix link

* Change ORT to ONNX Runtime

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2022-08-10 10:08:58 -07:00
Faith Xu
f39fbbf6f7
[Website/Docs] Add quote and reorganize docs navigation (#12355) 2022-07-29 12:44:36 -07:00
chausner
8d750f5702
Various minor tweaks in documentation (#11193) 2022-06-06 13:29:09 -07:00
Václav Volhejn
ba0216c9f6
Fix grammar and style issues in quantization docs (#11601) 2022-05-24 10:37:14 -07:00
Ender
8533e50b24
update docs/performance: fix typo (#11372)
Here it should be `max` instead of `abs` for symmetric quantization.
2022-05-16 11:08:32 -07:00
Yufeng Li
1dd2b035fe
update quantization documentation (#11282) 2022-04-20 11:56:31 -07:00
Edward Chen
40dcaabe4c
[docs] Update mobile performance tuning docs for 1.11 (#11149)
* custom.md - use release tags

* Rename mobile performance tuning doc.

* Move old mobile performance tuning docs.

* remove title

* Adapt original documentation and add more for 1.11.

* Adjust doc ordering.

* Update version text.

* Update nav, fix links.

* rework docs
2022-04-11 13:44:36 -07:00
Edward Chen
645ebcb5af
ORT 1.11 mobile doc updates (#11062)
* Save updates.

* save changes

* Update install matrix text.

* save updates

* Rename ort-model-format.md to ort-format-models.md.

* Remove redirect_from entry, doesn't seem to work.

* PR comments.

* Reword.
2022-04-06 09:50:44 -07:00
Vincent Wang
59df74e0a9
[Doc] Provider Option cudnn_conv1d_pad_to_nc1d (#11040)
* doc for cudnn_conv1d_pad_to_nc1d

* update doc
2022-04-04 08:20:23 -07:00
Hariharan Seshadri
d87f5eeeab
Fix formatting of tune performance page (#11014)
* Fix formtatting

* Update

* Modify python comment style

* More changes

* Fix OpenVINO links
2022-03-28 13:32:50 -07:00
Hariharan Seshadri
8573fd4c60
Document the usage of the CUDA Graphs feature (#10859) 2022-03-24 10:50:56 -07:00
Nat Kershaw (MSFT)
8b9c23aac9
Fix formatting issues in the perf tuning doc (#10867) 2022-03-16 12:52:00 -07:00
RandySheriffH
0236984d6a
Document dynamic cost model and perf view (#10734)
* Explain the usage of dynamic cost model

* add tool usage

* fix a few grammar

* refactor

* refactor

* refactor

* fixing comments

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2022-03-02 16:02:16 -08:00
TomWildenhain-Microsoft
9543e176bf
Add float16 docs (#8822) 2022-01-13 17:35:26 -08:00
Hariharan Seshadri
2a8cf1507c
[Doc] Misc CUDA EP doc changes (#10216) 2022-01-07 17:54:43 -08:00
Edward Chen
b89d01bcdc
Updated documentation for reduced op build process. (#10152) 2022-01-04 09:33:52 -08:00