OrtEpApi class final

\brief The OrtEpApi struct provides functions that are relevant to the implementation of an execution provider.

\since Version 1.22.

Inheritance

• Object
• Struct
• OrtEpApi

Implemented types

• NativeType

Available extensions

• StructAddress

Constructors

OrtEpApi()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.

no setter

CreateEpDevice ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> ep_factory, Pointer<OrtHardwareDevice> hardware_device, Pointer<OrtKeyValuePairs> ep_metadata, Pointer<OrtKeyValuePairs> ep_options, Pointer<Pointer<OrtEpDevice>> ep_device)>>

\brief Create an OrtEpDevice for the EP and an OrtHardwareDevice. \paramin ep_factory Execution provider factory that is creating the instance. \paramin hardware_device Hardware device that the EP can utilize. \paramin ep_metadata Optional OrtKeyValuePairs instance for execution provider metadata that may be used during execution provider selection and passed to CreateEp. ep_device will copy this instance and the user should call ReleaseKeyValuePairs. \paramin ep_options Optional OrtKeyValuePairs instance for execution provider options that will be added to the Session configuration options if the execution provider is selected. ep_device will copy this instance and the user should call ReleaseKeyValuePairs. \param ep_device OrtExecutionDevice that is created.

getter/setter pair

CreateHardwareDevice ↔ Pointer<NativeFunction<OrtStatusPtr Function(UnsignedInt type, Uint32 vendor_id, Uint32 device_id, Pointer<Char> vendor_name, Pointer<OrtKeyValuePairs> metadata, Pointer<Pointer<OrtHardwareDevice>> hardware_device)>>

\brief Create an OrtHardwareDevice.

getter/setter pair

CreateIfKernel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> kernel_info, Pointer<Pointer<OrtKernelImpl>> kernel_out)>>

\brief Creates an OrtKernelImpl instance for an If operator.

getter/setter pair

CreateKernelDefBuilder ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtKernelDefBuilder>> kernel_def_builder_out)>>

\brief Creates a kernel definition builder used to create instances of OrtKernelDef.

getter/setter pair

CreateKernelRegistry ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtKernelRegistry>> kernel_registry)>>

\brief Creates an empty kernel registry. A kernel registry contains kernel creation information for every operator kernel supported by an EP.

getter/setter pair

CreateLoopKernel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> kernel_info, Pointer<OrtLoopKernelHelper> helper, Pointer<Pointer<OrtKernelImpl>> kernel_out)>>

\brief Creates an OrtKernelImpl instance for a Loop operator.

getter/setter pair

CreateScanKernel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> kernel_info, Pointer<OrtScanKernelHelper> helper, Pointer<Pointer<OrtKernelImpl>> kernel_out)>>

\brief Creates an OrtKernelImpl instance for a Scan operator. Does not support opset versions older than 9.

getter/setter pair

DeviceEpIncompatibilityDetails_SetDetails ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtDeviceEpIncompatibilityDetails> details, Uint32 reasons_bitmask, Int32 error_code, Pointer<Char> notes)>>

\brief Set the details of an OrtDeviceEpIncompatibilityDetails instance.

getter/setter pair

EpDevice_AddAllocatorInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpDevice> ep_device, Pointer<OrtMemoryInfo> allocator_memory_info)>>

\brief Register an allocator with the OrtEpDevice.

getter/setter pair

EpGraphSupportInfo_AddNodesToFuse ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpGraphSupportInfo> graph_support_info, Pointer<Pointer<OrtNode>> nodes, Size num_nodes, Pointer<OrtNodeFusionOptions> node_fusion_options)>>

\brief Specify nodes that are supported by an OrtEp and should be fused into one node.

getter/setter pair

EpGraphSupportInfo_AddSingleNode ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpGraphSupportInfo> graph_support_info, Pointer<OrtNode> node)>>

\brief Specify a node that is supported by an OrtEp and should be run with a registered EP kernel.

getter/setter pair

EpGraphSupportInfo_LookUpKernel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpGraphSupportInfo> graph_support_info, Pointer<OrtNode> node, Pointer<Pointer<OrtKernelDef>> out_kernel_def)>>

\brief Gets the kernel definition for a given node, if any exists for the calling execution provider.

getter/setter pair

GetEnvConfigEntries ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<Pointer<OrtKeyValuePairs>> config_entries)>>

\brief Gets a new OrtKeyValuePairs instance containing a copy of all configuration entries set on the environment.

getter/setter pair

GetSyncIdForLastWaitOnSyncStream ↔ Pointer<NativeFunction<Uint64 Function(Pointer<OrtSyncStream> producer_stream, Pointer<OrtSyncStream> consumer_stream)>>

\brief Get the sync ID for the last time the consumer_stream waited on the producer_stream.

getter/setter pair

GetTensorDataType ↔ Pointer<NativeFunction<OrtStatusPtr Function(UnsignedInt elem_type, Pointer<Pointer<OrtDataType>> out)>>

\brief Gets the OrtDataType that represents the data type for a tensor of the given element type.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, inherited

KernelDef_GetDomain ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtKernelDef> kernel_def)>>

\brief Returns the operator's domain from the kernel definition.

getter/setter pair

KernelDef_GetExecutionProvider ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtKernelDef> kernel_def)>>

\brief Returns the name of the kernel's intended execution provider.

getter/setter pair

KernelDef_GetInputMemType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDef> kernel_def, Size input_index, Pointer<Int> mem_type)>>

\brief Gets the memory type for a kernel input.

getter/setter pair

KernelDef_GetOperatorType ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtKernelDef> kernel_def)>>

\brief Returns the operator type from the kernel definition.

getter/setter pair

KernelDef_GetOutputMemType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDef> kernel_def, Size output_index, Pointer<Int> mem_type)>>

\brief Gets the memory type for a kernel output.

getter/setter pair

KernelDef_GetSinceVersion ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDef> kernel_def, Pointer<Int> start_version, Pointer<Int> end_version)>>

\brief Gets the kernel's opset version range that is supported.

getter/setter pair

KernelDefBuilder_AddInputOutputAliases ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Int> input_indices, Pointer<Int> output_indices, Size num_io_indices)>>

\brief Adds aliases for the given input and output pairs.

getter/setter pair

KernelDefBuilder_AddInputOutputMutableAliases ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Int> input_indices, Pointer<Int> output_indices, Size num_io_indices)>>

\brief Adds mutable aliases for the given input and output pairs.

getter/setter pair

KernelDefBuilder_AddTypeConstraint ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Char> arg_name, Pointer<Pointer<OrtDataType>> types, Size num_types)>>

\brief Adds type constraints for a kernel argument represented as a string (e.g., "T").

getter/setter pair

KernelDefBuilder_Build ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Pointer<OrtKernelDef>> kernel_def_out)>>

\brief Creates a OrtKernelDef instance from the given kernel definition builder.

getter/setter pair

KernelDefBuilder_SetDomain ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Char> domain)>>

\brief Sets the kernel's domain.

getter/setter pair

KernelDefBuilder_SetExecutionProvider ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Char> ep_name)>>

\brief Sets the name of the kernel's intended execution provider.

getter/setter pair

KernelDefBuilder_SetInputMemType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Size input_index, Int mem_type)>>

\brief Sets the memory type for a kernel input.

getter/setter pair

KernelDefBuilder_SetOperatorType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Pointer<Char> op_type)>>

\brief Sets the kernel's operator type.

getter/setter pair

KernelDefBuilder_SetOutputMemType ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Size output_index, Int mem_type)>>

\brief Sets the memory type for a kernel output.

getter/setter pair

KernelDefBuilder_SetSinceVersion ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelDefBuilder> kernel_def_builder, Int since_version_start, Int since_version_end)>>

\brief Sets the kernel's opset version range that is supported.

getter/setter pair

KernelInfo_GetEp ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelInfo> info, Pointer<Pointer<OrtEp>> ep)>>

\brief Get the OrtEp instance to which the node is assigned from the OrtKernelInfo.

getter/setter pair

KernelRegistry_AddKernel ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtKernelRegistry> kernel_registry, Pointer<OrtKernelDef> kernel_def, OrtKernelCreateFunc kernel_create_func, Pointer<Void> kernel_create_func_state)>>

\brief Adds kernel creation information for a supported operator kernel to the given kernel registry.

getter/setter pair

MemoryDevice_AreEqual ↔ Pointer<NativeFunction<Bool Function(Pointer<OrtMemoryDevice> a, Pointer<OrtMemoryDevice> b)>>

\brief Compare two OrtMemoryDevice instances for equality.

getter/setter pair

MemoryDevice_GetDeviceId ↔ Pointer<NativeFunction<Uint32 Function(Pointer<OrtMemoryDevice> memory_device)>>

\brief Get the device ID from an OrtMemoryDevice instance.

getter/setter pair

MemoryDevice_GetDeviceType ↔ Pointer<NativeFunction<UnsignedInt Function(Pointer<OrtMemoryDevice> memory_device)>>

\brief Get the OrtMemoryInfoDeviceType value from an OrtMemoryDevice instance.

getter/setter pair

MemoryDevice_GetMemoryType ↔ Pointer<NativeFunction<UnsignedInt Function(Pointer<OrtMemoryDevice> memory_device)>>

\brief Get the OrtDeviceMemoryType value from an OrtMemoryDevice instance.

getter/setter pair

MemoryDevice_GetVendorId ↔ Pointer<NativeFunction<Uint32 Function(Pointer<OrtMemoryDevice> memory_device)>>

\brief Get the vendor ID from an OrtMemoryDevice instance.

getter/setter pair

MemoryInfo_GetMemoryDevice ↔ Pointer<NativeFunction<Pointer<OrtMemoryDevice> Function(Pointer<OrtMemoryInfo> memory_info)>>

\brief Get the OrtMemoryDevice from an OrtMemoryInfo instance.

getter/setter pair

NodeComputeContext_NodeName ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtNodeComputeContext> context)>>

\brief Query a OrtNodeComputeContext for the name of the node that encapsulates the compiled/fused node.

getter/setter pair

ReleaseEpDevice ↔ Pointer<NativeFunction<Void Function(Pointer<OrtEpDevice> input)>>

getter/setter pair

ReleaseHardwareDevice ↔ Pointer<NativeFunction<Void Function(Pointer<OrtHardwareDevice> input)>>

getter/setter pair

ReleaseKernelDef ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKernelDef> input)>>

getter/setter pair

ReleaseKernelDefBuilder ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKernelDefBuilder> input)>>

getter/setter pair

ReleaseKernelImpl ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKernelImpl> input)>>

getter/setter pair

ReleaseKernelRegistry ↔ Pointer<NativeFunction<Void Function(Pointer<OrtKernelRegistry> input)>>

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

SharedPrePackedWeightCache_StoreWeightData ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtSharedPrePackedWeightCache> prepacked_weight_cache, Pointer<Pointer<Void>> buffer_data_ptrs, Pointer<Size> buffer_data_sizes, Size num_buffers)>>

\brief Sets one or more data buffers that collectively hold the pre-packed data for a single shared weight.

getter/setter pair

SyncStream_GetImpl ↔ Pointer<NativeFunction<Pointer<OrtSyncStreamImpl> Function(Pointer<OrtSyncStream> stream)>>

\brief Get the OrtSyncStreamImpl associated with an OrtSyncStream instance.

getter/setter pair

SyncStream_GetSyncId ↔ Pointer<NativeFunction<Uint64 Function(Pointer<OrtSyncStream> stream)>>

\brief Get the current sync ID for a stream.

getter/setter pair

Value_GetMemoryDevice ↔ Pointer<NativeFunction<Pointer<OrtMemoryDevice> Function(Pointer<OrtValue> value)>>

\brief Get the OrtMemoryDevice from an OrtValue instance if it contains a Tensor.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited