Link Search Menu Expand Document

Add a new operator to ONNX Runtime

Contents

A new op can be written and registered with ONNXRuntime in the following 3 ways

  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.

  2. 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 See this for an example called MyCustomOp that uses the C++ helper API (onnxruntime_cxx_api.h). Currently, the only supported Execution Providers (EPs) for custom ops registered via this approach are the CUDA and the CPU EPs.
  1. 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 for an example.

  1. 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 for an example.