Commit graph

53 commits

Author SHA1 Message Date
PeixuanZuo
97b1115a59
[ROCm] Update doc for ROCm 5.4 (#14494)
### Description
1. Delete preview label for ROCm/MIGraphX and update ROCm/MIGraphX
supported architecture. https://peixuanzuo.github.io/onnxruntime/
2. Update rocm training guide to ROCm5.4.
https://peixuanzuo.github.io/onnxruntime/docs/build/training.html#gpu--rocm
2023-01-31 17:28:11 -08:00
Ted Themistokleous
5601b10644
Update information for ROCm 5.4 for MIGraphX and ROCm Builds (#13813)
-Add MIGraphX-EP page for install/example
-Update version info for ROCm version for both MIGraphx and ROCm EPs to
5.4 -Update hooks to the latest ROCm Pytorch supported (1.12.1 -> 1.13)
-Remove (Preview) from MIGraphx and ROCm EP notes
-Update ROCm & MIGraphX EP.md files with ROCm version and pytorch links

### Description
<!-- Describe your changes. -->
Update documentation about ROCm and MIGraphx with newest ROCm 5.4 stack


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

Update things for whats able to be supported.

Co-authored-by: Ted Themistokleous <tthemist@amd.com>
2023-01-26 12:18:48 -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
Rachel Guo
78e22e851f
[doc] Add proguard rules for R8 minimized Android build (#14407) 2023-01-24 10:05:29 -08:00
RandySheriffH
1391f81c3f
Document Affinity & CloudEP (#14137) 2023-01-23 11:24:33 -08:00
JiCheng
88928251eb
[Xnnpack] update doc (#13624)
### Description
- iOS support
- MatMul && GEMM
- Resize
- ConvTranspose


A deployment [link](https://wejoncy.github.io/onnxruntime/) for
showcase.
### 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-19 19:14:48 -08:00
Yulong Wang
4a9e20aa30
[doc] update Prerequisites in "Build for Web" (#14357) 2023-01-19 10:40:23 -08:00
EunHo Lee
65dbfe1907
Fix documentation typos (#14084) 2023-01-06 13:11:23 -08:00
FFFrog
b521f49c43
[CANN] Update the doc of CANN EP (#13875)
#### Description
This PR update docs of Ascend CANN excution provider.

#### Changes
1. Add some new ops.
[https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#supported-ops](https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#supported-ops)
2. Add detailed option description.
[https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#configuration-options](https://fffrog.github.io/docs/execution-providers/community-maintained/CANN-ExecutionProvider.html#configuration-options)
3. Fix the link problem caused by document structure adjustment.
2022-12-14 10:11:56 -08:00
Faith Xu
d4497b9ecd
[Docs] Update EP ordering (#13564)
### Description
- Update EP ordering and distinguish between MS-maintained and
community-maintained EPs
- Update CUDA version table for v1.13
- Staged preview:
https://faxu.github.io/onnxruntime/docs/execution-providers/
2022-11-07 10:02:01 -08:00
FFrog
7fd9523934
add doc about CANN EP (#13239)
#### Description
This PR adds docs of Ascend CANN excution provider.

#### Changes

- Preview Github page:
[https://fffrog.github.io/](https://fffrog.github.io/)

- Add onnxruntime build with CANN:
[https://fffrog.github.io/docs/build/eps.html#cann](https://fffrog.github.io/docs/build/eps.html#cann)

- Add CANN ExecutionProvider Page:
[https://fffrog.github.io/docs/execution-providers/CANN-ExecutionProvider.html](https://fffrog.github.io/docs/execution-providers/CANN-ExecutionProvider.html)
2022-10-18 10:18:09 -07:00
Changming Sun
3e1808dc59
Update ORT inference build instructions (#13326) 2022-10-17 09:42:34 -07:00
Cheng
a01de6db92
[xnnpack] Add EP Doc (#13021)
**Description**: Describe your changes.

Xnnpack EP

Preview:
https://wejoncy.github.io/onnxruntime/

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

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2022-10-07 15:08:22 -07:00
sfatimar
9341c87957
Update docx ov ep v4.2 release (#13222)
Description
[OpenVINO-EP] Documentation update for v4.2 Release with OpenVINO 2022.2
version

Motivation and Context
The code PR is already merged:

https://github.com/microsoft/onnxruntime/pull/13023
https://github.com/microsoft/onnxruntime/pull/13069
Openvino GPU Unit/Python Tests fix failure  #13122

Co-authored-by: mayavijx <mayax.vijayan@intel.com>
2022-10-07 08:55:34 -07:00
PeixuanZuo
ce1bc9b49c
[Add] add Rocm ep doc (#12971)
**Description**: Describe your changes.
add rocm ep doc.
Perview Github page : https://ytaous.github.io/onnxruntime/

Added items
Home page
- [ ] Update matrix on home page: https://ytaous.github.io/onnxruntime/
- [ ] Link "Installation Instruction Follow build instructions from
here" to onnxruntime build with ROCm(inference) page.(This link now
point to preview page, will change later)

Installation
- [ ] Update installation page:
https://ytaous.github.io/onnxruntime/docs/install/#training-install-table-for-all-languages

Build onnxruntime
- [ ] Add onnxruntime build with ROCm(inference):
https://ytaous.github.io/onnxruntime/docs/build/eps.html#amd-rocm
- [ ] Update onnxruntime build with ROCm(training):
https://ytaous.github.io/onnxruntime/docs/build/training.html#gpu--rocm

ExecutionProvider
- [ ] Add ROCm ExecutionProvider navitagation:
https://ytaous.github.io/onnxruntime/docs/execution-providers/
- [ ] Add ROCm-ExecutionProvider page:
https://ytaous.github.io/onnxruntime/docs/execution-providers/ROCm-ExecutionProvider.html

Performance
- [ ] Add enable_rocm_profiling introcduction:
https://ytaous.github.io/onnxruntime/docs/performance/tune-performance.html#profiling-and-performance-report
- [ ] Add graph-optimation for ROCm ep:
https://ytaous.github.io/onnxruntime/docs/performance/graph-optimizations.html#extended-graph-optimizations

Co-authored-by: Ethan Tao <ettao@microsoft.com@orttrainingdev7.d32nl1ml4oruzj4qz3bqlggovf.px.internal.cloudapp.net>
Co-authored-by: ytaous <4484531+ytaous@users.noreply.github.com>
2022-09-20 12:04:20 -07:00
shalvamist
a453835a9b
update for ORT Web build guide (#12247)
* update for ORT Web guide

I reordered a few things and added some more context.
I think we can also add more information on converting ONNX to ORT format fairly easily. maybe in the doc update next iteration :)

* Doc update - Following the github discussion

* Update web.md

Updated the doc - fixed the title hierarchy
Added a small comment regarding the final build products.

* Update web.md

Updated the titles "Build ONNX Runtime for web assembly" --> "Build ONNX Runtime web assembly artifacts"
Updated the "build NPM package" doc section - clarified the different sections of the build process

* Update web.md

Fixed a broken link

* Update web.md

Adding a section to clarify there is one last step for finalizing the build process
2022-09-06 16:32:53 -07:00
yf711
746130073b
Add instruction of new build option to link TensorRT builtin parser (#12615)
* Add instruction of new build option to link TensorRT builtin parser

* Add instruction of new build option to link TensorRT builtin parser
2022-08-17 08:26:17 -07:00
Faith Xu
552b70f82a
[Website] Add ORT at MS page and doc fixes (#12518)
* add ort at microsoft page

* remove openmp references

* update EP table

* update ort-at-microsoft page

* fix link

* Change ORT to ONNX Runtime

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

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2022-08-10 10:08:58 -07:00
Hector Li
0400c69be1
fix typo in doc (#12471)
fix typo build_was_static_lib -> build_wasm_static_lib
2022-08-04 13:41:45 -07:00
chethanpk
678106ad9f
Updated OneDNN build documentation (#12446)
Modified OneDNN documentation to include build instructions for using open-source OpenCL-SDK

Signed-off by: chethan.palangotu.keshava@intel.com
2022-08-03 12:53:14 -07:00
Edward Chen
3535b56700
Add links to custom Android/iOS package instructions to increase discoverability. (#12431) 2022-08-02 19:35:06 -07:00
Faith Xu
f39fbbf6f7
[Website/Docs] Add quote and reorganize docs navigation (#12355) 2022-07-29 12:44:36 -07:00
Mohamed A. Abdellaoui
4471569ab3
Update inferencing.md (#12237)
Fix wrong version number for downloading cmake.
2022-07-29 12:40:58 -07:00
LauSto
ebf1ed8c74
Update inferencing.md (#12198) (#12242)
Changed referenced protobuf version from 3.11.2 to 3.18.1

Co-authored-by: Nat Kershaw (MSFT) <nakersha@microsoft.com>
2022-07-27 15:50:16 -07:00
Nat Kershaw (MSFT)
fa1af609ee
Correct version of protoc for Linux ARM build (#12241) 2022-07-19 13:52:44 -07:00
Rachel Guo
782c90d6d4
[doc] Add link to android testing in Build for android doc (#11766) 2022-06-08 15:01:55 -07:00
Nat Kershaw (MSFT)
e25d51170c
Add version to gradle install (#11754) 2022-06-07 10:40:21 -07:00
shalvamist
4df8d60e72
Added Ninja prerequisite (#11632) 2022-06-06 13:27:42 -07:00
George Wu
70a3468850
initial docs for SNPE EP (#11705)
* SNPE EP docs

* minor corrections

* fixes

* c++

* remove

* Update docs/execution-providers/SNPE-ExecutionProvider.md

Co-authored-by: manashgoswami <magoswam@microsoft.com>

* review comments

Co-authored-by: manashgoswami <magoswam@microsoft.com>
2022-06-03 14:19:57 -07:00
sfatimar
b51e301eaa
Gh pages uep 4.1 2022.1 (#11649)
* Update OpenVINO-ExecutionProvider.md

Updated to support Python Packages on PyPi.org

* Update eps.md

Updated OpenVINO

* Update eps.md
2022-05-31 08:15:19 -07:00
sfatimar
370c4c5672
Ov ep docx update 22.2 (#11296)
* Update eps.md

* Update OpenVINOExecutionProvider.md

* Update OpenVINOExecutionProvider.md
2022-04-27 09:49:44 -07:00
Yulong Wang
7b36e8d4ed
[docs/web] update build instructions for web (#11307) 2022-04-24 17:59:31 -07:00
Edward Chen
09c18f988f
[docs] Add documentation about Android custom build (#11207)
* Add documentation for creating and using custom Android package.

* Update.

* Add to package usage instructions.

* Address PR comments.
2022-04-19 19:08:23 -07:00
Edward Chen
40dcaabe4c
[docs] Update mobile performance tuning docs for 1.11 (#11149)
* custom.md - use release tags

* Rename mobile performance tuning doc.

* Move old mobile performance tuning docs.

* remove title

* Adapt original documentation and add more for 1.11.

* Adjust doc ordering.

* Update version text.

* Update nav, fix links.

* rework docs
2022-04-11 13:44:36 -07:00
Maajid khan
173f7f623c
OpenVINO-EP v4.0 Release documentation update (#11125)
* Update docx w.r.t v4.0 Release

updates documentation w.r.t OV-EP
v4.0 Release with OpenVINO 2022.1
version.

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

* Added new announcements

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

* Fixed typos

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

* Add Release page link

Signed-off-by: MaajidKhan <n.maajidkhan@gmail.com>
2022-04-08 09:53:49 -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
Sunghoon
03a2234a65
add how to build webassembly static library (#10979) 2022-04-05 15:04:12 -07:00
George Wu
d699805e24
update TensorRT EP docs for ORT 1.11 (#11055) 2022-03-30 14:07:06 -07:00
Edward Chen
b89d01bcdc
Updated documentation for reduced op build process. (#10152) 2022-01-04 09:33:52 -08:00
Nat Kershaw (MSFT)
f696d17906
Add STVM to website installation matrix (#10064) 2021-12-16 16:35:08 -08:00
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -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
Nat Kershaw (MSFT)
91e029d4f3
SEO audit of docs website (#9780) 2021-11-18 11:00:48 -08:00
Maajid khan
da6f161717
[OpenVINO EP] v3.3 Release Documentation update (#9589) 2021-11-17 12:39:06 -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
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
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
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
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