OrtEpFactory class final

\brief The OrtEpFactory provides functions to create and manage execution providers. \since Version 1.22.

Inheritance
Implemented types
Available extensions

Constructors

OrtEpFactory()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
CreateAllocator ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<OrtMemoryInfo> memory_info, Pointer<OrtKeyValuePairs> allocator_options, Pointer<Pointer<OrtAllocator>> allocator)>>
\brief Create an OrtAllocator that can be shared across sessions for the given OrtMemoryInfo.
getter/setter pair
CreateDataTransfer ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<Pointer<OrtDataTransferImpl>> data_transfer)>>
\brief Create an OrtDataTransferImpl instance for the factory.
getter/setter pair
CreateEp ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<Pointer<OrtHardwareDevice>> devices, Pointer<Pointer<OrtKeyValuePairs>> ep_metadata_pairs, Size num_devices, Pointer<OrtSessionOptions> session_options, Pointer<OrtLogger> logger, Pointer<Pointer<OrtEp>> ep)>>
\brief Function to create an OrtEp instance for use in a Session.
getter/setter pair
CreateExternalResourceImporterForDevice ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<OrtEpDevice> ep_device, Pointer<Pointer<OrtExternalResourceImporterImpl>> out_importer)>>
\brief Create an OrtExternalResourceImporterImpl for external resource import.
getter/setter pair
CreateSyncStreamForDevice ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<OrtMemoryDevice> memory_device, Pointer<OrtKeyValuePairs> stream_options, Pointer<Pointer<OrtSyncStreamImpl>> stream)>>
\brief Create a synchronization stream for the given memory device.
getter/setter pair
GetCustomOpDomains ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<Pointer<OrtCustomOpDomain>> domains, Size num_domains)>>
\brief Gets the EP-specific OrtCustomOpDomains.
getter/setter pair
GetHardwareDeviceIncompatibilityDetails ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<OrtHardwareDevice> hw, Pointer<OrtDeviceEpIncompatibilityDetails> details)>>
\brief Check for known incompatibility reasons between a hardware device and this execution provider.
getter/setter pair
GetName ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtEpFactory> this_ptr)>>
\brief Get the name of the execution provider that the factory creates.
getter/setter pair
GetNumCustomOpDomains ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<Size> num_domains)>>
\brief Returns the number of OrtCustomOpDomains that this factory provides.
getter/setter pair
GetSupportedDevices ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<Pointer<OrtHardwareDevice>> devices, Size num_devices, Pointer<Pointer<OrtEpDevice>> ep_devices, Size max_ep_devices, Pointer<Size> num_ep_devices)>>
\brief Get information from the execution provider about OrtHardwareDevice support.
getter/setter pair
GetVendor ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtEpFactory> this_ptr)>>
return EP vendor
getter/setter pair
GetVendorId ↔ Pointer<NativeFunction<Uint32 Function(Pointer<OrtEpFactory> this_ptr)>>
\brief Get the vendor id who owns the execution provider that the factory creates.
getter/setter pair
GetVersion ↔ Pointer<NativeFunction<Pointer<Char> Function(Pointer<OrtEpFactory> this_ptr)>>
\brief Get the version of the execution provider that the factory creates.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
IsStreamAware ↔ Pointer<NativeFunction<Bool Function(Pointer<OrtEpFactory> this_ptr)>>
\brief Check if execution providers created by the factory are stream aware.
getter/setter pair
ort_version_supported ↔ int
\brief The ONNX Runtime version the execution provider was compiled with.
getter/setter pair
ReleaseAllocator ↔ Pointer<NativeFunction<Void Function(Pointer<OrtEpFactory> this_ptr, Pointer<OrtAllocator> allocator)>>
\brief Release an OrtAllocator created by the factory.
getter/setter pair
ReleaseEp ↔ Pointer<NativeFunction<Void Function(Pointer<OrtEpFactory> this_ptr, Pointer<OrtEp> ep)>>
\brief Release the OrtEp instance.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
ValidateCompiledModelCompatibilityInfo ↔ Pointer<NativeFunction<OrtStatusPtr Function(Pointer<OrtEpFactory> this_ptr, Pointer<Pointer<OrtHardwareDevice>> devices, Size num_devices, Pointer<Char> compatibility_info, Pointer<UnsignedInt> model_compatibility)>>
\brief Validate the compatibility of a compiled model with the execution provider factory for one or more devices.
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