26#include "onnxruntime_c_api.h"
27#include "onnxruntime_float16.h"
36#include <unordered_map>
41#ifdef ORT_NO_EXCEPTIONS
59 const char*
what() const noexcept
override {
return message_.c_str(); }
66#ifdef ORT_NO_EXCEPTIONS
69#ifndef ORT_CXX_API_THROW
70#define ORT_CXX_API_THROW(string, code) \
72 std::cerr << Ort::Exception(string, code) \
79#define ORT_CXX_API_THROW(string, code) \
80 throw Ort::Exception(string, code)
83#ifdef ORT_API_MANUAL_INIT
91inline void InitApi() noexcept;
108inline
void InitApi(const
OrtApi* api) noexcept;
115 static const OrtApi* Api(
const OrtApi* newValue =
nullptr)
noexcept {
132 static const OrtApi* api = DefaultInit();
143 static const OrtApi* DefaultInit()
noexcept;
145#ifdef ORT_API_MANUAL_INIT
147 friend void ::Ort::InitApi()
noexcept;
148 friend void ::Ort::InitApi(
const OrtApi*)
noexcept;
153#ifdef ORT_API_MANUAL_INIT
156inline void InitApi(
const OrtApi* api)
noexcept { detail::Global::Api(api); }
164#pragma detect_mismatch("ORT_API_MANUAL_INIT", "enabled")
167inline const OrtApi* detail::Global::DefaultInit() noexcept {
180#pragma detect_mismatch("ORT_API_MANUAL_INIT", "disabled")
183inline const OrtApi* detail::Global::DefaultInit() noexcept {
189inline const OrtApi&
GetApi() noexcept {
return *detail::Global::Api(); }
217 if (api ==
nullptr) {
219 ORT_CXX_API_THROW(
"Model Editor API is not available in this build",
ORT_FAIL);
231 if (api ==
nullptr) {
233 ORT_CXX_API_THROW(
"Compile API is not available in this build",
ORT_FAIL);
245 if (api ==
nullptr) {
247 ORT_CXX_API_THROW(
"EP API is not available in this build",
ORT_FAIL);
271struct Float16_t : onnxruntime_float16::Float16Impl<Float16_t> {
278 constexpr explicit Float16_t(uint16_t v)
noexcept { val = v; }
281 using Base = onnxruntime_float16::Float16Impl<Float16_t>;
299 explicit Float16_t(
float v)
noexcept { val = Base::ToUint16Impl(v); }
305 float ToFloat() const noexcept {
return Base::ToFloatImpl(); }
311 using Base::IsNegative;
323 using Base::IsFinite;
329 using Base::IsPositiveInfinity;
335 using Base::IsNegativeInfinity;
341 using Base::IsInfinity;
347 using Base::IsNaNOrZero;
353 using Base::IsNormal;
359 using Base::IsSubnormal;
386 explicit operator float() const noexcept {
return ToFloat(); }
388 using Base::operator==;
389 using Base::operator!=;
390 using Base::operator<;
393static_assert(
sizeof(Float16_t) ==
sizeof(uint16_t),
"Sizes must match");
413struct BFloat16_t : onnxruntime_float16::BFloat16Impl<BFloat16_t> {
422 constexpr explicit BFloat16_t(uint16_t v)
noexcept { val = v; }
425 using Base = onnxruntime_float16::BFloat16Impl<BFloat16_t>;
440 explicit BFloat16_t(
float v)
noexcept { val = Base::ToUint16Impl(v); }
446 float ToFloat() const noexcept {
return Base::ToFloatImpl(); }
452 using Base::IsNegative;
464 using Base::IsFinite;
470 using Base::IsPositiveInfinity;
476 using Base::IsNegativeInfinity;
482 using Base::IsInfinity;
488 using Base::IsNaNOrZero;
494 using Base::IsNormal;
500 using Base::IsSubnormal;
527 explicit operator float() const noexcept {
return ToFloat(); }
536static_assert(
sizeof(
BFloat16_t) ==
sizeof(uint16_t),
"Sizes must match");
547 constexpr operator uint8_t() const noexcept {
return value; }
553static_assert(
sizeof(Float8E4M3FN_t) ==
sizeof(uint8_t),
"Sizes must match");
564 constexpr operator uint8_t() const noexcept {
return value; }
570static_assert(
sizeof(Float8E4M3FNUZ_t) ==
sizeof(uint8_t),
"Sizes must match");
581 constexpr operator uint8_t() const noexcept {
return value; }
587static_assert(
sizeof(Float8E5M2_t) ==
sizeof(uint8_t),
"Sizes must match");
598 constexpr operator uint8_t() const noexcept {
return value; }
604static_assert(
sizeof(Float8E5M2FNUZ_t) ==
sizeof(uint8_t),
"Sizes must match");
609#define ORT_DEFINE_RELEASE(NAME) \
610 inline void OrtRelease(Ort##NAME* ptr) { GetApi().Release##NAME(ptr); }
612#define ORT_DEFINE_RELEASE_FROM_API_STRUCT(NAME, API_GETTER) \
613 inline void OrtRelease(Ort##NAME* ptr) { API_GETTER().Release##NAME(ptr); }
630ORT_DEFINE_RELEASE(
Op);
656#undef ORT_DEFINE_RELEASE
657#undef ORT_DEFINE_RELEASE_FROM_API_STRUCT
770struct AllocatorWithDefaultOptions;
773struct ExternalInitializerInfo;
779struct PrepackedWeightsContainer;
781struct SessionOptions;
783struct TensorRTProviderOptions;
799 explicit Status(std::nullptr_t)
noexcept {}
848 void Update(
const std::unordered_map<std::string, std::string>& options);
867 void Update(
const std::unordered_map<std::string, std::string>& options);
927 static Status Create(
const ORTCHAR_T* filepath, int64_t file_offset,
size_t byte_size,
942 void GetKeyValuePairs(std::vector<const char*>& keys, std::vector<const char*>& values)
const;
959 explicit KeyValuePairs(
const std::unordered_map<std::string, std::string>& kv_pairs);
962 void Add(
const char* key,
const char* value);
984 template <
typename U>
1019 void* get() {
return p_; }
1020 size_t size()
const {
return size_; }
1029template <
typename T>
1030struct AllocatorImpl : Base<T> {
1034 void* Alloc(
size_t size);
1035 MemoryAllocation GetAllocation(
size_t size);
1037 ConstMemoryInfo GetInfo()
const;
1043 KeyValuePairs GetStats()
const;
1074template <
typename T>
1093template <
typename T>
1112template <
typename T>
1150 const std::vector<ConstEpDevice>& ep_devices,
1151 const char* compatibility_info);
1159 explicit Env(std::nullptr_t) {}
1185 const std::unordered_map<std::string, std::string>& options,
1208 const std::vector<Value>& dst_tensors,
1339 std::unordered_map<std::string, std::string> flat_configs_;
1350template <
typename T>
1351struct ConstSessionOptionsImpl : Base<T> {
1357 std::string GetConfigEntry(
const char* config_key)
const;
1358 bool HasConfigEntry(
const char* config_key)
const;
1359 std::string GetConfigEntryOrDefault(
const char* config_key,
const std::string& def)
const;
1362template <
typename T>
1363struct SessionOptionsImpl : ConstSessionOptionsImpl<T> {
1364 using B = ConstSessionOptionsImpl<T>;
1367 SessionOptionsImpl& SetIntraOpNumThreads(
int intra_op_num_threads);
1368 SessionOptionsImpl& SetInterOpNumThreads(
int inter_op_num_threads);
1370 SessionOptionsImpl& SetDeterministicCompute(
bool value);
1372 SessionOptionsImpl& EnableCpuMemArena();
1373 SessionOptionsImpl& DisableCpuMemArena();
1375 SessionOptionsImpl& SetOptimizedModelFilePath(
const ORTCHAR_T* optimized_model_file);
1377 SessionOptionsImpl& EnableProfiling(
const ORTCHAR_T* profile_file_prefix);
1378 SessionOptionsImpl& DisableProfiling();
1380 SessionOptionsImpl& EnableOrtCustomOps();
1382 SessionOptionsImpl& EnableMemPattern();
1383 SessionOptionsImpl& DisableMemPattern();
1385 SessionOptionsImpl& SetExecutionMode(
ExecutionMode execution_mode);
1387 SessionOptionsImpl& SetLoadCancellationFlag(
bool value);
1389 SessionOptionsImpl& SetLogId(
const char* logid);
1390 SessionOptionsImpl& SetLogSeverityLevel(
int level);
1394 SessionOptionsImpl& DisablePerSessionThreads();
1396 SessionOptionsImpl& AddConfigEntry(
const char* config_key,
const char* config_value);
1398 SessionOptionsImpl& AddInitializer(
const char* name,
const OrtValue* ort_val);
1399 SessionOptionsImpl& AddExternalInitializers(
const std::vector<std::string>& names,
const std::vector<Value>& ort_values);
1400 SessionOptionsImpl& AddExternalInitializersFromFilesInMemory(
const std::vector<std::basic_string<ORTCHAR_T>>& external_initializer_file_names,
1401 const std::vector<char*>& external_initializer_file_buffer_array,
1402 const std::vector<size_t>& external_initializer_file_lengths);
1404 SessionOptionsImpl& AppendExecutionProvider_CPU(
int use_arena);
1410 SessionOptionsImpl& AppendExecutionProvider_OpenVINO_V2(
const std::unordered_map<std::string, std::string>& provider_options = {});
1419 SessionOptionsImpl& AppendExecutionProvider(
const std::string& provider_name,
1420 const std::unordered_map<std::string, std::string>& provider_options = {});
1424 SessionOptionsImpl& AppendExecutionProvider_V2(Env& env,
const std::vector<ConstEpDevice>& ep_devices,
1425 const KeyValuePairs& ep_options);
1428 SessionOptionsImpl& AppendExecutionProvider_V2(Env& env,
const std::vector<ConstEpDevice>& ep_devices,
1429 const std::unordered_map<std::string, std::string>& ep_options);
1435 SessionOptionsImpl& SetEpSelectionPolicy(
EpSelectionDelegate delegate,
void* state =
nullptr);
1438 SessionOptionsImpl& SetCustomThreadCreationOptions(
void* ort_custom_thread_creation_options);
1444 SessionOptionsImpl& RegisterCustomOpsLibrary(
const ORTCHAR_T* library_name,
const CustomOpConfigs& custom_op_configs = {});
1446 SessionOptionsImpl& RegisterCustomOpsUsingFunction(
const char* function_name);
1449 SessionOptionsImpl& AppendExecutionProvider_VitisAI(
const std::unordered_map<std::string, std::string>& provider_options = {});
1452 SessionOptionsImpl& AddFreeDimensionOverride(
const char* dim_denotation, int64_t dim_value);
1455 SessionOptionsImpl& AddFreeDimensionOverrideByName(
const char* dim_name, int64_t dim_value);
1488 size_t input_model_data_size);
1492 size_t initializer_size_threshold);
1500 size_t* output_model_buffer_size_ptr);
1506 const ORTCHAR_T* model_name);
1597template <
typename T>
1655template <
typename T>
1677 std::vector<Value>
Run(
const RunOptions& run_options,
const char*
const* input_names,
const Value* input_values,
size_t input_count,
1678 const char*
const* output_names,
size_t output_count);
1683 void Run(
const RunOptions& run_options,
const char*
const* input_names,
const Value* input_values,
size_t input_count,
1684 const char*
const* output_names,
Value* output_values,
size_t output_count);
1708 const char*
const* output_names,
Value* output_values,
size_t output_count,
RunAsyncCallbackFn callback,
void* user_data);
1761#if !defined(ORT_MINIMAL_BUILD)
1778template <
typename T>
1792 [[deprecated(
"use GetShape()")]]
void GetDimensions(int64_t* values,
size_t values_count)
const;
1821 const std::vector<int64_t>& dims,
1822 const std::vector<std::string>* symbolic_dims =
nullptr);
1828template <
typename T>
1852template <
typename T>
1865template <
typename T>
1890template <
typename T>
1922#if !defined(ORT_MINIMAL_BUILD)
1958template <
typename T>
1966 template <
typename R>
2005 template <
typename R>
2070#if !defined(DISABLE_SPARSE_TENSORS)
2104 template <
typename R>
2121 template <
typename R>
2127template <
typename T>
2137 template <
typename R>
2153 template <
typename R>
2154 R&
At(
const std::vector<int64_t>& location);
2184#if !defined(DISABLE_SPARSE_TENSORS)
2205 void UseCsrIndices(int64_t* inner_data,
size_t inner_num, int64_t* outer_data,
size_t outer_num);
2227 const int64_t* indices_data,
size_t indices_num);
2242 const int64_t* inner_indices_data,
size_t inner_indices_num,
2243 const int64_t* outer_indices_data,
size_t outer_indices_num);
2256 const Shape& indices_shape,
2257 const int32_t* indices_data);
2291 template <
typename T>
2293 const int64_t* shape,
size_t shape_len);
2305 const int64_t* shape,
size_t shape_len,
2318 const int64_t* shape,
size_t shape_len,
2332 template <
typename T>
2376 template <
typename T>
2379#if !defined(DISABLE_SPARSE_TENSORS)
2390 template <
typename T>
2392 const Shape& values_shape);
2422 template <
typename T>
2442namespace binding_utils {
2448template <
typename T>
2459template <
typename T>
2502 ArenaCfg(
size_t max_mem,
int arena_extend_strategy,
int initial_chunk_size_bytes,
int max_dead_bytes_per_chunk);
2508 explicit ArenaCfg(
const std::unordered_map<std::string, size_t>& arena_config);
2517template <
typename T>
2530 template <
typename R>
2534 template <
typename R>
2565#define ORT_CXX_LOG(logger, message_severity, message) \
2567 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2568 Ort::ThrowOnError(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
2569 static_cast<const char*>(__FUNCTION__), message)); \
2581#define ORT_CXX_LOG_NOEXCEPT(logger, message_severity, message) \
2583 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2584 static_cast<void>(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
2585 static_cast<const char*>(__FUNCTION__), message)); \
2600#define ORT_CXX_LOGF(logger, message_severity, ...) \
2602 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2603 Ort::ThrowOnError(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
2604 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
2619#define ORT_CXX_LOGF_NOEXCEPT(logger, message_severity, ...) \
2621 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2622 static_cast<void>(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
2623 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
2684 const
char* func_name, const
char* message) const noexcept;
2700 template <typename... Args>
2702 const
char* func_name, const
char* format, Args&&... args) const noexcept;
2730 void ParallelFor(
void (*fn)(
void*,
size_t),
size_t total,
size_t num_batch,
void* usr_data)
const;
2739namespace attr_utils {
2740void GetAttr(
const OrtKernelInfo* p,
const char* name,
float&);
2741void GetAttr(
const OrtKernelInfo* p,
const char* name, int64_t&);
2742void GetAttr(
const OrtKernelInfo* p,
const char* name, std::string&);
2743void GetAttrs(
const OrtKernelInfo* p,
const char* name, std::vector<float>&);
2744void GetAttrs(
const OrtKernelInfo* p,
const char* name, std::vector<int64_t>&);
2747template <
typename T>
2748struct KernelInfoImpl :
Base<T> {
2754 template <
typename R>
2755 R GetAttribute(
const char* name)
const {
2757 attr_utils::GetAttr(this->p_, name, val);
2761 template <
typename R>
2762 std::vector<R> GetAttributes(
const char* name)
const {
2763 std::vector<R> result;
2764 attr_utils::GetAttrs(this->p_, name, result);
2768 Value GetTensorAttribute(
const char* name,
OrtAllocator* allocator)
const;
2770 size_t GetInputCount()
const;
2771 size_t GetOutputCount()
const;
2773 std::string GetInputName(
size_t index)
const;
2774 std::string GetOutputName(
size_t index)
const;
2776 TypeInfo GetInputTypeInfo(
size_t index)
const;
2777 TypeInfo GetOutputTypeInfo(
size_t index)
const;
2779 ConstValue GetTensorConstantInput(
size_t index,
int* is_constant)
const;
2781 std::string GetNodeName()
const;
2782 Logger GetLogger()
const;
2784 KeyValuePairs GetConfigEntries()
const;
2786 std::string GetOperatorDomain()
const;
2787 std::string GetOperatorType()
const;
2788 int GetOperatorSinceVersion()
const;
2789 const OrtEp* GetEp()
const;
2803 using Base = detail::KernelInfoImpl<OrtKernelInfo>;
2817 explicit Op(std::nullptr_t) {}
2822 int version,
const char** type_constraint_names,
2824 size_t type_constraint_count,
2825 const OpAttr* attr_values,
2827 size_t input_count,
size_t output_count);
2830 const Value* input_values,
2832 Value* output_values,
2833 size_t output_count);
2837 const OrtValue*
const* input_values,
2840 size_t output_count);
2857 if (is_int_ == dim.is_int_) {
2859 return i_ == dim.
i_;
2861 return std::string{s_} == std::string{dim.
s_};
2869 const char*
AsSym()
const {
return s_; }
2871 static constexpr int INVALID_INT_DIM = -2;
2881 using Shape = std::vector<SymbolicInteger>;
2907 ConstOpAttr GetAttrHdl(
const char* attr_name)
const;
2910 std::vector<Shape> input_shapes_;
2915#define MAX_CUSTOM_OP_END_VER (1UL << 31) - 1
2917template <
typename TOp,
typename TKernel,
bool WithStatus = false>
2932#if defined(_MSC_VER) && !defined(__clang__)
2933#pragma warning(push)
2934#pragma warning(disable : 26409)
2937#if defined(_MSC_VER) && !defined(__clang__)
2947#ifdef __cpp_if_constexpr
2948 if constexpr (WithStatus) {
2953 return static_cast<const TOp*
>(this_)->CreateKernelV2(*api, info, op_kernel);
2956 return static_cast<TKernel*
>(op_kernel)->ComputeV2(context);
2964 static_cast<TKernel*
>(op_kernel)->Compute(context);
2968 SetShapeInferFn<TOp>(0);
2971 return static_cast<const TOp*
>(this_)->start_ver_;
2975 return static_cast<const TOp*
>(this_)->end_ver_;
2990 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
2994 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
3030 return std::vector<std::string>{};
3036 template <
typename C>
3040 return C::InferOutputShape(ctx);
3045 template <
typename C>
3055 int end_ver_ = MAX_CUSTOM_OP_END_VER;
3063template <
typename T>
3105#if !defined(ORT_MINIMAL_BUILD)
3113struct AttrNameSubgraph;
3117template <
typename T>
3118struct ConstGraphImpl;
3120template <
typename T>
3167#if !defined(ORT_MINIMAL_BUILD)
3168 Node(
const std::string& operator_name,
const std::string& operator_domain,
3169 const std::string& node_name,
3170 const std::vector<std::string>& input_names,
3171 const std::vector<std::string>& output_names);
3176 Node(
const std::string& operator_name,
const std::string& operator_domain,
3177 const std::string& node_name,
3178 const std::vector<std::string>& input_names,
3179 const std::vector<std::string>& output_names,
3180 std::vector<OpAttr>& attributes);
3183 static void Init(
const std::string& operator_name,
const std::string& operator_domain,
3184 const std::string& node_name,
3185 const std::vector<std::string>& input_names,
3186 const std::vector<std::string>& output_names,
3187 std::vector<OpAttr>& attributes,
3208template <
typename T>
3237template <
typename T>
3242#if !defined(ORT_MINIMAL_BUILD)
3270#if !defined(ORT_MINIMAL_BUILD)
3277template <
typename T>
3282#if !defined(ORT_MINIMAL_BUILD)
3301#if !defined(ORT_MINIMAL_BUILD)
3303 explicit Model(
const std::vector<DomainOpsetPair>& opsets);
3308template <
typename T>
3340 explicit KernelDef(OrtKernelDef* p) : detail::ConstKernelDefImpl<OrtKernelDef>{p} {}
3364 const std::vector<int>& output_indices);
3367 const std::vector<int>& output_indices);
3388 void* kernel_create_func_state);
3392template <
typename T>
3420#include "onnxruntime_cxx_inline.h"
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:296
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:450
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:324
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:246
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:485
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:321
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:414
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:938
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:6687
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:313
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:310
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:304
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:323
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:317
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:235
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:312
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:298
OrtCompiledModelCompatibility
The C API.
Definition onnxruntime_c_api.h:961
OrtStatus *(* EpSelectionDelegate)(const OrtEpDevice **ep_devices, size_t num_devices, const OrtKeyValuePairs *model_metadata, const OrtKeyValuePairs *runtime_metadata, const OrtEpDevice **selected, size_t max_selected, size_t *num_selected, void *state)
Delegate to allow providing custom OrtEpDevice selection logic.
Definition onnxruntime_c_api.h:529
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:307
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:297
struct OrtExternalInitializerInfo OrtExternalInitializerInfo
Definition onnxruntime_c_api.h:332
OrtAllocatorType
Definition onnxruntime_c_api.h:456
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:318
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:301
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:302
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:315
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:452
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:316
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:329
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:949
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:492
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:326
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:325
struct OrtSyncStream OrtSyncStream
Definition onnxruntime_c_api.h:331
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:306
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:478
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:299
OrtStatus *(* OrtWriteBufferFunc)(void *state, const void *buffer, size_t buffer_num_bytes)
Function called by ORT to write a buffer to a custom destination (e.g., file, stream,...
Definition onnxruntime_c_api.h:548
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:423
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:330
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:337
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:466
OrtSparseFormat
Definition onnxruntime_c_api.h:227
ONNXType
Definition onnxruntime_c_api.h:215
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:294
OrtErrorCode
Definition onnxruntime_c_api.h:254
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:295
OrtStatus *(* OrtGetInitializerLocationFunc)(void *state, const char *initializer_name, const OrtValue *initializer_value, const OrtExternalInitializerInfo *external_info, OrtExternalInitializerInfo **new_external_info)
Function called by ORT to allow user to specify how an initializer should be saved,...
Definition onnxruntime_c_api.h:582
#define ORT_API_VERSION
The API version defined in this header.
Definition onnxruntime_c_api.h:41
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:320
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:303
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:311
ExecutionMode
Definition onnxruntime_c_api.h:431
OrtOpAttrType
Definition onnxruntime_c_api.h:272
OrtCustomThreadHandle(* OrtCustomCreateThreadFn)(void *ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void *ort_worker_fn_param)
Ort custom thread creation function.
Definition onnxruntime_c_api.h:931
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:184
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:500
const OrtApiBase * OrtGetApiBase(void)
The Onnxruntime library's entry point to access the C API.
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:249
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:474
@ ORT_FAIL
Definition onnxruntime_c_api.h:256
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:186
std::vector< Value > GetOutputValuesHelper(const OrtIoBinding *binding, OrtAllocator *)
std::vector< std::string > GetOutputNamesHelper(const OrtIoBinding *binding, OrtAllocator *)
void OrtRelease(OrtAllocator *ptr)
Definition onnxruntime_cxx_api.h:615
std::string MakeCustomOpConfigEntryKey(const char *custom_op_name, const char *config)
All C++ Onnxruntime APIs are defined inside this namespace.
Definition onnxruntime_cxx_api.h:48
const OrtModelEditorApi & GetModelEditorApi()
This returns a reference to the ORT C Model Editor API. Used if building or augmenting a model at run...
Definition onnxruntime_cxx_api.h:215
std::unique_ptr< char, detail::AllocatedFree > AllocatedStringPtr
unique_ptr typedef used to own strings allocated by OrtAllocators and release them at the end of the ...
Definition onnxruntime_cxx_api.h:791
detail::ConstSessionOptionsImpl< detail::Unowned< const OrtSessionOptions > > ConstSessionOptions
Definition onnxruntime_cxx_api.h:1460
detail::KernelInfoImpl< detail::Unowned< const OrtKernelInfo > > ConstKernelInfo
Definition onnxruntime_cxx_api.h:2794
const OrtApi & GetApi() noexcept
This returns a reference to the ORT C API.
Definition onnxruntime_cxx_api.h:189
const OrtCompileApi & GetCompileApi()
This returns a reference to the ORT C Compile API. Used if compiling a model at runtime.
Definition onnxruntime_cxx_api.h:229
detail::AllocatorImpl< detail::Unowned< OrtAllocator > > UnownedAllocator
Definition onnxruntime_cxx_api.h:1067
OrtCompiledModelCompatibility GetModelCompatibilityForEpDevices(const std::vector< ConstEpDevice > &ep_devices, const char *compatibility_info)
Validate a compiled model's compatibility for one or more EP devices.
detail::SessionOptionsImpl< detail::Unowned< OrtSessionOptions > > UnownedSessionOptions
Definition onnxruntime_cxx_api.h:1459
std::string GetBuildInfoString()
This function returns the onnxruntime build information: including git branch, git commit id,...
const OrtEpApi & GetEpApi()
This returns a reference to the ORT C EP API. Used if authoring a plugin execution provider.
Definition onnxruntime_cxx_api.h:243
std::string GetVersionString()
This function returns the onnxruntime version string.
std::vector< std::string > GetAvailableProviders()
This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representin...
Ort::Status(*)(Ort::ShapeInferContext &) ShapeInferFn
Definition onnxruntime_cxx_api.h:2913
Status CompileModel(const Env &env, const ModelCompilationOptions &model_compilation_options)
Compiles an input model to generate a model with EPContext nodes that execute EP-specific kernels....
Wrapper around OrtAllocator.
Definition onnxruntime_cxx_api.h:1059
Allocator(const Session &session, const OrtMemoryInfo *)
Take ownership of a pointer created by C API.
Allocator(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1060
Allocator(OrtAllocator *p)
Definition onnxruntime_cxx_api.h:1064
Wrapper around OrtAllocator default instance that is owned by Onnxruntime.
Definition onnxruntime_cxx_api.h:1050
AllocatorWithDefaultOptions(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1051
AllocatorWithDefaultOptions()
it is a structure that represents the configuration of an arena based allocator
Definition onnxruntime_cxx_api.h:2492
ArenaCfg(std::nullptr_t)
Create an empty ArenaCfg object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2493
ArenaCfg(const std::unordered_map< std::string, size_t > &arena_config)
ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk)
Definition onnxruntime_cxx_api.h:3259
ConstGraph sub_graph
Definition onnxruntime_cxx_api.h:3261
std::string attr_name
Definition onnxruntime_cxx_api.h:3260
bfloat16 (Brain Floating Point) data type
Definition onnxruntime_cxx_api.h:413
bool operator==(const BFloat16_t &rhs) const noexcept
onnxruntime_float16::BFloat16Impl< BFloat16_t > Base
Definition onnxruntime_cxx_api.h:425
static constexpr BFloat16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of bfloat16.
Definition onnxruntime_cxx_api.h:434
bool operator!=(const BFloat16_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:532
BFloat16_t(float v) noexcept
__ctor from float. Float is converted into bfloat16 16-bit representation.
Definition onnxruntime_cxx_api.h:440
float ToFloat() const noexcept
Converts bfloat16 to float.
Definition onnxruntime_cxx_api.h:446
bool operator<(const BFloat16_t &rhs) const noexcept
The CUDAProviderOptions (V2)
Definition onnxruntime_cxx_api.h:862
CUDAProviderOptions()
Wraps OrtApi::CreateCUDAProviderOptions.
CUDAProviderOptions(std::nullptr_t)
Definition onnxruntime_cxx_api.h:863
void UpdateWithValue(const char *key, void *value)
Wrapper around OrtApi::GetCUDAProviderOptionsByName.
std::string GetCUDAProviderOptionsAsString() const
Wrapper around OrtApi::UpdateCUDAProviderOptionsWithValue.
void Update(const std::unordered_map< std::string, std::string > &options)
Wrapper around OrtApi::GetCUDAProviderOptionsAsString.
void * GetOptionByName(const char *name) const
Definition onnxruntime_cxx_api.h:2918
OrtCustomOpInputOutputCharacteristic GetOutputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:2993
OrtCustomOpInputOutputCharacteristic GetInputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:2989
OrtMemType GetInputMemoryType(size_t) const
Definition onnxruntime_cxx_api.h:2998
std::vector< std::string > GetSessionConfigKeys() const
Definition onnxruntime_cxx_api.h:3029
bool GetVariadicInputHomogeneity() const
Definition onnxruntime_cxx_api.h:3010
int GetVariadicInputMinArity() const
Definition onnxruntime_cxx_api.h:3004
void SetShapeInferFn(...)
Definition onnxruntime_cxx_api.h:3046
CustomOpBase()
Definition onnxruntime_cxx_api.h:2919
bool GetVariadicOutputHomogeneity() const
Definition onnxruntime_cxx_api.h:3022
int GetVariadicOutputMinArity() const
Definition onnxruntime_cxx_api.h:3016
decltype(&C::InferOutputShape) SetShapeInferFn(decltype(&C::InferOutputShape))
Definition onnxruntime_cxx_api.h:3037
const char * GetExecutionProviderType() const
Definition onnxruntime_cxx_api.h:2985
void GetSessionConfigs(std::unordered_map< std::string, std::string > &out, ConstSessionOptions options) const
Class that represents session configuration entries for one or more custom operators.
Definition onnxruntime_cxx_api.h:1310
~CustomOpConfigs()=default
CustomOpConfigs & AddConfig(const char *custom_op_name, const char *config_key, const char *config_value)
Adds a session configuration entry/value for a specific custom operator.
CustomOpConfigs & operator=(CustomOpConfigs &&o)=default
CustomOpConfigs(CustomOpConfigs &&o)=default
CustomOpConfigs()=default
const std::unordered_map< std::string, std::string > & GetFlattenedConfigs() const
Returns a flattened map of custom operator configuration entries and their values.
CustomOpConfigs(const CustomOpConfigs &)=default
CustomOpConfigs & operator=(const CustomOpConfigs &)=default
Custom Op Domain.
Definition onnxruntime_cxx_api.h:1215
CustomOpDomain(std::nullptr_t)
Create an empty CustomOpDomain object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1219
CustomOpDomain(const char *domain)
Wraps OrtApi::CreateCustomOpDomain.
void Add(const OrtCustomOp *op)
Wraps CustomOpDomain_Add.
The Env (Environment)
Definition onnxruntime_cxx_api.h:1158
Env & EnableTelemetryEvents()
Wraps OrtApi::EnableTelemetryEvents.
Env(OrtEnv *p)
C Interop Helper.
Definition onnxruntime_cxx_api.h:1175
Env & CreateAndRegisterAllocatorV2(const std::string &provider_type, const OrtMemoryInfo *mem_info, const std::unordered_map< std::string, std::string > &options, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocatorV2.
Env & UnregisterExecutionProviderLibrary(const char *registration_name)
Wraps OrtApi::UnregisterExecutionProviderLibrary.
std::vector< ConstEpDevice > GetEpDevices() const
Env & UnregisterAllocator(const OrtMemoryInfo *mem_info)
Wraps OrtApi::UnregisterAllocator.
Env(std::nullptr_t)
Create an empty Env object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1159
Env(OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnv.
Env(const OrtThreadingOptions *tp_options, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnvWithGlobalThreadPools.
Env(const OrtThreadingOptions *tp_options, OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools.
Env & RegisterAllocator(OrtAllocator *allocator)
Wraps OrtApi::RegisterAllocator.
UnownedAllocator CreateSharedAllocator(const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type, OrtAllocatorType allocator_type, const OrtKeyValuePairs *allocator_options)
Wraps OrtApi::CreateSharedAllocator.
Env(OrtLoggingLevel logging_level, const char *logid, OrtLoggingFunction logging_function, void *logger_param)
Wraps OrtApi::CreateEnvWithCustomLogger.
Env & CreateAndRegisterAllocator(const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocator.
UnownedAllocator GetSharedAllocator(const OrtMemoryInfo *mem_info)
Wraps OrtApi::GetSharedAllocator.
Env & RegisterExecutionProviderLibrary(const char *registration_name, const std::basic_string< char > &path)
Wraps OrtApi::RegisterExecutionProviderLibrary.
Env & UpdateEnvWithCustomLogLevel(OrtLoggingLevel log_severity_level)
Wraps OrtApi::UpdateEnvWithCustomLogLevel.
Status CopyTensors(const std::vector< Value > &src_tensors, const std::vector< Value > &dst_tensors, OrtSyncStream *stream) const
Wraps OrtApi::CopyTensors.
void ReleaseSharedAllocator(const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type)
Wraps OrtApi::ReleaseSharedAllocator.
Env & DisableTelemetryEvents()
Wraps OrtApi::DisableTelemetryEvents.
Mutable EpDevice that is created by EpApi users.
Definition onnxruntime_cxx_api.h:1134
EpDevice(OrtEpDevice *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:1136
EpDevice(OrtEpFactory &ep_factory, ConstHardwareDevice &hardware_device, ConstKeyValuePairs ep_metadata={}, ConstKeyValuePairs ep_options={})
Wraps OrtEpApi::CreateEpDevice.
EpDevice(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1135
All C++ methods that can fail will throw an exception of this type.
Definition onnxruntime_cxx_api.h:54
const char * what() const noexcept override
Definition onnxruntime_cxx_api.h:59
Exception(const std::string &string, OrtErrorCode code)
Definition onnxruntime_cxx_api.h:55
OrtErrorCode GetOrtErrorCode() const
Definition onnxruntime_cxx_api.h:58
Exception(std::string &&string, OrtErrorCode code)
Definition onnxruntime_cxx_api.h:56
Wrapper around OrtExternalInitializerInfo.
Definition onnxruntime_cxx_api.h:913
ConstExternalInitializerInfo GetConst() const
Wraps OrtApi::CreateExternalInitializerInfo.
Definition onnxruntime_cxx_api.h:921
ExternalInitializerInfo(const char *filepath, int64_t file_offset, size_t byte_size)
Wrapper around CreateExternalInitializerInfo that does not throw an exception.
ExternalInitializerInfo(std::nullptr_t)
Definition onnxruntime_cxx_api.h:917
ExternalInitializerInfo(OrtExternalInitializerInfo *p)
Definition onnxruntime_cxx_api.h:918
static Status Create(const char *filepath, int64_t file_offset, size_t byte_size, ExternalInitializerInfo &out)
IEEE 754 half-precision floating point data type.
Definition onnxruntime_cxx_api.h:271
Float16_t()=default
Default constructor.
Float16_t(float v) noexcept
__ctor from float. Float is converted into float16 16-bit representation.
Definition onnxruntime_cxx_api.h:299
onnxruntime_float16::Float16Impl< Float16_t > Base
Definition onnxruntime_cxx_api.h:281
float ToFloat() const noexcept
Converts float16 to float.
Definition onnxruntime_cxx_api.h:305
static constexpr Float16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of float16.
Definition onnxruntime_cxx_api.h:293
float8e4m3fn (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:543
uint8_t value
Definition onnxruntime_cxx_api.h:544
constexpr Float8E4M3FN_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:546
constexpr bool operator==(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:549
constexpr Float8E4M3FN_t() noexcept
Definition onnxruntime_cxx_api.h:545
constexpr bool operator!=(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:550
float8e4m3fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:560
constexpr bool operator==(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:566
uint8_t value
Definition onnxruntime_cxx_api.h:561
constexpr Float8E4M3FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:562
constexpr bool operator!=(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:567
constexpr Float8E4M3FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:563
float8e5m2 (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:577
constexpr Float8E5M2_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:580
uint8_t value
Definition onnxruntime_cxx_api.h:578
constexpr bool operator!=(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:584
constexpr Float8E5M2_t() noexcept
Definition onnxruntime_cxx_api.h:579
constexpr bool operator==(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:583
float8e5m2fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:594
constexpr Float8E5M2FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:596
constexpr Float8E5M2FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:597
constexpr bool operator!=(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:601
constexpr bool operator==(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:600
uint8_t value
Definition onnxruntime_cxx_api.h:595
Wrapper around OrtGraph.
Definition onnxruntime_cxx_api.h:3267
Graph(OrtGraph *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3269
Graph(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:3268
Wrapper around OrtIoBinding.
Definition onnxruntime_cxx_api.h:2481
UnownedIoBinding GetUnowned() const
Definition onnxruntime_cxx_api.h:2485
ConstIoBinding GetConst() const
Definition onnxruntime_cxx_api.h:2484
IoBinding(Session &session)
IoBinding(std::nullptr_t)
Create an empty object for convenience. Sometimes, we want to initialize members later.
Definition onnxruntime_cxx_api.h:2482
This class wraps a raw pointer OrtKernelContext* that is being passed to the custom kernel Compute() ...
Definition onnxruntime_cxx_api.h:2715
KernelContext(OrtKernelContext *context)
ConstValue GetInput(size_t index) const
OrtKernelContext * GetOrtKernelContext() const
Definition onnxruntime_cxx_api.h:2729
void ParallelFor(void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data) const
void * GetGPUComputeStream() const
size_t GetInputCount() const
Ort::Allocator GetAllocator(const OrtMemoryInfo &memory_info) const
size_t GetOutputCount() const
UnownedValue GetOutput(size_t index, const std::vector< int64_t > &dims) const
UnownedValue GetOutput(size_t index, const int64_t *dim_values, size_t dim_count) const
Builder for OrtKernelDef.
Definition onnxruntime_cxx_api.h:3349
KernelDefBuilder & AddTypeConstraint(const char *arg_name, const OrtDataType *data_type)
KernelDefBuilder & SetOutputMemType(size_t output_index, OrtMemType mem_type)
KernelDefBuilder & AddInputOutputMutableAliases(const std::vector< int > &input_indices, const std::vector< int > &output_indices)
KernelDefBuilder & SetInputMemType(size_t input_index, OrtMemType mem_type)
KernelDefBuilder & SetDomain(const char *domain)
KernelDefBuilder & AddInputOutputAliases(const std::vector< int > &input_indices, const std::vector< int > &output_indices)
KernelDefBuilder & AddInputOutputAlias(int input_index, int output_index)
KernelDefBuilder & SetExecutionProvider(const char *ep_name)
KernelDefBuilder & SetOperatorType(const char *op_type)
KernelDefBuilder & AddInputOutputMutableAlias(int input_index, int output_index)
KernelDefBuilder()
Wraps OrtEpApi::CreateKernelDefBuilder.
KernelDefBuilder & AddTypeConstraint(const char *arg_name, const std::vector< const OrtDataType * > &data_types)
KernelDefBuilder(std::nullptr_t)
Create an empty object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:3351
KernelDefBuilder(OrtKernelDefBuilder *ort_kernel_def_builder)
KernelDefBuilder & SetSinceVersion(int since_version_start, int since_version_end)
Definition onnxruntime_cxx_api.h:3335
KernelDef(OrtKernelDef *p)
Definition onnxruntime_cxx_api.h:3340
KernelDef(std::nullptr_t)
Definition onnxruntime_cxx_api.h:3339
ConstKernelDef GetConst() const
Definition onnxruntime_cxx_api.h:3342
This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelIn...
Definition onnxruntime_cxx_api.h:2802
KernelInfo(OrtKernelInfo *info)
Take ownership of the instance.
ConstKernelInfo GetConst() const
Definition onnxruntime_cxx_api.h:2807
detail::KernelInfoImpl< OrtKernelInfo > Base
Definition onnxruntime_cxx_api.h:2803
KernelInfo(std::nullptr_t)
Create an empty instance to initialize later.
Definition onnxruntime_cxx_api.h:2805
Registry for kernels supported by an EP.
Definition onnxruntime_cxx_api.h:3376
KernelRegistry()
< Wrapper around OrtEpApi::CreateKernelRegistry
KernelRegistry(std::nullptr_t)
Take ownership of a pointer created with the C API.
Definition onnxruntime_cxx_api.h:3381
Status AddKernel(const OrtKernelDef *kernel_def, OrtKernelCreateFunc kernel_create_func, void *kernel_create_func_state)
KernelRegistry(OrtKernelRegistry *ort_kernel_registry)
Wraps KernelRegistry_AddKernel.
Wrapper around OrtKeyValuePairs.
Definition onnxruntime_cxx_api.h:950
KeyValuePairs()
Wraps OrtApi::CreateKeyValuePairs.
void Add(const char *key, const char *value)
Wraps OrtApi::AddKeyValuePair.
KeyValuePairs(const std::unordered_map< std::string, std::string > &kv_pairs)
Wraps OrtApi::CreateKeyValuePairs and OrtApi::AddKeyValuePair.
void Remove(const char *key)
Wraps OrtApi::RemoveKeyValuePair.
KeyValuePairs(std::nullptr_t)
Definition onnxruntime_cxx_api.h:951
ConstKeyValuePairs GetConst() const
Definition onnxruntime_cxx_api.h:967
KeyValuePairs(OrtKeyValuePairs *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:953
This class represents an ONNX Runtime logger that can be used to log information with an associated s...
Definition onnxruntime_cxx_api.h:2637
Logger(Logger &&v) noexcept=default
Logger & operator=(Logger &&v) noexcept=default
Logger & operator=(const Logger &)=default
Logger(const Logger &)=default
Logger(std::nullptr_t)
Definition onnxruntime_cxx_api.h:2646
Logger(const OrtLogger *logger)
OrtLoggingLevel GetLoggingSeverityLevel() const noexcept
LoraAdapter holds a set of Lora Parameters loaded from a single file.
Definition onnxruntime_cxx_api.h:1229
static LoraAdapter CreateLoraAdapter(const std::basic_string< char > &adapter_path, OrtAllocator *allocator)
Wraps OrtApi::CreateLoraAdapter.
LoraAdapter(std::nullptr_t)
Definition onnxruntime_cxx_api.h:1233
static LoraAdapter CreateLoraAdapterFromArray(const void *bytes, size_t num_bytes, OrtAllocator *allocator)
Wraps OrtApi::CreateLoraAdapterFromArray.
Wrapper around OrtMapTypeInfo.
Definition onnxruntime_cxx_api.h:1880
ConstMapTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1886
MapTypeInfo(OrtMapTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1885
MapTypeInfo(std::nullptr_t)
Create an empty MapTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1884
Represents native memory allocation coming from one of the OrtAllocators registered with OnnxRuntime....
Definition onnxruntime_cxx_api.h:1011
MemoryAllocation(MemoryAllocation &&) noexcept
MemoryAllocation & operator=(const MemoryAllocation &)=delete
MemoryAllocation(const MemoryAllocation &)=delete
MemoryAllocation(OrtAllocator *allocator, void *p, size_t size)
size_t size() const
Definition onnxruntime_cxx_api.h:1020
Wrapper around OrtMemoryInfo.
Definition onnxruntime_cxx_api.h:995
MemoryInfo(const char *name, OrtAllocatorType type, int id, OrtMemType mem_type)
MemoryInfo(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:997
MemoryInfo(OrtMemoryInfo *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:998
static MemoryInfo CreateCpu(OrtAllocatorType type, OrtMemType mem_type1)
ConstMemoryInfo GetConst() const
Definition onnxruntime_cxx_api.h:1002
MemoryInfo(const char *name, OrtMemoryInfoDeviceType device_type, uint32_t vendor_id, uint32_t device_id, OrtDeviceMemoryType mem_type, size_t alignment, OrtAllocatorType allocator_type)
Wrapper around CreateMemoryInfo_V2.
Options object used when compiling a model.
Definition onnxruntime_cxx_api.h:1477
ModelCompilationOptions & SetOutputModelWriteFunc(OrtWriteBufferFunc write_func, void *state)
ModelCompilationOptions & SetEpContextEmbedMode(bool embed_ep_context_in_model)
Wraps OrtApi::ModelCompilationOptions_SetEpContextEmbedMode.
ModelCompilationOptions & SetInputModelFromBuffer(const void *input_model_data, size_t input_model_data_size)
Wraps OrtApi::ModelCompilationOptions_SetInputModelFromBuffer.
ModelCompilationOptions & SetOutputModelBuffer(OrtAllocator *allocator, void **output_model_buffer_ptr, size_t *output_model_buffer_size_ptr)
Wraps OrtApi::ModelCompilationOptions_SetOutputModelBuffer.
ModelCompilationOptions & SetFlags(uint32_t flags)
Wraps OrtApi::ModelCompilationOptions_SetFlags.
ModelCompilationOptions & SetOutputModelExternalInitializersFile(const char *file_path, size_t initializer_size_threshold)
Wraps OrtApi::ModelCompilationOptions_SetOutputModelExternalInitializersFile.
ModelCompilationOptions(std::nullptr_t)
Create an empty ModelCompilationOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1481
ModelCompilationOptions(const Env &env, ConstSessionOptions session_options)
Wraps OrtApi::CreateModelCompilationOptionsFromSessionOptions.
ModelCompilationOptions & SetOutputModelPath(const char *output_model_path)
Wraps OrtApi::ModelCompilationOptions_SetOutputModelPath.
ModelCompilationOptions & SetInputModelPath(const char *input_model_path)
Wraps OrtApi::ModelCompilationOptions_SetInputModelPath.
ModelCompilationOptions & SetOutputModelGetInitializerLocationFunc(OrtGetInitializerLocationFunc get_initializer_location_func, void *state)
ModelCompilationOptions & SetEpContextBinaryInformation(const char *output_directory, const char *model_name)
Wraps OrtApi::ModelCompilationOptions_SetEpContextBinaryInformation.
ModelCompilationOptions & SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level)
Wraps OrtApi::ModelCompilationOptions_SetGraphOptimizationLevel.
ModelCompilationOptions(const Env &env, const SessionOptions &session_options)
Wraps OrtApi::CreateModelCompilationOptionsFromSessionOptions.
Wrapper around OrtModel.
Definition onnxruntime_cxx_api.h:3295
Model(const std::vector< DomainOpsetPair > &opsets)
Model(OrtModel *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3299
std::pair< std::string, int > DomainOpsetPair
Definition onnxruntime_cxx_api.h:3296
Model(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:3298
Wrapper around OrtNode.
Definition onnxruntime_cxx_api.h:3162
Node(const std::string &operator_name, const std::string &operator_domain, const std::string &node_name, const std::vector< std::string > &input_names, const std::vector< std::string > &output_names)
Node(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:3164
Node(const std::string &operator_name, const std::string &operator_domain, const std::string &node_name, const std::vector< std::string > &input_names, const std::vector< std::string > &output_names, std::vector< OpAttr > &attributes)
Wraps CreateNode. Node takes ownership of attributes on success and updates the OpAttr in attributes ...
Node(OrtNode *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3165
This struct provides life time management for custom op attribute.
Definition onnxruntime_cxx_api.h:2546
OpAttr(const char *name, const void *data, int len, OrtOpAttrType type)
OpAttr(std::nullptr_t)
Definition onnxruntime_cxx_api.h:2551
ConstOpAttr GetConst() const
Definition onnxruntime_cxx_api.h:2554
Create and own custom defined operation.
Definition onnxruntime_cxx_api.h:2813
Op(OrtOp *)
Take ownership of the OrtOp.
static Op Create(const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, size_t type_constraint_count, const OpAttr *attr_values, size_t attr_count, size_t input_count, size_t output_count)
Op(std::nullptr_t)
Create an empty Operator object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2817
void Invoke(const OrtKernelContext *context, const OrtValue *const *input_values, size_t input_count, OrtValue *const *output_values, size_t output_count)
void Invoke(const OrtKernelContext *context, const Value *input_values, size_t input_count, Value *output_values, size_t output_count)
Definition onnxruntime_cxx_api.h:3202
std::string domain
Definition onnxruntime_cxx_api.h:3203
int64_t version
Definition onnxruntime_cxx_api.h:3204
The PrepackedWeightsContainer.
Definition onnxruntime_cxx_api.h:881
PrepackedWeightsContainer()
Wraps OrtApi::CreatePrepackedWeightsContainer.
PrepackedWeightsContainer(OrtPrepackedWeightsContainer *p)
Definition onnxruntime_cxx_api.h:886
PrepackedWeightsContainer(std::nullptr_t)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:884
RunOptions.
Definition onnxruntime_cxx_api.h:1257
int GetRunLogSeverityLevel() const
Wraps OrtApi::RunOptionsGetRunLogSeverityLevel.
RunOptions & SetTerminate()
Terminates all currently executing Session::Run calls that were made using this RunOptions instance.
RunOptions & SetRunTag(const char *run_tag)
wraps OrtApi::RunOptionsSetRunTag
RunOptions & AddActiveLoraAdapter(const LoraAdapter &adapter)
Add the LoraAdapter to the list of active adapters. The setting does not affect RunWithBinding() call...
RunOptions & UnsetTerminate()
Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without ...
int GetRunLogVerbosityLevel() const
Wraps OrtApi::RunOptionsGetRunLogVerbosityLevel.
RunOptions(std::nullptr_t)
Create an empty RunOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1258
RunOptions & SetRunLogVerbosityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel.
RunOptions & SetRunLogSeverityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogSeverityLevel.
RunOptions & AddConfigEntry(const char *config_key, const char *config_value)
Wraps OrtApi::AddRunConfigEntry.
const char * GetRunTag() const
Wraps OrtApi::RunOptionsGetRunTag.
RunOptions()
Wraps OrtApi::CreateRunOptions.
const char * GetConfigEntry(const char *config_key)
Wraps OrtApi::GetRunConfigEntry.
Wrapper around OrtSequenceTypeInfo.
Definition onnxruntime_cxx_api.h:1842
SequenceTypeInfo(std::nullptr_t)
Create an empty SequenceTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1846
ConstSequenceTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1848
SequenceTypeInfo(OrtSequenceTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1847
Wrapper around OrtSession.
Definition onnxruntime_cxx_api.h:1743
Session(std::nullptr_t)
Create an empty Session object, must be assigned a valid one to be used. Wraps OrtApi::CreateSession.
Definition onnxruntime_cxx_api.h:1745
static Session CreateModelEditorSession(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options)
Wraps OrtModelEditorApi::CreateModelEditorSession.
UnownedSession GetUnowned() const
Definition onnxruntime_cxx_api.h:1774
Session(const Env &env, const char *model_path, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Wraps OrtApi::CreateSessionWithPrepackedWeightsContainer.
Session(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Wraps OrtApi::CreateSessionFromArrayWithPrepackedWeightsContainer.
Session(const Env &env, const Model &model, const SessionOptions &options)
Wraps OrtModelEditorApi::CreateSessionFromModel.
Session(OrtSession *p)
C API Interop.
Definition onnxruntime_cxx_api.h:1746
static Session CreateModelEditorSession(const Env &env, const char *model_path, const SessionOptions &options)
Wraps OrtModelEditorApi::CreateModelEditorSession.
Session(const Env &env, const char *model_path, const SessionOptions &options)
ConstSession GetConst() const
Definition onnxruntime_cxx_api.h:1773
Session(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options)
Wraps OrtApi::CreateSessionFromArray.
Wrapper around OrtSessionOptions.
Definition onnxruntime_cxx_api.h:1465
SessionOptions(std::nullptr_t)
Create an empty SessionOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1466
UnownedSessionOptions GetUnowned() const
Definition onnxruntime_cxx_api.h:1469
SessionOptions()
Wraps OrtApi::CreateSessionOptions.
ConstSessionOptions GetConst() const
Definition onnxruntime_cxx_api.h:1470
SessionOptions(OrtSessionOptions *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1468
Definition onnxruntime_cxx_api.h:2847
SymbolicInteger & operator=(const SymbolicInteger &)=default
SymbolicInteger(const SymbolicInteger &)=default
int64_t AsInt() const
Definition onnxruntime_cxx_api.h:2868
int64_t i_
Definition onnxruntime_cxx_api.h:2875
const char * s_
Definition onnxruntime_cxx_api.h:2876
bool operator==(const SymbolicInteger &dim) const
Definition onnxruntime_cxx_api.h:2856
SymbolicInteger & operator=(SymbolicInteger &&)=default
SymbolicInteger(SymbolicInteger &&)=default
const char * AsSym() const
Definition onnxruntime_cxx_api.h:2869
SymbolicInteger(int64_t i)
Definition onnxruntime_cxx_api.h:2848
SymbolicInteger(const char *s)
Definition onnxruntime_cxx_api.h:2849
bool IsInt() const
Definition onnxruntime_cxx_api.h:2867
Provide access to per-node attributes and input shapes, so one could compute and set output shapes.
Definition onnxruntime_cxx_api.h:2846
Ints GetAttrInts(const char *attr_name)
Strings GetAttrStrings(const char *attr_name)
Status SetOutputShape(size_t indice, const Shape &shape, ONNXTensorElementDataType type=ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT)
std::vector< SymbolicInteger > Shape
Definition onnxruntime_cxx_api.h:2881
std::vector< float > Floats
Definition onnxruntime_cxx_api.h:2898
std::string GetAttrString(const char *attr_name)
std::vector< int64_t > Ints
Definition onnxruntime_cxx_api.h:2893
ShapeInferContext(const OrtApi *ort_api, OrtShapeInferContext *ctx)
int64_t GetAttrInt(const char *attr_name)
size_t GetInputCount() const
Definition onnxruntime_cxx_api.h:2887
std::vector< std::string > Strings
Definition onnxruntime_cxx_api.h:2903
Floats GetAttrFloats(const char *attr_name)
const Shape & GetInputShape(size_t indice) const
Definition onnxruntime_cxx_api.h:2885
float GetAttrFloat(const char *attr_name)
The Status that holds ownership of OrtStatus received from C API Use it to safely destroy OrtStatus* ...
Definition onnxruntime_cxx_api.h:797
OrtErrorCode GetErrorCode() const
Status(const Exception &)
Creates status instance out of exception.
bool IsOK() const noexcept
Returns true if instance represents an OK (non-error) status.
Status(OrtStatus *status) noexcept
Takes ownership of OrtStatus instance returned from the C API.
std::string GetErrorMessage() const
Status(const std::exception &)
Creates status instance out of exception.
Status(const char *message, OrtErrorCode code)
Creates status instance out of null-terminated string message.
Status(std::nullptr_t) noexcept
Create an empty object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:799
Definition onnxruntime_cxx_api.h:1083
SyncStream(OrtSyncStream *p)
Definition onnxruntime_cxx_api.h:1087
SyncStream(std::nullptr_t)
< Create an empty SyncStream object, must be assigned a valid one to be used
Definition onnxruntime_cxx_api.h:1085
The TensorRTOptions (V2)
Definition onnxruntime_cxx_api.h:843
void Update(const std::unordered_map< std::string, std::string > &options)
Wrapper around OrtApi::UpdateTensorRTProviderOptions.
void UpdateWithValue(const char *key, void *value)
Wrapper around OrtApi::GetTensorRTProviderOptionsByName.
std::string GetTensorRTProviderOptionsAsString() const
void * GetOptionByName(const char *name) const
Wrapper around OrtApi::GetTensorRTProviderOptionsAsString.
TensorRTProviderOptions(std::nullptr_t)
Definition onnxruntime_cxx_api.h:844
TensorRTProviderOptions()
Wraps OrtApi::CreateTensorRTProviderOptionsV2.
Wrapper around OrtTensorTypeAndShapeInfo.
Definition onnxruntime_cxx_api.h:1808
TensorTypeAndShapeInfo(std::nullptr_t)
Create an empty TensorTypeAndShapeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1813
ConstTensorTypeAndShapeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1824
TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1815
TensorTypeAndShapeInfo(ONNXTensorElementDataType element_type, const std::vector< int64_t > &dims, const std::vector< std::string > *symbolic_dims=nullptr)
The ThreadingOptions.
Definition onnxruntime_cxx_api.h:813
ThreadingOptions & SetGlobalCustomThreadCreationOptions(void *ort_custom_thread_creation_options)
Wraps OrtApi::SetGlobalCustomThreadCreationOptions.
ThreadingOptions()
Wraps OrtApi::CreateThreadingOptions.
ThreadingOptions & SetGlobalInterOpNumThreads(int inter_op_num_threads)
Wraps OrtApi::SetGlobalInterOpNumThreads.
ThreadingOptions & SetGlobalCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Wraps OrtApi::SetGlobalCustomCreateThreadFn.
ThreadingOptions & SetGlobalCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Wraps OrtApi::SetGlobalCustomJoinThreadFn.
ThreadingOptions & SetGlobalSpinControl(int allow_spinning)
Wraps OrtApi::SetGlobalSpinControl.
ThreadingOptions & SetGlobalDenormalAsZero()
Wraps OrtApi::SetGlobalDenormalAsZero.
ThreadingOptions & SetGlobalIntraOpNumThreads(int intra_op_num_threads)
Wraps OrtApi::SetGlobalIntraOpNumThreads.
Type information that may contain either TensorTypeAndShapeInfo or the information about contained se...
Definition onnxruntime_cxx_api.h:1914
static TypeInfo CreateOptionalTypeInfo(ConstTypeInfo contained_type)
static TypeInfo CreateSequenceTypeInfo(ConstTypeInfo sequence_type)
static TypeInfo CreateTensorInfo(ConstTensorTypeAndShapeInfo tensor_info)
static TypeInfo CreateSparseTensorInfo(ConstTensorTypeAndShapeInfo sparse_tensor_info)
TypeInfo(std::nullptr_t)
Create an empty TypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1919
static TypeInfo CreateMapTypeInfo(ONNXTensorElementDataType key_type, ConstTypeInfo value_type)
ConstTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1930
TypeInfo(OrtTypeInfo *p)
C API Interop.
Definition onnxruntime_cxx_api.h:1920
Wrapper around OrtValue.
Definition onnxruntime_cxx_api.h:2270
static Value CreateSparseTensor(const OrtMemoryInfo *info, void *p_data, const Shape &dense_shape, const Shape &values_shape, ONNXTensorElementDataType type)
Creates an OrtValue instance containing SparseTensor. This constructs a sparse tensor that makes use ...
static Value CreateSparseTensor(const OrtMemoryInfo *info, T *p_data, const Shape &dense_shape, const Shape &values_shape)
This is a simple forwarding method to the other overload that helps deducing data type enum value fro...
Value & operator=(Value &&)=default
static Value CreateSparseTensor(OrtAllocator *allocator, const Shape &dense_shape, ONNXTensorElementDataType type)
Creates an instance of OrtValue containing sparse tensor. The created instance has no data....
Value(std::nullptr_t)
Create an empty Value object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2276
static Value CreateTensor(const OrtMemoryInfo *info, T *p_data, size_t p_data_element_count, const int64_t *shape, size_t shape_len)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
static Value CreateSparseTensor(OrtAllocator *allocator, const Shape &dense_shape)
This is a simple forwarding method to the below CreateSparseTensor. This helps to specify data type e...
static Value CreateTensor(OrtAllocator *allocator, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type)
Creates an OrtValue with a tensor using the supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtVal...
UnownedValue GetUnowned() const
Definition onnxruntime_cxx_api.h:2281
static Value CreateSequence(const std::vector< Value > &values)
Creates an OrtValue with a Sequence Onnx type representation. The API would ref-count the supplied Or...
static Value CreateMap(const Value &keys, const Value &values)
Creates an OrtValue with a Map Onnx type representation. The API would ref-count the supplied OrtValu...
static Value CreateTensor(const OrtMemoryInfo *info, void *p_data, size_t p_data_byte_count, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
static Value CreateTensor(OrtAllocator *allocator, const int64_t *shape, size_t shape_len)
Creates an OrtValue with a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue...
static Value CreateOpaque(const char *domain, const char *type_name, const T &value)
Creates an OrtValue wrapping an Opaque type. This is used for experimental support of non-tensor type...
static Value CreateTensor(OrtAllocator *deleter, void *p_data, size_t p_data_byte_count, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAndDeleterAsOrtValue.
ConstValue GetConst() const
Definition onnxruntime_cxx_api.h:2280
Definition onnxruntime_cxx_api.h:3194
int64_t index
Definition onnxruntime_cxx_api.h:3198
ConstNode node
Definition onnxruntime_cxx_api.h:3195
Wrapper around OrtValueInfo.
Definition onnxruntime_cxx_api.h:3099
ConstValueInfo GetConst() const
Definition onnxruntime_cxx_api.h:3109
ValueInfo(std::nullptr_t)
Definition onnxruntime_cxx_api.h:3101
ValueInfo(const std::string &name, const ConstTypeInfo &type_info)
ValueInfo(OrtValueInfo *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3103
Definition onnxruntime_cxx_api.h:759
AllocatedFree(OrtAllocator *allocator)
Definition onnxruntime_cxx_api.h:761
OrtAllocator * allocator_
Definition onnxruntime_cxx_api.h:760
void operator()(void *ptr) const
Definition onnxruntime_cxx_api.h:763
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:745
constexpr contained_type & operator*() const noexcept
Definition onnxruntime_cxx_api.h:752
typename Unowned< T >::Type contained_type
Definition onnxruntime_cxx_api.h:734
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:744
Base(const Base &)=default
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:737
Base & operator=(const Base &)=default
Used internally by the C++ API. C++ wrapper types inherit from this. This is a zero cost abstraction ...
Definition onnxruntime_cxx_api.h:687
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:699
constexpr contained_type & operator*() const noexcept
Definition onnxruntime_cxx_api.h:707
contained_type * release()
Relinquishes ownership of the contained C object pointer The underlying object is not destroyed.
Definition onnxruntime_cxx_api.h:711
Base(const Base &)=delete
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:691
Base & operator=(const Base &)=delete
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:700
contained_type * p_
Definition onnxruntime_cxx_api.h:718
~Base()
Definition onnxruntime_cxx_api.h:692
T contained_type
Definition onnxruntime_cxx_api.h:688
Definition onnxruntime_cxx_api.h:893
size_t GetByteSize() const
int64_t GetFileOffset() const
const std::basic_string< char > GetFilePath() const
Definition onnxruntime_cxx_api.h:3209
std::vector< ConstNode > GetNodes() const
std::vector< ConstValueInfo > GetInputs() const
ConstNode GetParentNode() const
int64_t GetOnnxIRVersion() const
std::basic_string< char > GetModelPath() const
Graph GetGraphView(const std::vector< ConstNode > &nodes) const
ModelMetadata GetModelMetadata() const
Wraps OrtApi::Graph_GetModelMetadata.
std::vector< ConstValueInfo > GetInitializers() const
std::string GetName() const
std::vector< ConstValueInfo > GetOutputs() const
std::vector< OperatorSet > GetOperatorSets() const
Definition onnxruntime_cxx_api.h:2449
std::vector< Value > GetOutputValues(OrtAllocator *) const
std::vector< std::string > GetOutputNames(OrtAllocator *) const
std::vector< Value > GetOutputValues() const
std::vector< std::string > GetOutputNames() const
Definition onnxruntime_cxx_api.h:3309
std::pair< int, int > GetSinceVersion() const
Wraps OrtEpApi::KernelDef_GetExecutionProvider.
const char * GetDomain() const
Wraps OrtEpApi::KernelDef_GetSinceVersion.
OrtMemType GetOutputMemType(size_t output_index) const
const char * GetExecutionProvider() const
Wraps OrtEpApi::KernelDef_GetInputMemType.
OrtMemType GetInputMemType(size_t input_index) const
Wraps OrtEpApi::KernelDef_GetOutputMemType.
const char * GetOperatorType() const
< Wraps OrtEpApi::KernelDef_GetOperatorType
Definition onnxruntime_cxx_api.h:3121
std::vector< ConstValueInfo > GetOutputs() const
std::vector< ConstValueInfo > GetImplicitInputs() const
int GetSinceVersion() const
std::string GetName() const
std::string GetDomain() const
std::vector< AttrNameSubgraph > GetSubgraphs() const
ConstGraphImpl< detail::Unowned< const OrtGraph > > GetGraph() const
std::string GetOperatorType() const
std::vector< ConstOpAttr > GetAttributes() const
std::vector< ConstValueInfo > GetInputs() const
Status GetAttributeByName(const std::string &name, ConstOpAttr &attr) const
std::string GetEpName() const
Definition onnxruntime_cxx_api.h:2518
std::string GetName() const
Status GetValue(R &out) const
Status GetTensorAttributeAsOrtValue(Value &) const
Status GetValueArray(std::vector< R > &out) const
OrtOpAttrType GetType() const
Definition onnxruntime_cxx_api.h:1598
std::vector< std::string > GetOutputNames() const
TypeInfo GetInputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetInputTypeInfo.
size_t GetOutputCount() const
Returns the number of model outputs.
std::vector< ValueInfo > GetOutputs() const
int GetOpset(const std::string &domain) const
Wraps OrtApi::SessionGetOpsetForDomain.
uint64_t GetProfilingStartTimeNs() const
Wraps OrtApi::SessionGetProfilingStartTimeNs.
std::vector< std::string > GetOverridableInitializerNames() const
ModelMetadata GetModelMetadata() const
Wraps OrtApi::SessionGetModelMetadata.
size_t GetInputCount() const
Returns the number of model inputs.
TypeInfo GetOutputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOutputTypeInfo.
std::vector< std::string > GetInputNames() const
AllocatedStringPtr GetOverridableInitializerNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of the overridable initializer name at then specified index.
std::vector< ConstEpDevice > GetEpDeviceForInputs() const
Wrapper for OrtApi::SessionGetEpDeviceForInputs.
AllocatedStringPtr GetOutputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of output name at then specified index.
size_t GetOverridableInitializerCount() const
Returns the number of inputs that have defaults that can be overridden.
std::vector< ConstMemoryInfo > GetMemoryInfoForOutputs() const
Wrapper for OrtApi::SessionGetMemoryInfoForOutputs.
AllocatedStringPtr GetInputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of input name at the specified index.
std::vector< ConstMemoryInfo > GetMemoryInfoForInputs() const
Wrapper for OrtApi::SessionGetMemoryInfoForInputs.
std::vector< ValueInfo > GetInputs() const
TypeInfo GetOverridableInitializerTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOverridableInitializerTypeInfo.
Definition onnxruntime_cxx_api.h:1959
void GetStringTensorContent(void *buffer, size_t buffer_length, size_t *offsets, size_t offsets_count) const
The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor into...
void GetStringTensorElement(size_t buffer_length, size_t element_index, void *buffer) const
The API copies UTF-8 encoded bytes for the requested string element contained within a tensor or a sp...
TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat format) const
The API returns type and shape information for the specified indices. Each supported indices have the...
const void * GetTensorRawData() const
Returns a non-typed pointer to a tensor contained data.
std::string GetStringTensorElement(size_t element_index) const
Returns string tensor UTF-8 encoded string element. Use of this API is recommended over GetStringTens...
size_t GetStringTensorElementLength(size_t element_index) const
The API returns a byte length of UTF-8 encoded string element contained in either a tensor or a spare...
size_t GetStringTensorDataLength() const
This API returns a full length of string data contained within either a tensor or a sparse Tensor....
bool IsSparseTensor() const
Returns true if the OrtValue contains a sparse tensor.
TypeInfo GetTypeInfo() const
The API returns type information for data contained in a tensor. For sparse tensors it returns type i...
const R * GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t &num_indices) const
The API retrieves a pointer to the internal indices buffer. The API merely performs a convenience dat...
bool IsTensor() const
Returns true if Value is a tensor, false for other types like map/sequence/etc.
ConstMemoryInfo GetTensorMemoryInfo() const
This API returns information about the memory allocation used to hold data.
size_t GetTensorSizeInBytes() const
Returns the total size of the tensor data in bytes. Throws an exception if the OrtValue does not cont...
const R * GetSparseTensorValues() const
The API returns a pointer to an internal buffer of the sparse tensor containing non-zero values....
TensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const
The API returns type information for data contained in a tensor. For sparse tensors it returns type i...
Value GetValue(int index, OrtAllocator *allocator) const
size_t GetCount() const
< Return true if OrtValue contains data and returns false if the OrtValue is a None
void GetOpaqueData(const char *domain, const char *type_name, R &) const
Obtains a pointer to a user defined data for experimental purposes.
TensorTypeAndShapeInfo GetSparseTensorValuesTypeAndShapeInfo() const
The API returns type and shape information for stored non-zero values of the sparse tensor....
const R * GetTensorData() const
Returns a const typed pointer to the tensor contained data. No type checking is performed,...
OrtSparseFormat GetSparseFormat() const
The API returns the sparse data format this OrtValue holds in a sparse tensor. If the sparse tensor w...
Definition onnxruntime_cxx_api.h:3064
Status GetInitializer(ConstValue &value) const
< A wrapper around OrtApi::ValueInfo_GetInitializerValue
std::string GetName() const
< A wrapper around OrtApi::GetValueInfoName
bool IsFromOuterScope() const
< A wrapper around OrtApi::ValueInfo_IsFromOuterScope
Status GetExternalInitializerInfo(ExternalInitializerInfo &info) const
< A wrapper around OrtApi::ValueInfo_GetExternalInitializerInfo
bool IsConstantInitializer() const
< A wrapper around OrtApi::ValueInfo_IsConstantInitializer
std::vector< ValueInfoConsumerProducerInfo > GetConsumers() const
< A wrapper around OrtApi::ValueInfo_GetValueConsumers
bool IsGraphOutput() const
< A wrapper around OrtApi::ValueInfo_IsGraphOutput
bool IsRequiredGraphInput() const
< A wrapper around OrtApi::ValueInfo_IsRequiredGraphInput
ConstTypeInfo TypeInfo() const
< A wrapper around OrtApi::GetValueInfoTypeInfo
ValueInfoConsumerProducerInfo GetProducerNode() const
bool IsOptionalGraphInput() const
< A wrapper around OrtApi::ValueInfo_IsOptionalGraphInput
Definition onnxruntime_cxx_api.h:1113
const char * EpName() const
const char * EpVendor() const
ConstKeyValuePairs EpOptions() const
ConstHardwareDevice Device() const
ConstMemoryInfo GetMemoryInfo(OrtDeviceMemoryType memory_type) const
Wraps EpDevice_MemoryInfo.
SyncStream CreateSyncStream(ConstKeyValuePairs stream_options={}) const
ConstKeyValuePairs EpMetadata() const
Definition onnxruntime_cxx_api.h:3238
void SetInputs(std::vector< ValueInfo > &inputs)
void SetOutputs(std::vector< ValueInfo > &outputs)
void AddInitializer(const std::string &name, Value &initializer, bool data_is_external)
Definition onnxruntime_cxx_api.h:1094
uint32_t DeviceId() const
OrtHardwareDeviceType Type() const
const char * Vendor() const
ConstKeyValuePairs Metadata() const
uint32_t VendorId() const
Definition onnxruntime_cxx_api.h:2460
void BindOutput(const char *name, const Value &)
void BindInput(const char *name, const Value &)
void SynchronizeOutputs()
void BindOutput(const char *name, const OrtMemoryInfo *)
Definition onnxruntime_cxx_api.h:933
void GetKeyValuePairs(std::vector< const char * > &keys, std::vector< const char * > &values) const
std::unordered_map< std::string, std::string > GetKeyValuePairs() const
const char * GetValue(const char *key) const
Definition onnxruntime_cxx_api.h:1866
ONNXTensorElementDataType GetMapKeyType() const
Wraps OrtApi::GetMapKeyType.
TypeInfo GetMapValueType() const
Wraps OrtApi::GetMapValueType.
Definition onnxruntime_cxx_api.h:972
std::string GetAllocatorName() const
Wrapper MemoryInfoGetName.
int GetDeviceId() const
Wrapper MemoryInfoGetId.
OrtMemType GetMemoryType() const
Wrapper MemoryInfoGetMemType.
OrtDeviceMemoryType GetDeviceMemoryType() const
Wrapper MemoryInfoGetDeviceMemType.
OrtMemoryInfoDeviceType GetDeviceType() const
Wrapper MemoryInfoGetDeviceType.
OrtAllocatorType GetAllocatorType() const
Wrapper MemoryInfoGetType.
uint32_t GetVendorId() const
Wrapper MemoryInfoGetVendorId.
bool operator==(const MemoryInfoImpl< U > &o) const
Definition onnxruntime_cxx_api.h:3278
void AddGraph(Graph &graph)
Definition onnxruntime_cxx_api.h:1853
TypeInfo GetOptionalElementType() const
Wraps OrtApi::CastOptionalTypeToContainedTypeInfo.
Definition onnxruntime_cxx_api.h:1942
const char ** str
Definition onnxruntime_cxx_api.h:1947
const int64_t * values_shape
Definition onnxruntime_cxx_api.h:1943
size_t values_shape_len
Definition onnxruntime_cxx_api.h:1944
const void * p_data
Definition onnxruntime_cxx_api.h:1946
Definition onnxruntime_cxx_api.h:1829
TypeInfo GetSequenceElementType() const
Wraps OrtApi::GetSequenceElementType.
Definition onnxruntime_cxx_api.h:1656
void SetEpDynamicOptions(const char *const *keys, const char *const *values, size_t kv_len)
Set DynamicOptions for EPs (Execution Providers)
AllocatedStringPtr EndProfilingAllocated(OrtAllocator *allocator)
End profiling and return a copy of the profiling file name.
void FinalizeModelEditorSession(const Model &model, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container=nullptr)
void Run(const RunOptions &run_options, const IoBinding &)
Wraps OrtApi::RunWithBinding.
void RunAsync(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, Value *output_values, size_t output_count, RunAsyncCallbackFn callback, void *user_data)
Run the model asynchronously in a thread owned by intra op thread pool.
std::vector< Value > Run(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, size_t output_count)
Run the model returning results in an Ort allocated vector.
void Run(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, Value *output_values, size_t output_count)
Run the model returning results in user provided outputs Same as Run(const RunOptions&,...
Definition onnxruntime_cxx_api.h:1953
const int64_t * shape
Definition onnxruntime_cxx_api.h:1954
size_t shape_len
Definition onnxruntime_cxx_api.h:1955
Definition onnxruntime_cxx_api.h:3393
Status StoreWeightData(void **buffer_data_ptrs, size_t *buffer_sizes, size_t num_buffers)
Definition onnxruntime_cxx_api.h:1075
void * GetHandle()
Wraps SyncStream_GetHandle.
Definition onnxruntime_cxx_api.h:1779
size_t GetElementCount() const
Wraps OrtApi::GetTensorShapeElementCount.
void GetDimensions(int64_t *values, size_t values_count) const
Wraps OrtApi::GetDimensions.
std::vector< int64_t > GetShape() const
Uses GetDimensionsCount & GetDimensions to return a std::vector of the shape.
std::vector< const char * > GetSymbolicDimensions() const
void GetSymbolicDimensions(const char **values, size_t values_count) const
Wraps OrtApi::GetSymbolicDimensions.
size_t GetDimensionsCount() const
Wraps OrtApi::GetDimensionsCount.
ONNXTensorElementDataType GetElementType() const
Wraps OrtApi::GetTensorElementType.
bool HasShape() const
Wraps OrtApi::TensorTypeAndShape_HasShape.
Definition onnxruntime_cxx_api.h:1891
ONNXType GetONNXType() const
ConstSequenceTypeInfo GetSequenceTypeInfo() const
Wraps OrtApi::CastTypeInfoToSequenceTypeInfo.
ConstMapTypeInfo GetMapTypeInfo() const
Wraps OrtApi::CastTypeInfoToMapTypeInfo.
ConstOptionalTypeInfo GetOptionalTypeInfo() const
wraps OrtApi::CastTypeInfoToOptionalTypeInfo
ConstTensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const
Wraps OrtApi::CastTypeInfoToTensorInfo.
This is a tagging template type. Use it with Base<T> to indicate that the C++ interface object has no...
Definition onnxruntime_cxx_api.h:663
T Type
Definition onnxruntime_cxx_api.h:664
Definition onnxruntime_cxx_api.h:2128
void FillStringTensorElement(const char *s, size_t index)
Set a single string in a string tensor.
R * GetTensorMutableData()
Returns a non-const typed pointer to an OrtValue/Tensor contained buffer No type checking is performe...
R & At(const std::vector< int64_t > &location)
void UseBlockSparseIndices(const Shape &indices_shape, int32_t *indices_data)
Supplies BlockSparse format specific indices and marks the contained sparse tensor as being a BlockSp...
void FillSparseTensorBlockSparse(const OrtMemoryInfo *data_mem_info, const OrtSparseValuesParam &values, const Shape &indices_shape, const int32_t *indices_data)
The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API an...
void * GetTensorMutableRawData()
Returns a non-typed non-const pointer to a tensor contained data.
void UseCooIndices(int64_t *indices_data, size_t indices_num)
Supplies COO format specific indices and marks the contained sparse tensor as being a COO format tens...
void FillSparseTensorCoo(const OrtMemoryInfo *data_mem_info, const OrtSparseValuesParam &values_param, const int64_t *indices_data, size_t indices_num)
The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API an...
void FillStringTensor(const char *const *s, size_t s_len)
Set all strings at once in a string tensor.
void UseCsrIndices(int64_t *inner_data, size_t inner_num, int64_t *outer_data, size_t outer_num)
Supplies CSR format specific indices and marks the contained sparse tensor as being a CSR format tens...
void FillSparseTensorCsr(const OrtMemoryInfo *data_mem_info, const OrtSparseValuesParam &values, const int64_t *inner_indices_data, size_t inner_indices_num, const int64_t *outer_indices_data, size_t outer_indices_num)
The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API an...
char * GetResizedStringTensorElementBuffer(size_t index, size_t buffer_length)
Allocate if necessary and obtain a pointer to a UTF-8 encoded string element buffer indexed by the fl...
Memory allocation interface.
Definition onnxruntime_c_api.h:346
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:353
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:898
Definition onnxruntime_c_api.h:968
const OrtEpApi *(* GetEpApi)(void)
Get the OrtEpApi instance for implementing an execution provider.
Definition onnxruntime_c_api.h:5441
const OrtCompileApi *(* GetCompileApi)(void)
Get the Compile API instance.
Definition onnxruntime_c_api.h:5173
void(* ReleaseTensorRTProviderOptions)(OrtTensorRTProviderOptionsV2 *input)
Release an OrtTensorRTProviderOptionsV2.
Definition onnxruntime_c_api.h:3224
const OrtModelEditorApi *(* GetModelEditorApi)(void)
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:5115
void(* ReleaseCUDAProviderOptions)(OrtCUDAProviderOptionsV2 *input)
Release an OrtCUDAProviderOptionsV2.
Definition onnxruntime_c_api.h:3727
CUDA Provider Options.
Definition onnxruntime_c_api.h:601
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:7224
Definition onnxruntime_c_api.h:6697
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6743
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6727
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6715
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6747
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:6780
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6765
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:6777
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6708
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6717
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:6723
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6752
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6734
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:6704
uint32_t version
Definition onnxruntime_c_api.h:6698
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6714
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:6781
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6726
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6711
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6716
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6738
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:6762
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6766
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:6755
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:6773
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:6760
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:6722
The OrtEpApi struct provides functions that are relevant to the implementation of an execution provid...
Definition onnxruntime_ep_c_api.h:429
The OrtEpFactory provides functions to create and manage execution providers.
Definition onnxruntime_ep_c_api.h:1325
The OrtEp struct provides functions to implement for an execution provider.
Definition onnxruntime_ep_c_api.h:1007
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:805
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:6795
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:844
ROCM Provider Options.
Definition onnxruntime_c_api.h:688
TensorRT Provider Options.
Definition onnxruntime_c_api.h:777