2018-11-20 00:48:22 +00:00
|
|
|
Adding a new op
|
|
|
|
|
===============
|
|
|
|
|
|
|
|
|
|
## A new op can be written and registered with ONNXRuntime in the following 3 ways
|
2019-03-07 03:09:55 +00:00
|
|
|
### 1. Using the experimental custom op API in the C API (onnxruntime_c_api.h)
|
|
|
|
|
Note: These APIs are experimental and will change in the next release. They're released now for feedback and experimentation.
|
|
|
|
|
* Create an OrtCustomOpDomain with the domain name used by the custom ops
|
|
|
|
|
* Create an OrtCustomOp structure for each op and add them to the OrtCustomOpDomain with OrtCustomOpDomain_Add
|
|
|
|
|
* Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
|
2019-04-26 18:22:46 +00:00
|
|
|
See [this](../onnxruntime/test/shared_lib/test_inference.cc) for an example called MyCustomOp that uses the C++ helper API (onnxruntime_cxx_api.h).
|
2020-03-11 07:49:01 +00:00
|
|
|
Currently, the only supported Execution Providers (EPs) for custom ops registered via this approach are the `CUDA` and the `CPU` EPs.
|
2018-11-20 00:48:22 +00:00
|
|
|
|
|
|
|
|
### 2. Using RegisterCustomRegistry API
|
|
|
|
|
* Implement your kernel and schema (if required) using the OpKernel and OpSchema APIs (headers are in the include folder).
|
|
|
|
|
* Create a CustomRegistry object and register your kernel and schema with this registry.
|
|
|
|
|
* Register the custom registry with ONNXRuntime using RegisterCustomRegistry API.
|
|
|
|
|
|
|
|
|
|
See
|
|
|
|
|
[this](../onnxruntime/test/framework/local_kernel_registry_test.cc) for an example.
|
|
|
|
|
|
|
|
|
|
### 3. Contributing the op to ONNXRuntime
|
|
|
|
|
This is mostly meant for ops that are in the process of being proposed to ONNX. This way you don't have to wait for an approval from the ONNX team
|
|
|
|
|
if the op is required in production today.
|
|
|
|
|
See [this](../onnxruntime/contrib_ops) for an example.
|
