Commit graph

488 commits

Author SHA1 Message Date
Nat Kershaw (MSFT)
2b75c9bf54
Minor updates to Java docs (#21269) 2024-07-11 12:32:10 -07:00
Maanav Dalal
8c073f9b5f
Added requested install instructions to ORT ROCm Python. (#21124)
To close: #21036
2024-07-08 13:27:13 -07:00
oswin
c987d34d84
Java API Docs for Generate API (#21125) 2024-07-05 16:25:18 -07:00
Nat Kershaw (MSFT)
12fbefeca6
Fix typo in genai build DML from source steps (#21268) 2024-07-05 16:24:17 -07:00
Nat Kershaw (MSFT)
315581a90f
Update install docs and add troubleshooting page (#21210) 2024-07-01 15:48:41 -07:00
Sophie Schoenmeyer
8fc4470238
Fix typo in Python code block on home page (#21196)
### Description
Python code block on home page contained typo

Previous: outputs = session.run(None {"input": inputTensor})
Correction: outputs = session.run(None, {"input": inputTensor})

Fixes issue #21146



### 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. -->
2024-06-27 13:54:26 -07:00
Maanav Dalal
77df36bde1
NimbleEdge and ONNXRuntime Blog June 17 (#21040)
DRAFT PR until images and thumbnail are provided

---------

Co-authored-by: Scott McKay <Scott.McKay@microsoft.com>
Co-authored-by: Emma Ning <43255631+EmmaNingMS@users.noreply.github.com>
2024-06-17 10:39:01 -07:00
Tianlei Wu
736ed7aeb7
[Doc] Fix links in Device Tensor Doc (#21039) 2024-06-13 15:25:44 -07:00
Nat Kershaw (MSFT)
0686549d27
Clarify docs for get_output() (#21009) 2024-06-12 17:49:33 -07:00
Sophie Schoenmeyer
a15f42da56
Update releases-servicing.md to correct version (#21025)
### Description
<!-- Describe your changes. -->



### 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. -->
2024-06-12 17:48:36 -07:00
Maximilian Müller
f20db76f54
Add device tensor documentation for GPU execution providers (#20837)
This documentation adds documentation on:
- how to allocate CUDA device tensors from C++ and python
- how to use DML device tensors from C++ and python
- it also shows how to leverage existing GPU allocations in ORT 
- how to overlap PCI copies and GPU execution using CUDA streams
- how to overlap PCI copies and GPU execution using D3D12 Command Lists
and custom resources
---------

Co-authored-by: Tianlei Wu <tlwu@microsoft.com>
2024-06-12 09:11:25 -07:00
Baiju Meswani
b5118f34e0
Fix documentation of temperature (#20960) 2024-06-06 14:53:25 -07:00
Sophie Schoenmeyer
95de52d89e
Update acpt.md to fix docs sidebar (#20927)
ACPT docs should be nested inside Ecosystem category in the docs
sidebar, but they currently show up outside of the category at the top
of the sidebar.

Need to add parent to address this issue.

### Description
<!-- Describe your changes. -->



### 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. -->
2024-06-04 17:18:47 -07:00
Nat Kershaw (MSFT)
de4d524c14
Fix model links (#20909) 2024-06-03 16:29:44 -07:00
Maximilian Müller
7d89749e0c
[TensorRT Docs] Extending engine embedding docs (#20848)
Adding to the docs a link on how to embed an externally compiled engine
and also mention that in case of an embedded engine the builder resource
is not needed.
2024-06-03 13:31:13 -07:00
Nat Kershaw (MSFT)
f61a7092a0
Add phi3 v tutorial (#20873) 2024-05-30 17:48:26 -07:00
Nat Kershaw (MSFT)
c6094a2e44
Update build from source instructions (#20819)
Staged here:
https://natke.github.io/onnxruntime/docs/genai/howto/build-from-source.html
2024-05-30 12:05:21 -07:00
Sophie Schoenmeyer
65c3801803
Add ACPT docs to ORT docs (#20839)
### Description
Add an ACPT landing page to the ORT docs to publish supported
configurations + most recent releases



### 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. -->
2024-05-30 11:51:34 -07:00
Yifan Li
73df4e5337
[TensorRT EP] Update doc (#20857)
### Description
<!-- Describe your changes. -->
* Reorganize table and group items by scenarios
* Add `trt_engine_hw_compatible` doc
* Update jetson instruction with TensorRT 10 info

### UI comparison
After:
https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations
Before:
https://onnxruntime.ai/docs/execution-providers/TensorRT-ExecutionProvider.html#configurations
2024-05-29 21:51:35 -07:00
Sophie Schoenmeyer
aa6097ad5b
Fix broken links (#20831)
### Description
Fix broken links referenced in issue #20790 

Llama2 blog link was updated to the correct location and ResNet sample
was removed entirely because it no longer exists anywhere in the AML
docs

### 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. -->
2024-05-28 13:27:09 -07:00
Chi Lo
e3e4f215f1
[TensorRT EP] TRT EP cache docs (#20785)
Add a section for how to use three major TRT EP caches: TRT timing
cache, TRT engine cache and Embedded engine model /EPContext model.
Some materials are from my GTC slides.
2024-05-24 18:53:59 -07:00
Jian Chen
51caf9851e
Update CUDA-ExecutionProvider.md (#20795)
update cudnn to 8.9.2.26 (Linux)<br/>8.9.2.26 (Windows)

### Description
<!-- Describe your changes. -->



### 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. -->
2024-05-23 14:23:56 -07:00
Ulrich Bönkemeyer
4b919fe2ac
Fix DirectML package name in genai/howto/install.md (#20771)
### Description
Fix package name 
from ```dotnet add package Microsoft.ML.OnnxRuntimeGenAI.*Cuda*
--prerelease``` to ```dotnet add package
Microsoft.ML.OnnxRuntimeGenAI.DirectML --prerelease``` in DirectML
section.

### Motivation and Context
Clearly confusing for beginners if not fixed (will break further processes)
2024-05-23 13:16:04 -07:00
Jian Chen
08cae80a6b
Update CUDA-ExecutionProvider.md (#20767) 2024-05-22 10:15:19 -07:00
Sophie Schoenmeyer
7c820c45b1
Docs updates for ORT 1.18 (#20610)
### Description
Update compatibility/version info for ORT 1.18 release



### 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. -->
2024-05-21 17:27:56 -07:00
Yulong Wang
67ba2e5032
[doc] update docs for ORT web v1.19 (#20756)
### Description
<!-- Describe your changes. -->



### 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. -->
2024-05-21 16:26:10 -07:00
Nat Kershaw (MSFT)
58434d6ab2
Add Phi-3 medium (#20746) 2024-05-21 08:46:59 -07:00
Wanming Lin
944db3ed6c
[WebNN EP] Add WebNN doc (#20733)
- Add WebNN EP build instruction
- Update WebNN Chromium flag in tutorial
- Some minor updates
2024-05-21 00:17:31 -07:00
Nat Kershaw (MSFT)
35cd15e6a9
Generate() API updates (#20739)
Staged here: https://natke.github.io/onnxruntime/docs/genai/
2024-05-20 21:12:19 -07:00
sfatimar
3909f23ee6
Ort openvino npu 1.18.0 doc (#20707)
### Description
-These changes reflect the latest changes we have made to enable NPU
-Export OpenVINO Blob to ONNX Operator
-Enable QDQ Optimizations Passes
- Separate Device/Precision



### Motivation and Context
These changes reflect the latest changes we have made to enable NPU. 
These changes reflect the latest changes we have made to enable rel-1.18
- If it fixes an open issue, please link to the issue here. -->

---------

Co-authored-by: Preetha Veeramalai <preetha.veeramalai@intel.com>
2024-05-19 23:10:24 -07:00
George Wu
ca6b0f8cb2
[QNN EP] update docs (#20705)
update docs with for version 1.18.0
2024-05-17 11:19:41 -07:00
Hector Li
564d725031
Add error handling session in QNN doc (#20579)
Add error handling session in QNN doc
2024-05-07 10:44:00 -07:00
Yifan Li
f131eb9993
[TensorRT EP] Update doc to TRT10 (#20580)
### Description
<!-- Describe your changes. -->
* Update TRT version to 10.0


### 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. -->
2024-05-07 10:05:46 -07:00
Baiju Meswani
5e549a5c24
How to setup the cuda env for windows (#20444) 2024-04-24 16:35:47 -07:00
Sophie Schoenmeyer
82e2da0819
Update with-python.md with CUDA 12.X instructions (#20442)
### Description
with-python.md does not currently include installation instructions for
CUDA 12.X, so I added the instructions from
https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html#requirements.



### 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. -->
2024-04-23 14:32:17 -07:00
Sophie Schoenmeyer
be0c6c93f5
Update index.md with table of contents (#20441)
### Description
File previously included TOC placeholder instead of actual TOC



### 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. -->
2024-04-23 14:32:06 -07:00
Sophie Schoenmeyer
ff5c5c5cdc
Update CUDA-ExecutionProvider.md to add TOC (#20443)
### Description
CUDA-ExecutionProvider.md table of contents previously not showing up
correctly b/c of spacing issue.



### 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. -->
2024-04-23 14:31:49 -07:00
Nat Kershaw (MSFT)
0ebd6b46ff
Update generate() API docs (#20433)
Light edit of generate() docs
2024-04-23 09:16:55 -07:00
Nat Kershaw (MSFT)
a3eceb52f3
Add build from source for DML (#20384) 2024-04-21 15:00:46 -07:00
Yifan Li
55edff104f
[TensorRT EP] Update instruction of user_compute_stream (#20343)
### Description
<!-- Describe your changes. -->
Update instruction and add sample code

### Preview the change:

https://yf711.github.io/onnxruntime/docs/execution-providers/TensorRT-ExecutionProvider.html#execution-provider-options

### 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. -->
2024-04-17 13:45:06 -07:00
Nat Kershaw (MSFT)
d3551b0069
Add instructions to build generate() API from source on Mac (#20342)
Staged here:
https://natke.github.io/onnxruntime/docs/genai/howto/build-from-source.html#option-3-build-from-source
2024-04-17 09:22:39 -07:00
Nat Kershaw (MSFT)
92cbb4249d
Improve build instructions (#20251) 2024-04-09 19:12:53 -07:00
Nat Kershaw (MSFT)
4a0a4ce205
Improve generate() API build instructions (#20181)
Staged here:
https://natke.github.io/onnxruntime/docs/genai/howto/build-from-source.html
2024-04-05 11:31:26 -07:00
Phoebe Chen
e31928e7ff
Add Initial Cross-Compilation Documentation for RISC-V Support (#19239)
Update the document for PR: Enable Cross-Compiling Support for ONNX
Runtime on Linux for RISC-V 64-bit.
https://github.com/microsoft/onnxruntime/pull/19238

Signed-off-by: Phoebe Chen <phoebe.chen@sifive.com>
2024-04-05 06:54:18 -07:00
Scott McKay
e0a6a9640b
Update CoreML EP docs (#19844)
### Description
Add new flags and MLProgram supported ops.

### Motivation and Context
Update docs
2024-04-04 21:54:09 -07:00
Manix
435e9a33dc
Update quantization.md for QDQ and dynamic quantization old doc (#20130)
- doc suggests that QDQ model are created with dynamic quant, which is
not the case anymore.
- updating and restructuring the doc

### Description
<!-- Describe your changes. -->
- QDQ model format representation doesn't come for dynamic quantization,
but the doc was suggesting.
- May be a couple of years back this support was there but not anymore


### 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. -->
- Clears misunderstanding that QDQ Onnx models can be created with
dynamic quantization.

https://github.com/microsoft/onnxruntime/issues/20125
2024-04-04 21:38:20 -07:00
wangshuai09
216231d197
[CANN] Update the doc of CANN EP (#20138)
This PR update docs of Ascend CANN excution provider doc for #20075 

### Changes
1. Add new option
`dump_om_model`: Whether to dump the OM(Offlined Model for Aasend Npu)
to disk

---------

Co-authored-by: Tianlei Wu <tlwu@microsoft.com>
2024-04-01 21:36:05 -07:00
Nat Kershaw (MSFT)
1ef08b350f
Add install ONNX Runtime from nightly (#20131)
### Description
<!-- Describe your changes. -->



### 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. -->
2024-04-01 21:33:46 -07:00
Yulong Wang
73173cc2c2
[doc] update Web tutorial (#19849)
### Description
This PR re-arranges "tutorial" documentation of ORT web on
onnxruntime.ai

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

### Changes

- Added page:
- [`Using
WebGPU`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/ep-webgpu.html)
- [`Working with Large
Models`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/large-models.html)
- [`Performance
Diagnosis`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/performance-diagnosis.html)
- [`Deploying ONNX Runtime
Web`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/deploy.html)
-
[`Troubleshooting`](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/trouble-shooting.html)
(a placeholder for now)
2024-03-26 14:48:21 -07:00
rui-ren
f3efd8d265
a small fix for installation command (#20046)
Previous Command cannot `copy/paste` and install directly in terminal.
2024-03-23 10:22:57 -07:00