Commit graph

40 commits

Author SHA1 Message Date
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
Gary Miguel
41a714bbb3
Lots of minor doc improvements (#9930) 2021-12-10 17:43:15 -08:00
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -08:00
leqiao-1
a1905624bc
change OLive description and related links (#9951)
* change OLive description and related links

* modify OLive description
2021-12-09 18:04:46 -08:00
Dmitri Smirnov
50127feab2
Document on the usage of mimalloc allocator (#9974)
[Enable proper mimalloc override](https://github.com/microsoft/onnxruntime/pull/9944) PR has fixed a number of issues with regards to building onnxruntime with mimalloc. This PR documents usage of mimalloc.
2021-12-08 12:25:04 -08:00
Hariharan Seshadri
70bd575cdd
Remove redundant doc lines (#9946) 2021-12-06 22:47:53 -08:00
Hariharan Seshadri
a0f76fe1a8
[Doc] Performance tuning of convolution heavy models with the CUDA EP (#9916)
* Initial commit

* More changes
2021-12-03 12:29:42 -08:00
RandySheriffH
30eba55992
Explain usage of --enable_cuda_profiling (#9882)
* explain usage of --enable_cuda_profiling

* remove cupti dependency
2021-11-29 21:46:42 -08:00
RandySheriffH
4bd7c2adf1
Document a few features for rel 1.10 (#9836)
* document threading hooks

* move doc to a separate section

* document cuda profiler numbers

* move doc

* specify cupti dependency

* add example inplace

* format code

* format code

* link to cxx api

* minor fix on grammar

* add new line

* minor fix on grammar

* minor fix on grammar

* minor fix on grammar

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2021-11-24 13:10:20 -08:00
Nat Kershaw (MSFT)
91e029d4f3
SEO audit of docs website (#9780) 2021-11-18 11:00:48 -08:00
Yi-Hong Lyu
bbb13fdbc5
Fix link to enum GraphOptimizationLevel (#9390) 2021-10-29 14:30:35 -07:00
Nat Kershaw (MSFT)
14825b3461
Add automatic link checking to docs website (and fix broken links) (#9566) 2021-10-27 10:43:10 -07:00
Faith Xu
6c8c8a9b12
[Docs] Update CUDA/TRT versions and menu format fixes (#9317)
* update cuda/trt versions

* update API doc links

* remove api doc parentage

* fix menu

* fix broken links

* open api links in new window
2021-10-14 11:28:17 -07:00
Edward Chen
3c9ca35f93
[Docs] Update mobile docs for 1.9 (#9237)
* Edgchen1/objc api reference 1.9 (#1)

* Update Objective-C API reference for 1.9.

* Update spelling.

* Test link changes.

* Fix links.

* Fix links and updates in mobile-performance-tuning.md.

* Fix links in tutorials/mobile/custom-build.md.

* Fix

* Fix

* Fix links in docs/tutorials/mobile/initial-setup.md.

* Fix links.

* Update note.

* Add 1.9 op type support page.

* Add nav info to page.

* Rename files to not have spaces.
2021-10-04 15:48:53 -07:00
Yufeng Li
54c667740f
Update links of quantization examples (#9109)
* Update links of quantization examples

* fix typo
2021-09-20 16:47:21 -05:00
Cassie
a0f3e30de6
Docs update: updated nav, get started sections, home page, apis (#9060)
* initial setup and rename "how to" to "setup"

* move API to main nav

* move api to main nav

* add get starated, rework nav order

* rename to install move mds out of install section

* update api nav and home page

* add install docs and python qs updates

* python get started work

* remove c and obj c for now

* move java, python, and obj-c docs under api folder

* move java api html to iframe (ugh)

* remove api docs w/o details, move api text getstar

* remove api docs wo detail updates get started

* remvoe iframes

* move eco system to main nav

* fix api buttons

* added more examples moved intro to ORT

* fix links

* fix get started titles

* fix get started titles

* fix more links

* fix more links

* more link fixes

* fix nav remove inferencing and training subnav

* fix top nav remove inference and training nav

* fix title

* fix tutorials nav hierarchy

* fix python api button

* add tenorflow keras example

* fix quickstart toc

* add imports fix spacing

* fix links

* update nav and python get started page

* move ort training example, add coming soon for iot

* update C# get started

* fix spacing on quantization

* Add some js get started content

* fix formatting

* fix typo

* removed onnx-pytorch and onnx-tf

* updated pip install torch and added links iot page

* added pytorch tutorial heirarchy

* updated web to docs soon added release blog link

* add web link
2021-09-15 16:23:42 -05:00