Commit graph

200 commits

Author SHA1 Message Date
Sunghoon
03a2234a65
add how to build webassembly static library (#10979) 2022-04-05 15:04:12 -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
Vincent Wang
59df74e0a9
[Doc] Provider Option cudnn_conv1d_pad_to_nc1d (#11040)
* doc for cudnn_conv1d_pad_to_nc1d

* update doc
2022-04-04 08:20:23 -07:00
George Wu
d699805e24
update TensorRT EP docs for ORT 1.11 (#11055) 2022-03-30 14:07:06 -07:00
Dwayne Robinson
dad658f53c
Warn user that GPU 0 is not necessarily performant (#11044) 2022-03-30 10:32:43 -07:00
Hariharan Seshadri
d87f5eeeab
Fix formatting of tune performance page (#11014)
* Fix formtatting

* Update

* Modify python comment style

* More changes

* Fix OpenVINO links
2022-03-28 13:32:50 -07:00
Olivia Jain
870655ca28
Update Broken OpenVINO Links (#11009) 2022-03-28 10:17:44 -07:00
Hariharan Seshadri
8573fd4c60
Document the usage of the CUDA Graphs feature (#10859) 2022-03-24 10:50:56 -07:00
Nat Kershaw (MSFT)
b9b9c10977
Fix links in the OpenVINO EP docs (#10903) 2022-03-17 15:20:33 -07:00
Nat Kershaw (MSFT)
8b9c23aac9
Fix formatting issues in the perf tuning doc (#10867) 2022-03-16 12:52:00 -07:00
github-actions[bot]
2f3220218f
Update Python API docs to commit 860f282 (#10881)
Co-authored-by: natke <natke@users.noreply.github.com>
2022-03-15 18:13:11 -07:00
Scott McKay
0112d97721
Fix link for FasterRCNN C# tutorial (#10857) 2022-03-15 16:29:49 -07:00
Valery Chernov
c25eb6125c
update TVM EP docs (#10562) 2022-03-15 15:13:20 -07:00
Dwayne Robinson
37935a7852
DirectML EP doc - clarify opset support and fix version (#10519) 2022-03-03 15:40:37 -08:00
RandySheriffH
0236984d6a
Document dynamic cost model and perf view (#10734)
* Explain the usage of dynamic cost model

* add tool usage

* fix a few grammar

* refactor

* refactor

* refactor

* fixing comments

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2022-03-02 16:02:16 -08:00
Nat Kershaw (MSFT)
19e1933e92
Clarify Python package install instructions (#10718) 2022-03-01 20:30:23 -08:00
Nat Kershaw (MSFT)
38b55f2345
Update with-python.md (#10647) 2022-02-23 13:16:05 -08:00
TomWildenhain-Microsoft
9543e176bf
Add float16 docs (#8822) 2022-01-13 17:35:26 -08:00
brev
30c1a3b2fe
Add link to YouTube Channel, Add link to C# GitHub Template (#9900)
* add link to youtube channel

* add youtube section to index

* fix table format

* add csharp template link

* fix title

* shorten js template button title

* shorten c# title

* change intro video and update link

* update video to faiths video

* move youtube link

* add youtube link

* move youtube link up on nav
2022-01-10 17:38:02 -06:00
Hariharan Seshadri
d66b856fb5
Small addendum to #10216 (#10225)
Accidentally left out a header
2022-01-07 20:24:47 -08:00
Hariharan Seshadri
2a8cf1507c
[Doc] Misc CUDA EP doc changes (#10216) 2022-01-07 17:54:43 -08:00
github-actions[bot]
1980138236
Update C/C++ API docs to commit d52d3c0 (#10222)
Co-authored-by: natke <natke@users.noreply.github.com>
2022-01-07 16:25:57 -08:00
manashgoswami
7f0b170fd9
Rename STVM to TVM ep (#10190) 2022-01-05 14:06:35 -08:00
Nat Kershaw (MSFT)
70f6c08d1f
Make links to API docs relevant; then staging works (#10185) 2022-01-04 12:34:52 -08:00
Edward Chen
b89d01bcdc
Updated documentation for reduced op build process. (#10152) 2022-01-04 09:33:52 -08:00
github-actions[bot]
8bde251409
Update Python API docs to commit 9765949 (#10181)
Co-authored-by: natke <natke@users.noreply.github.com>
2022-01-04 09:32:40 -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
Nat Kershaw (MSFT)
f696d17906
Add STVM to website installation matrix (#10064) 2021-12-16 16:35:08 -08:00
Valery Chernov
8b3615f5ed
[DOC] add STVM EP docs (#10059) 2021-12-16 14:59:44 -08:00
Nat Kershaw (MSFT)
a04ed78989
Move community APIs a level up in visibility (#9952) 2021-12-13 12:21:25 -08:00
Nat Kershaw (MSFT)
45062f56b3
Fixed broken link in iOS mobile tutorial (#10011) 2021-12-10 17:56:20 -08:00
Gary Miguel
41a714bbb3
Lots of minor doc improvements (#9930) 2021-12-10 17:43:15 -08:00
jingyanwangms
2f3511540c
update objective c doc for 1.10 release (#9958) 2021-12-10 17:37:56 -08:00
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -08:00
leqiao-1
a1905624bc
change OLive description and related links (#9951)
* change OLive description and related links

* modify OLive description
2021-12-09 18:04:46 -08:00
Dmitri Smirnov
50127feab2
Document on the usage of mimalloc allocator (#9974)
[Enable proper mimalloc override](https://github.com/microsoft/onnxruntime/pull/9944) PR has fixed a number of issues with regards to building onnxruntime with mimalloc. This PR documents usage of mimalloc.
2021-12-08 12:25:04 -08:00
Hariharan Seshadri
70bd575cdd
Remove redundant doc lines (#9946) 2021-12-06 22:47:53 -08:00
George Wu
fe3e672400
updates to CUDA and TensorRT EP documentation (#9932)
* updates to TRT, CUDA documentation

* update trt options python example.
2021-12-03 21:48:12 -08:00
Hariharan Seshadri
24dcd7334b
Initial commit (#9933) 2021-12-03 18:52:25 -08:00
Hariharan Seshadri
a0f76fe1a8
[Doc] Performance tuning of convolution heavy models with the CUDA EP (#9916)
* Initial commit

* More changes
2021-12-03 12:29:42 -08:00
RandySheriffH
30eba55992
Explain usage of --enable_cuda_profiling (#9882)
* explain usage of --enable_cuda_profiling

* remove cupti dependency
2021-11-29 21:46:42 -08:00
RandySheriffH
4bd7c2adf1
Document a few features for rel 1.10 (#9836)
* document threading hooks

* move doc to a separate section

* document cuda profiler numbers

* move doc

* specify cupti dependency

* add example inplace

* format code

* format code

* link to cxx api

* minor fix on grammar

* add new line

* minor fix on grammar

* minor fix on grammar

* minor fix on grammar

Co-authored-by: Randy Shuai <rashuai@microsoft.com>
2021-11-24 13:10:20 -08:00
Maajid khan
85b00dfda3
Updated OpenVINO EP docx w.r.t v3.4 Release (#9858)
Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-11-24 09:51:20 -08:00
brev
2465a747c3
fix ort github link (#9832) 2021-11-22 09:23:20 -06: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
Prasanth Pulavarthi
a5c0ba8cf3
Add links to community maintained Julia bindings (#9773)
* Add links to community maintained Julia bindings

* Add community API links to Getting Started page
2021-11-17 16:35:49 -08:00
Maajid khan
da6f161717
[OpenVINO EP] v3.3 Release Documentation update (#9589) 2021-11-17 12:39:06 -08:00
Nat Kershaw (MSFT)
6e7c43767e
Add general redirect capability and test case (#9750) 2021-11-16 13:33:41 -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
Faith Xu
3b81325d6a
Update for latest versions (#9499) 2021-11-10 15:40:49 -08:00
Dwayne Robinson
471f719bb0
Fix doc listed opset for DirectML EP (#7118)
* Update DirectML-ExecutionProvider.md

Update stale version and opset for current ORT.

* Update install markdown link to DML

* Fix filename extension to html
2021-11-04 08:20:12 -07:00
Yi-Hong Lyu
bbb13fdbc5
Fix link to enum GraphOptimizationLevel (#9390) 2021-10-29 14:30:35 -07: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
Maajid khan
69e077eb61
[OpenVINO-EP] V3.2 Release Documentation update (#9233)
* Updated docx for OpenVINO EP V3.2 Release

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

* Added Docx for blogs/Tutorials for OV-EP

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

* Added docx for Yolov4 Python sample

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

* updated the graph partitioning docx

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

* Added sample example for external_data feature

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-10-12 18:03:16 -07:00
Yulong Wang
74e44220e3
[doc] update documents for JavaScript API (#9173)
* install

* update comments in install cmd

* update get-started-with-javascript

* add .no_toc

* correct .no_toc
2021-10-11 13:59:04 -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
stevenlix
9fa90d762b
Fix issues in execution provider docs (#9201)
* fix syntax issue

* update tensorrt version
2021-09-27 13:42:20 -07:00
Yulong Wang
5f7a25509c
[doc] update document for JavaScript API reference (#9080)
* add js api reference doc

* add landing page

* trivial revise

* update documents
2021-09-20 20:57:54 -05:00
Yufeng Li
54c667740f
Update links of quantization examples (#9109)
* Update links of quantization examples

* fix typo
2021-09-20 16:47:21 -05:00
Yulong Wang
2ca9d6adff
[doc] update document for how-to-build onnxruntime web (#9043)
* update document for how-to-build onnxruntime web

* update minimal build section
2021-09-20 11:42:53 -05:00
stevenlix
e01d4c1d27
Update TensorRT doc (#9112)
* Update TensorRT-ExecutionProvider.md

* Update eps.md

* Update TensorRT-ExecutionProvider.md
2021-09-20 07:56:41 -07:00
Maajid khan
6e4f49eca8
[OpenVINO-EP] Documentation update UEP v3.1 Release (#9084)
* Update OpenVINO-ExecutionProvider.md

Updated information on 1.9

* Updated UEP documentation to the latest

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

* Corrected the c# section links

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

Co-authored-by: sfatimar <sahar.fatima@intel.com>
2021-09-20 07:56:09 -07:00
Chi Lo
603ea0e2cf
Fix merge conflicts (#9104) 2021-09-17 14:01:15 -07:00
Cassie
b65ccc57a7
Added some js redirects in the 404 page to account for some missing links in the site reorg (#9085)
* 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

* add js redirects to 404 page to help broken links

* add full url in replace logic for testing

* remove catchall and full url replace

* add redirect.json and update js to read from json

* update comment

* add test redirect likes for statged sites

* fix load json

* fix load json

* break loop at redirect

* import json

* json fixes

* fix imports on 404

* fix test url

* oops

* derp

* set delay to 0
2021-09-17 10:11:46 -07:00
Ryan Hill
87bac13f7f
Initial C API documentation push (#9089) 2021-09-16 17:09:25 -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
Pranav Sharma
6383a76d82
Add IOBinding doc (#8786) 2021-08-23 15:36:15 -07:00
Faith Xu
4ba6b3ed97
Update CUDA-ExecutionProvider.md (#8778) 2021-08-18 16:54:08 -07:00
George Wu
2c879e547d
update trt build instructions (#8758) 2021-08-17 20:37:18 -07:00
Sergii Dymchenko
3139459fa8
Fix 2 install commands rendering as 1 line (#8733) 2021-08-17 12:43:54 -07:00
Saurabh Tangri
9da930afe1
Update eps.md (#8751)
Updated build instructions for OneDNN EP
2021-08-16 14:50:39 -07:00
Edward Chen
fb2e30a76c
[ArmNN][Doc]Use meaningful variable name (#8629)
Ported from this PR: https://github.com/microsoft/onnxruntime/pull/6122
2021-08-12 09:59:32 -07:00
RajalakshmiSR
66fa85a7e0
Add ppc64le support (#8409)
This patch adds POWER in the supported architecture list in the user manual.

Co-authored-by: Rajalakshmi Srinivasaraghavan <rajis@linux.ibm.com>
2021-08-11 09:48:33 -07:00
Faith Xu
d8bb0da9f9
Documentation: fix link, nav, minor update (#8612)
* fix links

* update order of api nav

* update execution provider how to, original PR #6266
2021-08-09 20:31:51 -07:00
Matthew Nelson - Silverark
59f6271da1
cuda_mem_limit has been renamed to gpu_mem_limit (#8284)
`cuda_mem_limit` was renamed to `gpu_mem_limit` in nighlty build `nightly-1.7.0.dev202104231`.

https://github.com/microsoft/onnxruntime/issues/7457
2021-08-05 14:15:03 -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
05a4d5b785
Fix link (#8539) 2021-07-29 17:03:16 -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
Edward Chen
223f236136
[Objective-C API] Add API reference documentation (#8000)
* Add Objective-C API reference website files.

* Update Objective-C API doc.

* Update Objective-C API page.

* regenerate objc api docs

* Update sample link.

* Update Objective-C API reference to 1.8.0-preview version.

* Remove file with absolute paths.

* Add Swift bridging header info.

* Update Objective-C API reference for 1.8.1.

* Update references to Objective-C package.

* Say iOS package is in preview. Clean up.
2021-07-21 14:25:04 -07:00
Faith Xu
ae0d2ac1ac
Update EP table (#8416) 2021-07-20 14:03:35 -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
Ye Wang
4a73d36bab
fix nightly build pkg link (#8400)
* fix nightly build pkg link

* review comments
2021-07-15 12:30:19 -07:00
Justin Ormont
efeca76cec
Update quantization.md (#8351)
Spelling fix
2021-07-14 15:41:09 -07:00
Faith Xu
fce58d9e26
Website: change default to pytorch 1.9 for training (#8337)
* fix training pkg urls

* Update torch-ort instructions

* Remove nightly from Get Started matrix

* Add steps for training installation

* Add torch-ort configure step for training installation

* Add text for ROCm packages

* Refine text for ROCm packages

* Add ROCm preview packages

* Revert ROCm instructions

Co-authored-by: Nat Kershaw <nakersha@microsoft.com>
2021-07-09 13:36:50 -07:00
Faith Xu
c8cf485425
[Website] updated pkg links for 1.8.1 (#8326)
* updated pkg links

* fix urls
2021-07-07 18:39:12 -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
Yufeng Li
6a5b698d33
refine the quantization doc (#8057)
* refine the quantization doc

* fix vpmaddubsw info

* resolve comments

* add qdq info

* remove sub items

* no toc

* refine the structure

* toc change

* typo
2021-06-17 18:09:35 -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
Hariharan Seshadri
68b1ba0e24
Some consolidated doc updates for ORT 1.8 (#7750)
* Add documentation

* Refine 1

* Refine 2

* PR comments

* update
2021-06-07 12:04:11 -07:00
Faith Xu
1bb4f6f8c9
Docs: Add new package links (#7938)
* update with new packages

* add objc package to matrix

* table fix
2021-06-07 08:35:28 -07:00