Commit graph

28 commits

Author SHA1 Message Date
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
jingyanwangms
cebfed27c8
update install instruction and update 404 links (#8101)
Co-authored-by: Jingyan Wang <jingywa@OrtTrainingDev3.af05slrtruoetgaxwwjv5nsq5e.px.internal.cloudapp.net>
2021-06-28 14:44:33 -07:00
Yulong Wang
25b2aa6d04
[doc] update a part of the documents for ORT JavaScript (#7935)
* update api-basics.md

* update install.md

* add placeholder for "build for web"

* update js api

* add more sections in js-api.md

* update "coming soon" for how-to-build-web

* Update "Web" -> "web" in title of web.md

* Update install.md
2021-06-08 10:47:27 -07: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
Maajid khan
8c34414a97
[OpenVINO-EP] Update OpenVINO-EP documentation (#7860)
* [OpenVINO-EP] Update the Docx

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Added Relative paths for openvino-ep docx

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Modified the samples code path to new location

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-05-27 14:13:15 -07:00
Maajid khan
4251916500
[OpenVINO-EP] Added Documentation for OpenVINO-EP samples (#7827)
* Added documentation for OpenVINO-EP samples

->Add Tutorials of how to use the samples.
-> Updated the OpenVINO EP docx page to point
to these tutorials.

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Minor changes added in the documentation

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* Modified the document

cleaned up the document

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>

* c# documentation modified

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-05-26 19:15:45 -07:00
Faith Xu
0f6f0d9bbb
Major updates/restructure for documentation (#7609)
* Update documentation.

Updates documentation.

* Update tf-get-started.md
2021-05-10 15:19:37 -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