Commit graph

79 commits

Author SHA1 Message Date
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
Edward Chen
c04a61beca
Update Objective-C pod installation instructions to point to pre-release version. (#7940) 2021-06-03 20:39:14 -07:00
Changming Sun
0516a2d348
Update inferencing.md (#7928) 2021-06-03 13:00:43 -07:00
Guoyu Wang
5ff27d5de5
Some ort mobile doc update (#7927)
* update mobile doc

* minor update

* minor update

* minor update

* minor update

* add maven cental link
2021-06-03 12:55:47 -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
Olivia Jain
40becfa479
make relative links (#7884) 2021-05-28 15:22:47 -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
stevenlix
34ce1ef8d0
Update TensorRT documentation (#7766)
* Update TensorRT-ExecutionProvider.md

* Update eps.md

* Update TensorRT-ExecutionProvider.md

* Update TensorRT-ExecutionProvider.md

* Update TensorRT-ExecutionProvider.md

* Update TensorRT-ExecutionProvider.md

* Update eps.md
2021-05-20 15:27:14 -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
George Wu
8e88d20268
fix dnnl build instruction typo (#7325) 2021-04-13 11:40:26 -07:00
Ben Niu
fdad88464b
minor update (#7304) 2021-04-09 15:46:48 -07:00
Faith Xu
f1076c011c
Update to website installation picker (#7263)
* install picker updates

* updates for training tab

* DML combo fixes

* fix android selections

* updated android and coreml options

* picker behavior updates

* Training selector updates
2021-04-06 17:15:17 -07:00
George Wu
300895039b
fix broken notebook link (#7209) 2021-04-02 08:44:35 -07:00
sfatimar
841df1a189
Open vino ep/gh pages (#7181)
* Added docx for save/load blob feature

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

* Update build.md

Updated build.md for openvino instructions

* Update OpenVINO-Execution Provider.md

* Minor changes added

Co-authored-by: MaajidKhan <n.maajidkhan@gmail.com>
2021-04-01 13:51:25 -07:00
Hariharan Seshadri
35eb8e70ee
Update doc to indicate how a CUDA custom op is synchronized with respect to ORT's CUDA kernels (#6981)
* Update docs

* Formatting

* Formatting

* update
2021-03-11 18:43:44 -08:00
Faith Xu
e2d75e54b0
Website and docs updates for 1.7 (#6718)
* update version #s

* Update CUDA versions

* Fix table

* Fix typo

* table update

* update link

* Add search bar

* Update for Windows ARM packages

* Add quantization.md

* Remove page

* Re-add quantization page
2021-03-01 10:53:13 -08:00
Nat Kershaw (MSFT)
8d78f59c8a
Fix Java doc markdown formatting (#6669) 2021-02-19 10:55:27 -08:00
Nat Kershaw (MSFT)
2cdfcf85f2
Update build.md with recent changes (#6708) 2021-02-17 13:34:10 -08:00
Guoyu Wang
19b08e3746
Update NNAPI EP document (#6711)
* update nnapi doc

* minor update
2021-02-16 15:31:25 -08:00
Nat Kershaw (MSFT)
59e485d4f0
Add link to Python API (#6647) 2021-02-11 13:46:50 -08:00
Dwayne Robinson
9b0945edf1
Update DirectML-ExecutionProvider.md (#6627)
Update dml version 1.4.0 to 1.4.1.
2021-02-09 15:45:56 -08:00