Commit graph

21 commits

Author SHA1 Message Date
Wanming Lin
f840702faa
[WebNN] Update usage of MLTensor to align with latest spec (#22959)
Remove deprecated 'numThreads' option BTW.
2024-12-03 13:32:51 -08:00
Wanming Lin
30e0696cea
[doc] Update MLTensorUsage (#22127)
- WRITE_TO => WRITE
- READ_FROM => READ
2024-09-18 09:35:23 -07:00
Wanming Lin
2403930510
[doc] Rename MLBuffer => MLTensor for WebNN EP (#22039) 2024-09-11 13:29:51 -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
Wanming Lin
bd060aba69
[doc] Add page for using WebNN EP (#21736)
Preview:
https://honry.github.io/onnxruntime/docs/tutorials/web/ep-webnn.html
2024-08-14 09:09:36 -07:00
Yulong Wang
67ba2e5032
[doc] update docs for ORT web v1.19 (#20756)
### 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-05-21 16:26:10 -07:00
Wanming Lin
944db3ed6c
[WebNN EP] Add WebNN doc (#20733)
- Add WebNN EP build instruction
- Update WebNN Chromium flag in tutorial
- Some minor updates
2024-05-21 00:17:31 -07:00
Yulong Wang
73173cc2c2
[doc] update Web tutorial (#19849)
### Description
This PR re-arranges "tutorial" documentation of ORT web on
onnxruntime.ai

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

### Changes

- Added page:
- [`Using
WebGPU`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/ep-webgpu.html)
- [`Working with Large
Models`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/large-models.html)
- [`Performance
Diagnosis`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/performance-diagnosis.html)
- [`Deploying ONNX Runtime
Web`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/deploy.html)
-
[`Troubleshooting`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/trouble-shooting.html)
(a placeholder for now)
2024-03-26 14:48:21 -07:00
Yulong Wang
cfdb434a08
[doc] Update "Get Started" page for ORT web (#19568)
### Description
This PR re-arranges documentation of ORT web.

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

- split `Doc -> Get Started -> JavaScript` from single page into
multiple pages, to make it easier to split from web, node and
react-native
- remove `Doc -> Get Started -> with Web`. The page was a few links and
now they are moved to other places
- add a few contents into `Doc -> Get Started -> JavaScript -> Web`. Now
this is the main page for ORT web doc.
- rename `Tutorials -> deploy on Web` to `Tutorials -> Web`. "deploy" is
confusing as it's not the accurate term to describe the content.

=================================================================


### Discussions:
TBD


=================================================================


### ORT web documentation work item list:

- [ ] Update `Get Started` page for ORT web at onnxruntime.ai **( this
PR )**
    - to make it easier for users to navigate
- [ ] Update `Tutorials` page for ORT web at onnxruntime.ai
- The purpose of this page is unclear. It contains descriptive
information and step-by-step instructions on an E2E examples. It can be
a good Blog, but not good for documentation, which usually has a
well-structured content.
- The [index
page](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/) has
duplicated contents with its child page ["Build a web application with
ONNX
Runtime"](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/build-web-app.html)
    - Some contents are out-of-dated.
- [ ] Update [`API Usage -
SessionOptions`](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js/api-usage_session-options)
on onnxruntime-inference-examples repo.
- Add explaination and examples if necessary for all new WebGPU session
options.
- [ ] Update [`API usage - ort.env
flags`](https://github.com/microsoft/onnxruntime-inference-examples/blob/main/js/api-usage_ort-env-flags)
on onnxruntime-inference-examples repo.
    - Add all newly introduced flags.
2024-02-22 16:41:35 -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
matyash12
1850869861
Typo (#18327)
fix typo  elctron =>  electron
2023-11-07 13:04:11 -08:00
Yulong Wang
e62689f7ce
[doc] update document for webgpu (#16245)
### Description

update document for webgpu

Preview: https://fs-eire.github.io/onnxruntime/docs/
2023-06-06 13:00:33 -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
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
Cassie Breviu
7fb9d8e35d
Update Excel BERT ORT Web tutorial (#13887)
### Description
Update the Excel ORT Web tutorial


https://cassiebreviu.github.io/onnxruntime/docs/tutorials/web/excel-addin-bert-js.html
2022-12-07 18:33:26 -06:00
Cassie Breviu
8d612d6a04
Add Excel Add-in BERT NLP Custom Function Tutorial (#13826)
### Description
Add new tutorial for ONNX Runtime web to work in excel with local
models.


https://cassiebreviu.github.io/onnxruntime/docs/tutorials/web/excel-addin-bert-js.html
2022-12-06 09:35:58 -06:00
Nat Kershaw (MSFT)
eb7dd8adf1
Add AzureML tutorial (#11340) 2022-06-03 16:43:46 -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
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -08:00