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
Maanav Dalal
25cd2bfa1a
Fixed youtube cookies ( #19765 )
...
### Description
Simple change, should allow removal of all the errors associated with
GDPR (not Adobe, but Adobe isn't seeming to error)
## Note
Will need to change consent banner to using
[this](https://eng.ms/docs/cloud-ai-platform/devdiv/one-engineering-system-1es/1es-docs/wcp/privacy/wcp-cookie-consent-api#cookie-consent-library---javascript )
library in accordance with errors. Is known and will be worked on
hopefully before EOW.
---------
Co-authored-by: MaanavD <maanavdalal@microsoft.com>
2024-03-04 14:51:38 -08:00
Nat Kershaw (MSFT)
53a2b2b9fe
Improve meta description of YOLOv8 tutorial ( #19674 )
2024-02-29 15:31:14 -08:00
Nat Kershaw (MSFT)
1a6b0a9072
Add pose detection tutorial ( #19580 )
2024-02-26 16:52:00 -08: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
ivberg
7e64928b06
Added docs for ONNX 1.17 covering logging, tracing, and QNN EP Profiling ( #19428 )
...
### Description
Added docs for ONNX 1.17 covering logging, tracing, and QNN EP Profiling
### Motivation and Context
- ONNX Logging has not been documented
- ONNX Tracing with Windows has barely been documented
- ONNX 1.17 has new tracing and QNN EP Profiling
PRs: #16259 , #18201 , #18882 , #19397
2024-02-07 10:47:15 -08:00
Caroline Zhu
ad7d0fbc74
Add web documentation + installation instructions ( #19342 )
...
### Description
Updated docs section with information on installation and building.
Live previews of modified pages:
* [Installation
table](https://carzh.github.io/onnxruntime/getting-started ) -- under the
Optimize Training tab
* [Build for
training](https://carzh.github.io/onnxruntime/docs/build/training.html )
* [Getting started with
web](https://carzh.github.io/onnxruntime/docs/get-started/with-web.html )
-- added link to E2E demo code
* [Install for on-device
training](https://carzh.github.io/onnxruntime/docs/install/#install-for-on-device-training )
* [Tutorials page for On-device
training](https://carzh.github.io/onnxruntime/docs/tutorials/on-device-training/ )
-- this page looks a little odd with just the link to the E2E demo.
potential alternative of creating a separate page that links to the demo
+ mentions that a tutorial will be coming soon?
### Motivation and Context
- Updating docs with information about ORT Training for Web for 1.17
release
2024-01-31 15:29:52 -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
Furkan Salık
1fb1dcee69
Fix duplicate 'dotnet add package' in Nuget package installation commands ( #18824 )
2023-12-18 14:58:49 -08:00
matyash12
1850869861
Typo ( #18327 )
...
fix typo elctron => electron
2023-11-07 13:04:11 -08:00
Nat Kershaw (MSFT)
082ce696c0
Editorial pass of C# tutorial ( #17704 )
2023-10-11 17:27:04 -07:00
Dmitri Smirnov
f3fa223ee8
Update C# Pages in view of the new preferred inference API ( #17642 )
...
### Description
Re-work C# code samples with OrtValue API.
Bring `C# Tutorial: Basic` to index.
The site is currently published
[here](https://yuslepukhin.github.io/onnxruntime )
### Motivation and Context
Direct all future usage to `Ortvalue` API
2023-09-26 10:35:20 -07:00
Vrajang Parikh
fcd241f145
Add iOS On Device Training Tutorial with ONNX Runtime ( #17146 )
...
### Description
This pull request introduces comprehensive tutorial for performing on
device training on iOS devices using Objective-C/Swift on device
training APIs.
Preview:
https://vraspar.github.io/onnxruntime/docs/tutorials/on-device-training/ios-app.html
Example App:
https://github.com/microsoft/onnxruntime-training-examples/tree/master/on_device_training/mobile/ios/MyVoice
---------
Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
Co-authored-by: Baiju Meswani <baijumeswani@gmail.com>
2023-08-17 00:58:22 -07:00
Sayan Shaw
85719a2a9d
remove unneeded no-toc from superres ( #16682 )
...
Co-authored-by: Sayan Shaw <sayanshaw@microsoft.com>
2023-07-13 17:10:32 -07:00
Baiju Meswani
307d5afe5f
Add On Device Training Tutorial with ONNX Runtime ( #16167 )
2023-06-15 16:01:26 -07: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
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
Nat Kershaw (MSFT)
783b40bdb8
Add preview image for stable diffusion tutorial ( #15090 )
2023-03-20 16:09:36 -07:00
Cassie Breviu
c5dfd1ce81
Add csharp dml sample code to EP doc and Stable Diff Repo ( #15103 )
2023-03-17 17:14:11 -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
Nat Kershaw (MSFT)
07c70de93e
Add preview image for super res tutorial and update title ( #15004 )
2023-03-11 20:15:35 -08: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
Cassie Breviu
99a7b6d621
Add stable diff csharp tutorial ( #14892 )
...
### Description
https://cassiebreviu.github.io/onnxruntime/docs/tutorials/csharp/stable-diffusion-csharp.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. -->
2023-03-03 10:46:05 -06:00
Nat Kershaw (MSFT)
c1c00e7a13
Add pre-release onnxruntime-extensions python package install instru… ( #14737 )
2023-02-22 16:28:52 -08:00
Nat Kershaw (MSFT)
345214c0f4
Update superres.md ( #14721 )
2023-02-22 16:28:33 -08:00
Nat Kershaw (MSFT)
a28edaada7
Add link to new tutorial ( #14720 )
2023-02-16 14:00:56 -08:00
Nat Kershaw (MSFT)
291da10ab7
Mobile superres tutorial ( #14635 )
2023-02-15 15:38:25 -08:00
Cassie Breviu
0aad172162
Update cuda csharp doc ( #14482 )
...
### Description
Update to clarify steps to install cuda
https://cassiebreviu.github.io/onnxruntime/docs/tutorials/csharp/csharp-gpu.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. -->
2023-01-31 13:49:36 -06:00
Nat Kershaw (MSFT)
a91b554685
Refresh mobile get started ( #14447 )
2023-01-31 11:30:27 -08:00
Cassie Breviu
1b9772352d
Add two new blogs that were posted this week to the news section and C# GPU tutorial ( #14443 )
...
Co-authored-by: Nat Kershaw <nakersha@microsoft.com>
2023-01-27 15:38:50 -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
Nat Kershaw (MSFT)
7717184965
Revert iot URL to original iot-edge ( #14150 )
...
This maintains backwards compatibility for backlinks and traffic
telemetry
2023-01-05 19:52:05 -06:00
Cassie Breviu
b9d6776849
Update the IoT Docs home page and add Raspberry Pi Tutorial ( #14096 )
...
### Description
https://cassiebreviu.github.io/onnxruntime/docs/tutorials/iot/
https://cassiebreviu.github.io/onnxruntime/docs/tutorials/iot/rasp-pi-cv.html
Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2023-01-05 18:33:30 -06: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)
a614c31457
Update pytorch.md ( #12865 )
...
Fix code snippet type to get correct code syntax highlighting
2022-10-12 18:10:01 -07:00
Nat Kershaw (MSFT)
4186ede6f8
Add example of specific image to website link previews ( #12866 )
...
Add `image: /images/azureml-deployment.png` to the article front matter.
2022-09-30 10:37:07 -07:00
Nat Kershaw (MSFT)
97180a1056
Pytorch inference ( #12613 )
...
* Skeleton for PyTorch inference page
* Add outline
* Add different inference options
* Added section on ONNXRuntime
* Refine title
* Minor reword
* Update after review
* Minor edits
* Add link to get started
* Clarify intro text
* Add review improvements
2022-09-02 19:03:21 -07:00
Cassie Breviu
f5b30bdfc9
update links to new api ( #12836 )
2022-09-02 08:32:39 -07:00
Kevin Huang
66228bff24
Add tutorial for Resnet cross platform inference ( #12566 )
2022-08-16 13:27:38 -07:00
brev
980211b477
Create C# inference section and added C# BERT NLP tutorial ( #12472 )
2022-08-04 15:59:28 -07:00
Faith Xu
f39fbbf6f7
[Website/Docs] Add quote and reorganize docs navigation ( #12355 )
2022-07-29 12:44:36 -07:00
andife
bfabb388f5
Update fasterrcnn_csharp.md ( #11513 )
...
adapted according to https://github.com/microsoft/onnxruntime/pull/11420
2022-06-06 13:28:32 -07:00
