Commit graph

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


![image](https://user-images.githubusercontent.com/3302433/192908399-d9234328-e658-4cab-a304-c4391d21f5e6.png)
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
andife
f80f8f29e7
Update resnet50_csharp.md (#11514)
changes due to https://github.com/microsoft/onnxruntime/pull/11420
2022-06-06 13:28:11 -07:00
Nat Kershaw (MSFT)
eb7dd8adf1
Add AzureML tutorial (#11340) 2022-06-03 16:43:46 -07:00
Faith Xu
e19e17417d
fix formatting (#11183) 2022-04-12 13:07:07 -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
0112d97721
Fix link for FasterRCNN C# tutorial (#10857) 2022-03-15 16:29:49 -07:00
Nat Kershaw (MSFT)
45062f56b3
Fixed broken link in iOS mobile tutorial (#10011) 2021-12-10 17:56:20 -08:00
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -08:00
brev
29a7420095
Add the ORT-Web Tutorial, Add link to GitHub ORT Web template on docs home page (#9738)
* adde web blog and template section to home page

* mkae image larger

* fix gif to remove page jump due to dom update

* Update docs/tutorials/web.md

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

* reivew updates

* add toc

* removed dup jimp import

* fix toc

* change toc location

* fixed name to spellit out

* added ort js examples

* spell out web assembly

* changed webgl and wasm to lowercase

* add new to all array declarations

* formatting fixes in code

* fix line breaks

* fix indent

* fix indent

* fix spacing

* fix spacing

* fix spacing

* Update docs/tutorials/web.md

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

* change to bullet points to fix number

* change gif size to make it easier to read

* add alt text

* Update docs/tutorials/web.md

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2021-11-19 16:34:43 -06:00
Nat Kershaw (MSFT)
91e029d4f3
SEO audit of docs website (#9780) 2021-11-18 11:00:48 -08:00
Faith Xu
e341491f2d
[Docs] Fix tutorial links (#9721)
* Remove incorrect sample links

* Update tutorial list

* Add link to BERT model acceleration tutorial
2021-11-10 15:41:11 -08:00
Nat Kershaw (MSFT)
14825b3461
Add automatic link checking to docs website (and fix broken links) (#9566) 2021-10-27 10:43:10 -07:00
Nat Kershaw (MSFT)
cc17b1f91c
Fix broken link to python API tutorial (#9531) 2021-10-25 10:13:42 -07: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
Guoyu Wang
e617f97f4e
Update mobile EP (NNAPI/CoreML) op coverage (#9308)
* Add op supported

* Update the build and create session

* minor update

* Add new NNNAPI flag doc

* Address CR comments

* Correct strings in the sample code

* Update docs/tutorials/mobile/model-execution.md

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>

Co-authored-by: Edward Chen <18449977+edgchen1@users.noreply.github.com>
2021-10-11 11:31:25 -07:00
Faith Xu
c878b7e988
[Docs] Fix links and formatting (#9253)
* fix links and format issues

* fix sidebar ordering
2021-10-05 11:50:38 -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
Chi Lo
603ea0e2cf
Fix merge conflicts (#9104) 2021-09-17 14:01:15 -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
Gary Miguel
80267ba99a
doc improvements (#8950)
* ignore direnv configs

https://direnv.net/ is a useful tool but its configs are developer-specific

* improve inferencing build docs

* Format build arguments and command line flags as code.
  Without this, command line flags were being rendered with an
  en dash `–` rather than two hyphens `--`, which meant copy-pasting
  them would result in invalid command lines.
* Clarify how to avoid running tests.
* Minor formatting improvements.

* Update custom op docs

* Move contrib op example from PyTorch page to custom op page.
* On PyTorch page: document the use of pytorch_export_contrib_ops.
* On PyTorch page: Turn GitHub URLs into links.

Fixes #8818
2021-09-07 17:57:13 -07:00
Faith Xu
5a9619beb0
remove Keras-ONNX references (#8820) 2021-08-26 17:05:33 -07:00
manashgoswami
8b62250fcd
Manashgoswami gh pages (#8091)
* Update ort-training.md

* Update index.md

* Update index.md

* Update ort-training.md

* Update index.md

* Update install.md

* Update index.md
2021-08-04 16:51:15 -07:00
Olivia Jain
687cb2746f
Update OpenVINO Sample Code Links (#8550)
* Update squeezenet_classification_cpp.md

* Update tiny_yolo_v2_object_detection_python.md

* Update yolov3_object_detection_csharp.md

* Update squeezenet_classification_cpp.md

* Update tiny_yolo_v2_object_detection_python.md

* Update yolov3_object_detection_csharp.md
2021-07-29 20:35:19 -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
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