Contrib ops

Contrib 运算符列表

Contrib 运算符的 schema 在 ONNX Runtime 仓库中有所记录。

发布	文档
主分支	https://github.com/microsoft/onnxruntime/blob/main/docs/ContribOperators.md
1.20	https://github.com/microsoft/onnxruntime/blob/rel-1.20.0/docs/ContribOperators.md
1.19	https://github.com/microsoft/onnxruntime/blob/rel-1.19.0/docs/ContribOperators.md
1.18	https://github.com/microsoft/onnxruntime/blob/rel-1.18.0/docs/ContribOperators.md
1.17	https://github.com/microsoft/onnxruntime/blob/rel-1.17.0/docs/ContribOperators.md
1.16	https://github.com/microsoft/onnxruntime/blob/rel-1.16.0/docs/ContribOperators.md
1.15	https://github.com/microsoft/onnxruntime/blob/rel-1.15.0/docs/ContribOperators.md
1.14	https://github.com/microsoft/onnxruntime/blob/rel-1.14.0/docs/ContribOperators.md
1.13	https://github.com/microsoft/onnxruntime/blob/rel-1.13.1/docs/ContribOperators.md
1.12	https://github.com/microsoft/onnxruntime/blob/rel-1.12.0/docs/ContribOperators.md
1.11	https://github.com/microsoft/onnxruntime/blob/rel-1.11.0/docs/ContribOperators.md
1.10	https://github.com/microsoft/onnxruntime/blob/rel-1.10.0/docs/ContribOperators.md
1.9	https://github.com/microsoft/onnxruntime/blob/rel-1.9.0/docs/ContribOperators.md
1.8	https://github.com/microsoft/onnxruntime/blob/rel-1.8.0/docs/ContribOperators.md
1.7	https://github.com/microsoft/onnxruntime/blob/rel-1.7.0/docs/ContribOperators.md

添加 Contrib 运算符

自定义运算符的 schema 和形状推断函数应使用 ONNX_CONTRIB_OPERATOR_SCHEMA 添加到 contrib_defs.cc 中。示例：Inverse 运算符

ONNX_CONTRIB_OPERATOR_SCHEMA(Inverse)
    .SetDomain(kMSDomain) // kMSDomain = "com.microsoft"
    .SinceVersion(1) // Same version used at op (symbolic) registration
    ...

新的运算符应具有完整的参考实现测试和形状推断测试。

参考实现 Python 测试应添加到 onnxruntime/test/python/contrib_ops 中。例如，aten_op_tests.py

形状推断 C++ 测试应添加到 onnxruntime/test/contrib_ops 中。例如，trilu_shape_inference_test.cc

运算符内核应使用 Compute 函数在 contrib 命名空间下实现，CPU 部分在 onnxruntime/contrib_ops/cpu/ 中，CUDA 部分在 onnxruntime/contrib_ops/cuda/ 中。

namespace onnxruntime {
namespace contrib {

class Inverse final : public OpKernel {
 public:
  explicit Inverse(const OpKernelInfo& info) : OpKernel(info) {}
  Status Compute(OpKernelContext* ctx) const override;

 private:
 ...
};

ONNX_OPERATOR_KERNEL_EX(
    Inverse,
    kMSDomain,
    1,
    kCpuExecutionProvider,
    KernelDefBuilder()
        .TypeConstraint("T", BuildKernelDefConstraints<float, double, MLFloat16>()),
    Inverse);

Status Inverse::Compute(OpKernelContext* ctx) const {
... // kernel implementation
}

}  // namespace contrib
}  // namespace onnxruntime

内核应在 cpu_contrib_kernels.cc 中注册用于 CPU，在 cuda_contrib_kernels.cc 中注册用于 CUDA。

现在您应该能够构建并安装 ONNX Runtime 以开始使用您的自定义运算符。

Contrib 运算符测试

测试应添加到 onnxruntime/test/contrib_ops/ 中。例如

namespace onnxruntime {
namespace test {

// Add a comprehensive set of unit tests for custom op kernel implementation

TEST(InverseContribOpTest, two_by_two_float) {
  OpTester test("Inverse", 1, kMSDomain); // custom opset version and domain
  test.AddInput<float>("X", {2, 2}, {4, 7, 2, 6});
  test.AddOutput<float>("Y", {2, 2}, {0.6f, -0.7f, -0.2f, 0.4f});
  test.Run();
}

...

}  // namespace test
}  // namespace onnxruntime

Contrib ops

目录

Contrib 运算符列表

添加 Contrib 运算符

Contrib 运算符测试