Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/how-to/add-execution-provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,16 @@ Example:
OrtReleaseObject(factory);
OrtCreateSession(env, model_path, session_option, &session);
```

## Test the Execution Provider

To ease the testing of your execution provider, you can add a new case for it to the `onnx_test_runner` command,
do this by adding it to `onnxruntime/test/onnx/main.cc` file, following the pattern for other existing providers.

Once you have this in place, you can run the `onnx_test_runner`, like this:

```
$ cd build/PLATFORM/CONFIGURATION
$ ./onnx_test_runner -e YOUR_BACKEND ./testdata/ort_minimal_e2e_test_data/
$ ./onnx_test_runner -e YOUR_BACKEND ./testdata/gemm_activation_fusion/
```
18 changes: 9 additions & 9 deletions docs/how-to/build/eps.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ These instructions are for JetPack SDK 4.4.

## oneDNN

See more information on ondDNN (formerly DNNL) [here](../reference/execution-providers/DNNL-ExecutionProvider.md).
See more information on ondDNN (formerly DNNL) [here](../../reference/execution-providers/DNNL-ExecutionProvider.md).

### Build Instructions
{: .no_toc }
Expand Down Expand Up @@ -290,7 +290,7 @@ For more information on OpenVINO Execution Provider's ONNX Layer support, To
---

## NUPHAR
See more information on the Nuphar Execution Provider [here](../reference/execution-providers/Nuphar-ExecutionProvider.md).
See more information on the Nuphar Execution Provider [here](../../reference/execution-providers/Nuphar-ExecutionProvider.md).

### Prerequisites
{: .no_toc }
Expand Down Expand Up @@ -370,7 +370,7 @@ Dockerfile instructions are available [here](https://github.com/microsoft/onnxru
---

## DirectML
See more information on the DirectML execution provider [here](../reference/execution-providers/DirectML-ExecutionProvider.md).
See more information on the DirectML execution provider [here](../../reference/execution-providers/DirectML-ExecutionProvider.md).
### Windows
{: .no_toc }

Expand All @@ -385,7 +385,7 @@ The DirectML execution provider supports building for both x64 and x86 architect
---

## ARM Compute Library
See more information on the ACL Execution Provider [here](../reference/execution-providers/ACL-ExecutionProvider.md).
See more information on the ACL Execution Provider [here](../../reference/execution-providers/ACL-ExecutionProvider.md).

### Prerequisites
{: .no_toc }
Expand Down Expand Up @@ -452,7 +452,7 @@ onnxruntime_test_all

## ArmNN

See more information on the ArmNN Execution Provider [here](../reference/execution-providers/ArmNN-ExecutionProvider.md).
See more information on the ArmNN Execution Provider [here](../../reference/execution-providers/ArmNN-ExecutionProvider.md).

### Prerequisites
{: .no_toc }
Expand Down Expand Up @@ -500,7 +500,7 @@ The ARM Compute Library home directory and build directory must also be availabl
---

## RKNPU
See more information on the RKNPU Execution Provider [here](../reference/execution-providers/RKNPU-ExecutionProvider.md).
See more information on the RKNPU Execution Provider [here](../../reference/execution-providers/RKNPU-ExecutionProvider.md).

### Prerequisites
{: .no_toc }
Expand Down Expand Up @@ -539,9 +539,9 @@ set(CMAKE_C_COMPILER aarch64-linux-gnu-gcc)
---

## Vitis-AI
See more information on the Xilinx Vitis-AI execution provider [here](../reference/execution-providers/Vitis-AI-ExecutionProvider.md).
See more information on the Xilinx Vitis-AI execution provider [here](../../reference/execution-providers/Vitis-AI-ExecutionProvider.md).

For instructions to setup the hardware environment: [Hardware setup](../reference/execution-providers/Vitis-AI-ExecutionProvider.md#Hardware-setup)
For instructions to setup the hardware environment: [Hardware setup](../../reference/execution-providers/Vitis-AI-ExecutionProvider.md#Hardware-setup)

### Linux
{: .no_toc }
Expand All @@ -560,7 +560,7 @@ The Vitis-AI execution provider is only supported on Linux.

## AMD MIGraphX

See more information on the MIGraphX Execution Provider [here](../reference/execution-providers/MIGraphX-ExecutionProvider.md).
See more information on the MIGraphX Execution Provider [here](../../reference/execution-providers/MIGraphX-ExecutionProvider.md).

### Prerequisites
{: .no_toc }
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/c-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: C API
parent: API docs
grand_parent: Reference
nav_order: 1
---

# ONNX Runtime C API
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/cpp-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: C++ API
parent: API docs
grand_parent: Reference
nav_order: 2
---

# ONNX Runtime C++ API
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/csharp-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: C# API
parent: API docs
grand_parent: Reference
nav_order: 3
---

# ONNX Runtime C# API
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/java-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Java API
parent: API docs
grand_parent: Reference
nav_order: 4
---

# ONNX Runtime Java API
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/js-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: JavaScript API
parent: API docs
grand_parent: Reference
nav_order: 5
---

# ONNX Runtime JavaScript API
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/objectivec-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Objective-C API
parent: API docs
grand_parent: Reference
nav_order: 6
---

# ONNX Runtime Objective-C API
Expand Down
3 changes: 2 additions & 1 deletion docs/reference/api/other-apis.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Other APIs
title: Other Inference APIs
parent: API docs
grand_parent: Reference
nav_order: 9
---

# Other APIs
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/python-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Python API
parent: API docs
grand_parent: Reference
nav_order: 7
---

# ONNX Runtime Python API
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/training-pytorch.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Training API
parent: API docs
grand_parent: Reference
nav_order: 10
---

# Training API (PyTorch)
Expand Down
1 change: 1 addition & 0 deletions docs/reference/api/winrt-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: WinRT API
parent: API docs
grand_parent: Reference
nav_order: 8
---

# Windows Machine Learning WinRT API
Expand Down