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
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
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
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
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
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
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
Nat Kershaw (MSFT)
1b61ac0517
Update compatibility.md for release 1.15 ( #16389 )
2023-06-16 11:53:50 -07:00
Nat Kershaw (MSFT)
63e53a3f00
Update releases ( #16108 )
2023-05-25 16:09:56 -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
Nat Kershaw (MSFT)
4a89a7b2da
Version 1.14 docs sweep ( #14789 )
2023-03-14 12:01:21 -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 063f84744e6f2f1e8dac
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
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
