Commit graph

39 commits

Author SHA1 Message Date
Sophie Schoenmeyer
adc0c9024c
ORT 1.20 docs update (#22693)
### Description
<!-- Describe your changes. -->
Updating links in the operator docs to reference releases 1.19 + 1.20.


### 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-11-04 09:08:46 -08:00
Edward Chen
29209784dd
[docs] Mobile doc updates (#21605)
### Description
<!-- Describe your changes. -->

- Update Android build instructions.
- Remove references to "mobile" packages with reduced operators and
minimal build which have been removed in 1.19.
  In particular, these packages:
  - onnxruntime-mobile-c/objc (iOS)
  - onnxruntime-mobile (Android)

https://edgchen1.github.io/onnxruntime/docs/

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

Update and remove obsolete documentation.
2024-08-15 16:28:19 +10:00
Sophie Schoenmeyer
7c820c45b1
Docs updates for ORT 1.18 (#20610)
### Description
Update compatibility/version info for ORT 1.18 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. -->
2024-05-21 17:27:56 -07: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
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
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
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
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
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
Nat Kershaw (MSFT)
19687c00ee
Fix custom op docs (#17571) 2023-09-15 19:20:10 -07:00
RandySheriffH
54ebb4ded7
Doc custom op lifetime (#17576) 2023-09-15 19:14:19 -07:00
RandySheriffH
73e0000190
Doc custom op lite (#17287)
Doc custom op lite for a few key improvements:

1. lite interface.
2. cuda & rocm support.
3. one op, varied data type.

---------

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2023-08-30 12:48:46 -07:00
Changming Sun
467d0347b0
Update doc links for operators and kernels (#16101) 2023-05-25 10:05:12 -07:00
Baiju Meswani
25125b5b91
Training related changes to the onnxruntime website (#15900)
Changes include:

- Added a new page for `On-Device Training` overview:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/get-started/on-device-training.html)
- Added a new section for `On-Device Training` installation:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/install/#install-for-on-device-training)
- Added a new section for `On-Device Training` build from source:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/build/training.html#build-for-on-device-training)
- Updated Large Model Training overview, installation, build pages to
reflect what is currently accurate.

Website preview: https://baijumeswani.github.io/onnxruntime/


Pending website work:
- Update links for released packages for training.
- Add tutorial for on-device training
- Add links to the blog posts that detail on device training.
2023-05-17 14:45:52 -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
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
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
e17d43dbdd
[doc] Update mobile custom build instructions, update ORT GitHub URLs to use 'main' (#14409) 2023-01-24 10:46:24 -08: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
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
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)
6da9240866
Add link to release plan (#11521) 2022-05-23 11:04:29 -07:00
Scott McKay
0203bcc575
All v1.11 mobile package operator docs (#11050) 2022-04-04 17:33:48 -07: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
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -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
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
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
Nat Kershaw (MSFT)
15291ab4c9
Migrate content from GitHub source to GitHub pages (#5053)
* Test re-using page layout from current ONNX Runtime website for docs

* Add content for documentation on website

* Fixed most broken links

* Copy just-the-docs theme sources into repo

* Remove local theme files as this did not work with GitHub

* Remove nojekyll file

* Move image assets into single location

* Add Contents to markdown files and ensure only one h1

* Update after review

* Fix img links

* Add trailing slash to main nav links

* Fix broken links on main docs page

* Re-fix broken links on main docs page

* Fix broken links #3

* Fix broken links #4

* Fix broken links #5

* Fix broken links #6

* Fix paths to global assets

* Add updates since fork

* Update custom op docs

* Fix link
2020-10-12 10:28:20 -07:00