# OnnxRuntime: Ort::CustomOpApi Struct Reference

Loading...
Searching...
No Matches
Ort::CustomOpApi Struct Reference

This entire structure is deprecated, but we not marking it as a whole yet since we want to preserve for the next release. More...

`#include <onnxruntime_cxx_api.h>`

## Public Member Functions

| CustomOpApi (const OrtApi &api)
OrtTensorTypeAndShapeInfo * | GetTensorTypeAndShape (const OrtValue *value)
size_t | GetTensorShapeElementCount (const OrtTensorTypeAndShapeInfo *info)
ONNXTensorElementDataType | GetTensorElementType (const OrtTensorTypeAndShapeInfo *info)
size_t | GetDimensionsCount (const OrtTensorTypeAndShapeInfo *info)
void | GetDimensions (const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)
void | SetDimensions (OrtTensorTypeAndShapeInfo *info, const int64_t *dim_values, size_t dim_count)
template<typename T >
T * | GetTensorMutableData (OrtValue *value)
template<typename T >
const T * | GetTensorData (const OrtValue *value)
const OrtMemoryInfo * | GetTensorMemoryInfo (const OrtValue *value)
std::vector< int64_t > | GetTensorShape (const OrtTensorTypeAndShapeInfo *info)
void | ReleaseTensorTypeAndShapeInfo (OrtTensorTypeAndShapeInfo *input)
size_t | KernelContext_GetInputCount (const OrtKernelContext *context)
const OrtValue * | KernelContext_GetInput (const OrtKernelContext *context, size_t index)
size_t | KernelContext_GetOutputCount (const OrtKernelContext *context)
OrtValue * | KernelContext_GetOutput (OrtKernelContext *context, size_t index, const int64_t *dim_values, size_t dim_count)
void * | KernelContext_GetGPUComputeStream (const OrtKernelContext *context)
void | ThrowOnError (OrtStatus *result)
OrtOpAttr * | CreateOpAttr (const char *name, const void *data, int len, OrtOpAttrType type)
void | ReleaseOpAttr (OrtOpAttr *op_attr)
OrtOp * | CreateOp (const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, int type_constraint_count, const OrtOpAttr *const *attr_values, int attr_count, int input_count, int output_count)
void | InvokeOp (const OrtKernelContext *context, const OrtOp *ort_op, const OrtValue *const *input_values, int input_count, OrtValue *const *output_values, int output_count)
void | ReleaseOp (OrtOp *ort_op)
template<typename T >
T | KernelInfoGetAttribute (const OrtKernelInfo *info, const char *name)
OrtKernelInfo * | CopyKernelInfo (const OrtKernelInfo *info)
void | ReleaseKernelInfo (OrtKernelInfo *info_copy)

## Detailed Description

This entire structure is deprecated, but we not marking it as a whole yet since we want to preserve for the next release.

## Constructor & Destructor Documentation

## CustomOpApi()

Ort::CustomOpApi::CustomOpApi | ( | const OrtApi & | api | ) |

inline

## Member Function Documentation

## CopyKernelInfo()

OrtKernelInfo * Ort::CustomOpApi::CopyKernelInfo | ( | const OrtKernelInfo * | info | ) |

Deprecated:
  use Ort::KernelInfo::Copy querying attributes [[deprecated]] This interface is not exception safe

## CreateOp()

OrtOp * Ort::CustomOpApi::CreateOp | ( | const OrtKernelInfo * | info,
|  | const char * | op_name,
|  | const char * | domain,
|  | int | version,
|  | const char ** | type_constraint_names,
|  | const ONNXTensorElementDataType * | type_constraint_values,
|  | int | type_constraint_count,
|  | const OrtOpAttr *const * | attr_values,
|  | int | attr_count,
|  | int | input_count,
|  | int | output_count
| ) |  |

Deprecated:
  use Ort::Op [[deprecated]] This interface is not exception safe.

## CreateOpAttr()

OrtOpAttr * Ort::CustomOpApi::CreateOpAttr | ( | const char * | name,
|  | const void * | data,
|  | int | len,
|  | OrtOpAttrType | type
| ) |  |

Deprecated:
  use Ort::OpAttr [[deprecated]] This interface is not exception safe.

## GetDimensions()

void Ort::CustomOpApi::GetDimensions | ( | const OrtTensorTypeAndShapeInfo * | info,
|  | int64_t * | dim_values,
|  | size_t | dim_values_length
| ) |  |

Deprecated:
  use Ort::TensorTypeAndShapeInfo::GetShape() [[deprecated]] This interface is redundant.

## GetDimensionsCount()

size_t Ort::CustomOpApi::GetDimensionsCount | ( | const OrtTensorTypeAndShapeInfo * | info | ) |

Deprecated:
  use Ort::TensorTypeAndShapeInfo::GetDimensionsCount() [[deprecated]] This interface is redundant.

## GetTensorData()

template<typename T >

const T * Ort::CustomOpApi::GetTensorData | ( | const OrtValue * | value | ) |

Deprecated:
  use Ort::Value::GetTensorData() [[deprecated]] This interface is redundant.

## GetTensorElementType()

ONNXTensorElementDataType Ort::CustomOpApi::GetTensorElementType | ( | const OrtTensorTypeAndShapeInfo * | info | ) |

Deprecated:
  use Ort::TensorTypeAndShapeInfo::GetElementType() [[deprecated]] This interface is redundant.

## GetTensorMemoryInfo()

const OrtMemoryInfo * Ort::CustomOpApi::GetTensorMemoryInfo | ( | const OrtValue * | value | ) |

Deprecated:
  use Ort::Value::GetTensorMemoryInfo() [[deprecated]] This interface is redundant.

## GetTensorMutableData()

template<typename T >

T * Ort::CustomOpApi::GetTensorMutableData | ( | OrtValue * | value | ) |

Deprecated:
  use Ort::Value::GetTensorMutableData() [[deprecated]] This interface is redundant.

## GetTensorShape()

std::vector< int64_t > Ort::CustomOpApi::GetTensorShape | ( | const OrtTensorTypeAndShapeInfo * | info | ) |

Deprecated:
  use Ort::TensorTypeAndShapeInfo::GetShape() [[deprecated]] This interface is redundant.

## GetTensorShapeElementCount()

size_t Ort::CustomOpApi::GetTensorShapeElementCount | ( | const OrtTensorTypeAndShapeInfo * | info | ) |

Deprecated:
  use Ort::TensorTypeAndShapeInfo::GetElementCount() [[deprecated]] This interface is redundant.

## GetTensorTypeAndShape()

OrtTensorTypeAndShapeInfo * Ort::CustomOpApi::GetTensorTypeAndShape | ( | const OrtValue * | value | ) |

Deprecated:
  use Ort::Value::GetTensorTypeAndShape() [[deprecated]] This interface produces a pointer that must be released. Not exception safe.

## InvokeOp()

void Ort::CustomOpApi::InvokeOp | ( | const OrtKernelContext * | context,
|  | const OrtOp * | ort_op,
|  | const OrtValue *const * | input_values,
|  | int | input_count,
|  | OrtValue *const * | output_values,
|  | int | output_count
| ) |  |

Deprecated:
  use Ort::Op::Invoke [[deprecated]] This interface is redundant

## KernelContext_GetGPUComputeStream()

void * Ort::CustomOpApi::KernelContext_GetGPUComputeStream | ( | const OrtKernelContext * | context | ) |

Deprecated:
  use Ort::KernelContext::GetGPUComputeStream [[deprecated]] This interface is redundant.

## KernelContext_GetInput()

const OrtValue * Ort::CustomOpApi::KernelContext_GetInput | ( | const OrtKernelContext * | context,
|  | size_t | index
| ) |  |

Deprecated:
  use Ort::KernelContext::GetInput [[deprecated]] This interface is redundant.

## KernelContext_GetInputCount()

size_t Ort::CustomOpApi::KernelContext_GetInputCount | ( | const OrtKernelContext * | context | ) |

Deprecated:
  use Ort::KernelContext::GetInputCount [[deprecated]] This interface is redundant.

## KernelContext_GetOutput()

OrtValue * Ort::CustomOpApi::KernelContext_GetOutput | ( | OrtKernelContext * | context,
|  | size_t | index,
|  | const int64_t * | dim_values,
|  | size_t | dim_count
| ) |  |

Deprecated:
  use Ort::KernelContext::GetOutput [[deprecated]] This interface is redundant.

## KernelContext_GetOutputCount()

size_t Ort::CustomOpApi::KernelContext_GetOutputCount | ( | const OrtKernelContext * | context | ) |

Deprecated:
  use Ort::KernelContext::GetOutputCount [[deprecated]] This interface is redundant.

## KernelInfoGetAttribute()

template<typename T >

T Ort::CustomOpApi::KernelInfoGetAttribute | ( | const OrtKernelInfo * | info,
|  | const char * | name
| ) |  |

Deprecated:
  use Ort::KernelInfo for automatic lifespan management or for querying attributes [[deprecated]] This interface is redundant

## ReleaseKernelInfo()

void Ort::CustomOpApi::ReleaseKernelInfo | ( | OrtKernelInfo * | info_copy | ) |

Deprecated:
  use Ort::KernelInfo for lifespan management querying attributes [[deprecated]] This interface is not exception safe

## ReleaseOp()

void Ort::CustomOpApi::ReleaseOp | ( | OrtOp * | ort_op | ) |

Deprecated:
  use Ort::Op for automatic lifespan management. [[deprecated]] This interface is not exception safe.

## ReleaseOpAttr()

void Ort::CustomOpApi::ReleaseOpAttr | ( | OrtOpAttr * | op_attr | ) |

Deprecated:
  use Ort::OpAttr [[deprecated]] This interface is not exception safe.

## ReleaseTensorTypeAndShapeInfo()

void Ort::CustomOpApi::ReleaseTensorTypeAndShapeInfo | ( | OrtTensorTypeAndShapeInfo * | input | ) |

Deprecated:
  use TensorTypeAndShapeInfo instances for automatic ownership. [[deprecated]] This interface is not exception safe.

## SetDimensions()

void Ort::CustomOpApi::SetDimensions | ( | OrtTensorTypeAndShapeInfo * | info,
|  | const int64_t * | dim_values,
|  | size_t | dim_count
| ) |  |

Deprecated:
  [[deprecated]] This interface sets dimensions to TensorTypeAndShapeInfo, but has no effect on the OrtValue.

## ThrowOnError()

void Ort::CustomOpApi::ThrowOnError | ( | OrtStatus * | result | ) |

Deprecated:
  use Ort::ThrowOnError() [[deprecated]] This interface is redundant.