Commit graph

63 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
Rui Ren
c3f424ef22
update ContribOperators and OperatorKernels (#14480) 2023-02-23 15:12:01 -08:00
Nat Kershaw (MSFT)
4536b0bf15
Add docs for mobile op support for recent releases (#14724) 2023-02-17 11:39:58 -08:00
Adrian Lizarraga
2a7f6796d3
[GH Pages] Update custom op documentation (#14623)
### Description
Updates custom op documentation on the github pages site. Also, includes
information about the [recent custom op
APIs](https://github.com/microsoft/onnxruntime/pull/13427) that enable
wrapping models to be inferenced with an external runtime.

Link to forked github pages with changes:
https://adrianlizarraga.github.io/onnxruntime/docs/reference/operators/add-custom-op.html


### Motivation and Context
Add documentation for new custom op features in the next release.
2023-02-10 16:48:24 -08:00
Edward Chen
25e11ef016
[doc] Add note about ORT format breaking change (#14414) 2023-01-25 14:00:16 -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
Nat Kershaw (MSFT)
bc6cafbae1
Add citation back into nav (#13153) 2023-01-19 17:04:55 -08:00
Faith Xu
ce563c3774
[documentation] Updates for clarity (#14329)
### Description
- bring up section on vc runtime requirement for visibility 
- update onnx/ort compatibility table
2023-01-17 16:51:10 -08:00
Nat Kershaw (MSFT)
785c8354ca
Update releases page to 1.13 (#13540) 2022-11-02 10:16:43 -07:00
Jian Chen
8a0f5c665f
Update OperatorKernels.md (#13420) 2022-10-24 16:45:28 -07:00
Jian Chen
8c50768fc1
Update ContribOperators.md (#13421) 2022-10-24 16:44:57 -07:00
Faith Xu
0979270ca2
[Docs] Fix link (#13220)
Addresses #13218
2022-10-10 17:50:12 -07:00
Scott McKay
ddaecc489c
Add doco on session.use_ort_model_bytes_for_initializers (#12805) 2022-08-31 13:17:48 -07:00
Faith Xu
f39fbbf6f7
[Website/Docs] Add quote and reorganize docs navigation (#12355) 2022-07-29 12:44:36 -07:00
RandySheriffH
e0be2ca4ea
update operator version (#12307)
Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2022-07-25 11:03:03 -07:00
Faith Xu
0e1e488824
[website] updates for 1.12 (#12262)
* v1.12 docs updates

* fix typo

* add TVM EP updates to matrix

* More matrix updates

* remove xamarin example text
2022-07-22 10:04:40 -07:00
RandySheriffH
943b54911b
Document standalone ops for 1.12.0 (#12221)
* comment on standalone ops

* touch up the grammar

* link API

* touch up the grammar

* reorder paragraphs

* rephrase

* add space

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2022-07-19 13:53:43 -07:00
josephrocca
392ca7e001
Add link to "Using Custom Ops with TF2ONNX" notebook (#12080) 2022-07-06 13:29:05 -07:00
Nat Kershaw (MSFT)
8c23c57a9f
Refactor DirectML and Windows docs (#12096) 2022-07-06 09:52:42 -07:00
Nat Kershaw (MSFT)
6da9240866
Add link to release plan (#11521) 2022-05-23 11:04:29 -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
Olivia Jain
b8ac9fd3bd
redo fix broken link (#11162)
* redo fix broken link

* fix other broken link
2022-04-08 10:58:22 -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
Scott McKay
9ad9ca827f
Add documentation for ORT Mobile helpers (#10890) 2022-04-05 17:05:43 -07:00
Scott McKay
0203bcc575
All v1.11 mobile package operator docs (#11050) 2022-04-04 17:33:48 -07:00
Scott McKay
dee932a189
Update compatibility table (#11051) 2022-04-04 17:32:53 -07:00
Edward Chen
b89d01bcdc
Updated documentation for reduced op build process. (#10152) 2022-01-04 09:33:52 -08:00
Faith Xu
193fefe88d
Update operator documentation (#8992) 2022-01-04 09:05:40 -08:00
Ye Wang
04eb56bdda
update OperatorKernels.md/ContribOperators.md (#9176) 2022-01-03 18:15:33 -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
Faith Xu
3b81325d6a
Update for latest versions (#9499) 2021-11-10 15:40:49 -08: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
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
Faith Xu
4ba6b3ed97
Update CUDA-ExecutionProvider.md (#8778) 2021-08-18 16:54:08 -07:00
Edward Chen
fb2e30a76c
[ArmNN][Doc]Use meaningful variable name (#8629)
Ported from this PR: https://github.com/microsoft/onnxruntime/pull/6122
2021-08-12 09:59:32 -07:00
Faith Xu
d8bb0da9f9
Documentation: fix link, nav, minor update (#8612)
* fix links

* update order of api nav

* update execution provider how to, original PR #6266
2021-08-09 20:31:51 -07:00
Matthew Nelson - Silverark
59f6271da1
cuda_mem_limit has been renamed to gpu_mem_limit (#8284)
`cuda_mem_limit` was renamed to `gpu_mem_limit` in nighlty build `nightly-1.7.0.dev202104231`.

https://github.com/microsoft/onnxruntime/issues/7457
2021-08-05 14:15:03 -07:00
Faith Xu
5501cd15f9
Documentation updates for installation instructions (#8520)
* update EP install instructions

* fix links in C++ mnist tutorial

* formatting

* content fixes

* minor fixes
2021-07-28 18:27:12 -07:00
Edward Chen
223f236136
[Objective-C API] Add API reference documentation (#8000)
* Add Objective-C API reference website files.

* Update Objective-C API doc.

* Update Objective-C API page.

* regenerate objc api docs

* Update sample link.

* Update Objective-C API reference to 1.8.0-preview version.

* Remove file with absolute paths.

* Add Swift bridging header info.

* Update Objective-C API reference for 1.8.1.

* Update references to Objective-C package.

* Say iOS package is in preview. Clean up.
2021-07-21 14:25:04 -07:00
Faith Xu
ae0d2ac1ac
Update EP table (#8416) 2021-07-20 14:03:35 -07:00
Maajid khan
35631d081d
[OpenVINO-EP] Update Documentation w.r.t latest 2021.4 Release (#8380)
* Update OpenVINO-EP docx w.r.t 2021.4 Release

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* updated cpp sample build commands with 2021.4

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-07-20 13:16:22 -07:00
Yulong Wang
25b2aa6d04
[doc] update a part of the documents for ORT JavaScript (#7935)
* update api-basics.md

* update install.md

* add placeholder for "build for web"

* update js api

* add more sections in js-api.md

* update "coming soon" for how-to-build-web

* Update "Web" -> "web" in title of web.md

* Update install.md
2021-06-08 10:47:27 -07:00
Hariharan Seshadri
68b1ba0e24
Some consolidated doc updates for ORT 1.8 (#7750)
* Add documentation

* Refine 1

* Refine 2

* PR comments

* update
2021-06-07 12:04:11 -07:00
Scott McKay
9e8d795344
Update ORT Mobile documentation (#7874)
* Update ORT Mobile documentation for both the pre-built package and custom build usage
Add info on pre-built package and CoreML EP
Refer to operator kernels and contrib ops documentation in github so we can point to the version specific content
Tweak some aspects like not specifying nav_order in places (items sort alphabetically by default)

* merge previous unmerged ios doc updates

* Address PR comments

* Minor tweaks

* Address PR comments

Co-authored-by: Guoyu Wang <wanggy@outlook.com>
2021-06-01 21:21:41 -07:00
Olivia Jain
40becfa479
make relative links (#7884) 2021-05-28 15:22:47 -07:00
Maajid khan
8c34414a97
[OpenVINO-EP] Update OpenVINO-EP documentation (#7860)
* [OpenVINO-EP] Update the Docx

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Added Relative paths for openvino-ep docx

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Modified the samples code path to new location

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-05-27 14:13:15 -07:00
Maajid khan
4251916500
[OpenVINO-EP] Added Documentation for OpenVINO-EP samples (#7827)
* Added documentation for OpenVINO-EP samples

->Add Tutorials of how to use the samples.
-> Updated the OpenVINO EP docx page to point
to these tutorials.

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Minor changes added in the documentation

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Modified the document

cleaned up the document

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* c# documentation modified

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-05-26 19:15:45 -07:00