ONNX Runtime
Loading...
Searching...
No Matches
onnxruntime_c_api.h
1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the MIT License.
3
4// See docs\c_cxx\README.md on generating the Doxygen documentation from this file
5
31#pragma once
32#include <stdbool.h>
33#include <stdint.h>
34#include <stdlib.h>
35#include <string.h>
36
41#define ORT_API_VERSION 25
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
48// SAL2 Definitions
49#ifndef _MSC_VER
50#define _In_
51#define _In_z_
52#define _In_opt_
53#define _In_opt_z_
54#define _Out_
55#define _Out_opt_
56#define _Outptr_
57#define _Outptr_opt_
58#define _Inout_
59#define _Inout_opt_
60#define _Frees_ptr_opt_
61#define _Ret_maybenull_
62#define _Ret_notnull_
63#define _Check_return_
64#define _Outptr_result_maybenull_
65#define _Outptr_result_maybenull_z_
66#define _In_reads_(X)
67#define _In_reads_opt_
68#define _Inout_updates_(X)
69#define _Out_writes_(X)
70#define _Out_writes_opt_(X)
71#define _Inout_updates_all_(X)
72#define _Out_writes_bytes_all_(X)
73#define _Out_writes_all_(X)
74#define _Success_(X)
75#define _Outptr_result_buffer_maybenull_(X)
76#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
77#else
78#include <specstrings.h>
79#define ORT_ALL_ARGS_NONNULL
80#endif
81
82#ifdef _WIN32
83// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
84// dllexport is not used, we use a .def file.
85#ifdef ORT_DLL_IMPORT
86#define ORT_EXPORT __declspec(dllimport)
87#else
88#define ORT_EXPORT
89#endif
90#define ORT_API_CALL __stdcall
91#define ORT_MUST_USE_RESULT
92#define ORTCHAR_T wchar_t
93#else
94// To make symbols visible on macOS/iOS
95#ifdef __APPLE__
96#define ORT_EXPORT __attribute__((visibility("default")))
97#else
98#define ORT_EXPORT
99#endif
100#define ORT_API_CALL
101#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
102#define ORTCHAR_T char
103#endif
104
107#ifndef ORT_TSTR
108#ifdef _WIN32
109#define ORT_TSTR(X) L##X
110// When X is a macro, L##X is not defined. In this case, we need to use ORT_TSTR_ON_MACRO.
111#define ORT_TSTR_ON_MACRO(X) L"" X
112#else
113#define ORT_TSTR(X) X
114#define ORT_TSTR_ON_MACRO(X) X
115#endif
116#endif
117
118// On Windows, ORT_FILE is a wchar_t version of the __FILE__ macro.
119// Otherwise, ORT_FILE is equivalent to __FILE__.
120#ifndef ORT_FILE
121#define ORT_FILE_INTERNAL(x) ORT_TSTR(x)
122#define ORT_FILE ORT_FILE_INTERNAL(__FILE__)
123#endif
124
125// Any pointer marked with _In_ or _Out_, cannot be NULL.
126
127// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
128// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
129// for ReleaseXXX(...) functions, they can accept NULL pointer.
130
131#ifdef __cplusplus
132// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
133// Such complex condition is needed because compilers set __cplusplus value differently.
134#ifndef __has_feature
135#define __has_feature(x) 0
136#endif
137#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
138#define NO_EXCEPTION noexcept
139#else
140#define NO_EXCEPTION throw()
141#endif
142#else
143#define NO_EXCEPTION
144#endif
145
146// __VA_ARGS__ on Windows and Linux are different
147#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
148
149#define ORT_API_T(RETURN_TYPE, NAME, ...) \
150 RETURN_TYPE(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION
151
152#define ORT_API_STATUS(NAME, ...) \
153 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
154 NO_EXCEPTION ORT_MUST_USE_RESULT
155
156// XXX: Unfortunately, SAL annotations are known to not work with function pointers
157#define ORT_API2_STATUS(NAME, ...) \
158 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
159
160// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
161#define ORT_API_STATUS_IMPL(NAME, ...) \
162 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
163
164#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
165
166#ifdef __DOXYGEN__
167#undef ORT_API_STATUS
168#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
169#undef ORT_API2_STATUS
170#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
171#undef ORT_CLASS_RELEASE
172#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
173#undef NO_EXCEPTION
174#define NO_EXCEPTION
175#endif
186 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
187 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
188 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
189 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
190 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
191 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
192 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
193 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
196 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
197 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
198 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
199 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
200 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
201 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16, // Non-IEEE floating-point format based on IEEE754 single-precision
202 // float 8 types were introduced in onnx 1.14, see https://onnx.ai/onnx/technical/float8.html
203 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN, // Non-IEEE floating-point format based on IEEE754 single-precision
204 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
205 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2, // Non-IEEE floating-point format based on IEEE754 single-precision
206 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
207 // Int4 types were introduced in ONNX 1.16. See https://onnx.ai/onnx/technical/int4.html
208 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4, // maps to a pair of packed uint4 values (size == 1 byte)
209 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4, // maps to a pair of packed int4 values (size == 1 byte)
210 // Float4 types were introduced in ONNX 1.18. See https://onnx.ai/onnx/technical/float4.html
211 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT4E2M1, // maps to a pair of packed float4 values (size == 1 byte)
212 // Int2 types were introduced in ONNX 1.20. See https://onnx.ai/onnx/technical/int2.html
213 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT2, // maps to 4 packed uint2 values (size == 1 byte)
214 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT2, // maps to 4 packed int2 values (size == 1 byte)
216
217// Synced with onnx TypeProto oneof
227
228// These types are synced with internal
229// SparseFormatFlags
236
237// Enum allows to query sparse tensor indices
244
256
274
286
288#define ORT_RUNTIME_CLASS(X) \
289 struct Ort##X; \
290 typedef struct Ort##X Ort##X
291
296// The actual types defined have an Ort prefix
297ORT_RUNTIME_CLASS(Env);
298ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
299ORT_RUNTIME_CLASS(MemoryInfo);
300ORT_RUNTIME_CLASS(IoBinding);
301ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
302ORT_RUNTIME_CLASS(Value);
303ORT_RUNTIME_CLASS(RunOptions);
304ORT_RUNTIME_CLASS(TypeInfo);
305ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
306ORT_RUNTIME_CLASS(MapTypeInfo);
307ORT_RUNTIME_CLASS(SequenceTypeInfo);
308ORT_RUNTIME_CLASS(OptionalTypeInfo);
309ORT_RUNTIME_CLASS(SessionOptions);
310ORT_RUNTIME_CLASS(CustomOpDomain);
311ORT_RUNTIME_CLASS(ModelMetadata);
312ORT_RUNTIME_CLASS(ThreadPoolParams);
313ORT_RUNTIME_CLASS(ThreadingOptions);
314ORT_RUNTIME_CLASS(ArenaCfg);
315ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
316ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
317ORT_RUNTIME_CLASS(NvTensorRtRtxProviderOptions);
318ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
319ORT_RUNTIME_CLASS(CANNProviderOptions);
320ORT_RUNTIME_CLASS(DnnlProviderOptions);
321ORT_RUNTIME_CLASS(Op);
322ORT_RUNTIME_CLASS(OpAttr);
323ORT_RUNTIME_CLASS(Logger);
324ORT_RUNTIME_CLASS(ShapeInferContext);
325ORT_RUNTIME_CLASS(LoraAdapter);
326ORT_RUNTIME_CLASS(ValueInfo);
327ORT_RUNTIME_CLASS(Node);
328ORT_RUNTIME_CLASS(Graph);
329ORT_RUNTIME_CLASS(Model);
330ORT_RUNTIME_CLASS(ModelCompilationOptions);
331ORT_RUNTIME_CLASS(HardwareDevice);
332ORT_RUNTIME_CLASS(EpDevice);
333ORT_RUNTIME_CLASS(KeyValuePairs);
334ORT_RUNTIME_CLASS(SyncStream); // Opaque class to create an onnxruntime::Stream.
335ORT_RUNTIME_CLASS(ExternalInitializerInfo);
336ORT_RUNTIME_CLASS(ExternalResourceImporter); // Capability object for external resource import
337ORT_RUNTIME_CLASS(ExternalMemoryHandle); // EP-imported view of shared external allocation
338ORT_RUNTIME_CLASS(ExternalSemaphoreHandle); // EP-imported view of shared external semaphore
339ORT_RUNTIME_CLASS(DeviceEpIncompatibilityDetails);
340ORT_RUNTIME_CLASS(EpAssignedSubgraph);
341ORT_RUNTIME_CLASS(EpAssignedNode);
342
343#ifdef _MSC_VER
344typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
345#else
347#endif
348
355typedef struct OrtAllocator {
356 uint32_t version;
357
359 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
360
362 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
363
365 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
376 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
377
403 ORT_API2_STATUS(GetStats, _In_ const struct OrtAllocator* this_, _Outptr_ OrtKeyValuePairs** out);
404
420 void*(ORT_API_CALL* AllocOnStream)(struct OrtAllocator* this_, size_t size, OrtSyncStream* stream);
422
423typedef void(ORT_API_CALL* OrtLoggingFunction)(
424 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
425 const char* message);
426
439
444
457
458struct OrtKernelInfo;
460struct OrtKernelContext;
462struct OrtCustomOp;
464
471
474// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
485
491
500
506
518
528
548typedef OrtStatus*(ORT_API_CALL* EpSelectionDelegate)(_In_ const OrtEpDevice** ep_devices,
549 _In_ size_t num_devices,
550 _In_ const OrtKeyValuePairs* model_metadata,
551 _In_opt_ const OrtKeyValuePairs* runtime_metadata,
552 _Inout_ const OrtEpDevice** selected,
553 _In_ size_t max_selected,
554 _Out_ size_t* num_selected,
555 _In_ void* state);
556
567typedef OrtStatus*(ORT_API_CALL* OrtWriteBufferFunc)(_In_ void* state,
568 _In_ const void* buffer,
569 _In_ size_t buffer_num_bytes);
570
602 _In_ void* state,
603 _In_ const char* initializer_name,
604 _In_ const OrtValue* initializer_value,
605 _In_opt_ const OrtExternalInitializerInfo* external_info,
606 _Outptr_result_maybenull_ OrtExternalInitializerInfo** new_external_info);
607
611 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
612 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
613 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
615
702
791
798 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
799 void* user_compute_stream; // user specified CUDA compute stream.
800 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
801 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
802 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
803 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
804 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
805 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
806 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
807 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
808 int trt_dla_core; // DLA core number. Default 0
809 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
810 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
811 const char* trt_engine_cache_path; // specify engine cache path
812 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
813 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
814 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
815 // This is the legacy struct and don't add new fields here.
816 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
817 // For non-string field, need to create a new separate api to handle it.
819
825 int device_id; // hip device id.
826 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
827 int migraphx_fp8_enable; // MIGraphX FP8 precision. Default 0 = false, nonzero = true
828 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
829 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, nonzero = true
830 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
831 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, nonzero = true
832 const char* migraphx_save_model_path; // migraphx model path name
833 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, nonzero = true
834 const char* migraphx_load_model_path; // migraphx model path name
835 bool migraphx_exhaustive_tune; // MIGraphX tuned compile. Default = false, nonzero = true
836
842
850
851 // This is the legacy struct and don't add new fields here.
853
864#ifdef __cplusplus
873#endif
878 const char* device_type;
880 const char* device_id;
882 const char* cache_dir; // path is set to empty by default
883 void* context;
885 unsigned char enable_dynamic_shapes;
887
888struct OrtApi;
889typedef struct OrtApi OrtApi;
890
891struct OrtTrainingApi;
893
894struct OrtModelEditorApi;
896
897struct OrtCompileApi;
899
900struct OrtInteropApi;
902
903struct OrtEpApi;
904typedef struct OrtEpApi OrtEpApi;
905
920 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
921
926 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
927};
928
929typedef struct OrtApiBase OrtApiBase;
930
935ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
936
942typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
943
947
953typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
954
960typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
961
962typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
963
971typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
972
985
1001
1009
1022
1036
1085
1102
1103/*
1104 * Public enum for compiled model compatibility across EPs.
1105 */
1112
1121 uint32_t version;
1122
1134
1141 const char* log_id;
1142
1153
1160
1174
1194
1195 //
1196 // End of fields available in ORT 1.24
1197 //
1198
1200
1208struct OrtApi {
1211
1219 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1220
1226 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1227
1233 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1234
1238
1249 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1250
1265 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
1266 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1267
1275 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
1283 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
1284
1288
1298 // TODO: document the path separator convention? '/' vs '\'
1299 // TODO: should specify the access characteristics of model_path. Is this read only during the
1300 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
1301 // and continue to access throughout the OrtSession lifetime?
1302 // What sort of access is needed to model_path : read or read/write?
1303 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
1304 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1305
1316 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env,
1317 _In_ const void* model_data, size_t model_data_length,
1318 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1319
1338 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
1339 _In_reads_(input_len) const char* const* input_names,
1340 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
1341 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
1342 _Inout_updates_all_(output_names_len) OrtValue** outputs);
1343
1347
1363 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
1364
1372 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
1373 _In_ const ORTCHAR_T* optimized_model_filepath);
1374
1382 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
1383 _Outptr_ OrtSessionOptions** out_options);
1384
1396 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
1397
1405 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
1406
1413 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
1414
1428 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
1429
1438 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
1439
1448 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
1449
1456 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
1457
1465 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
1466
1476 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1477
1485 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1486
1495 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1496 GraphOptimizationLevel graph_optimization_level);
1497
1511 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1512
1525 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1526
1530
1538 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1539
1549 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1550
1554
1564 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1565
1582 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1583
1587
1599 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1600
1612 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1613
1623 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1624
1633 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1634
1643 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1644
1653 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1654
1664 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1665
1675 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1676
1686 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1687 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1688
1692
1699 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1700
1710 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1711
1719 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1720
1730 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1731
1741 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1742 _Out_ int* log_verbosity_level);
1743
1751 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1752
1764 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1765
1774 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1775
1784 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1785
1789
1802 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1804
1822 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1823 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1824 _Outptr_ OrtValue** out);
1825
1833 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1834
1845 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1846
1855 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1856
1866 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1867
1887 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1888 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1889
1893
1902 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1903 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1904
1912 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1913
1917
1925
1934
1943 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1944
1954 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1956
1966 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1967
1976 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1977 size_t dim_values_length);
1978
1987 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1988 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1989
2006 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
2007
2011
2019 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
2020
2028 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
2029
2037 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
2038
2042
2053 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
2054 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
2055
2066 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
2067 _Outptr_ OrtMemoryInfo** out);
2068
2079 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
2080
2088 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
2089
2092 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
2093
2096 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
2097
2100 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
2101
2105
2107 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
2109 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
2111 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
2112
2121 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
2122
2126
2138 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
2139 _In_ int64_t dim_value);
2140
2144
2145 /* Internal information (not seen in Doxygen)
2146 *
2147 * APIs to support non-tensor types - map and sequence.
2148 * Currently only the following types are supported
2149 * Note: the following types should be kept in sync with data_types.h
2150 * Map types
2151 * =========
2152 * std::map<std::string, std::string>
2153 * std::map<std::string, int64_t>
2154 * std::map<std::string, float>
2155 * std::map<std::string, double>
2156 * std::map<int64_t, std::string>
2157 * std::map<int64_t, int64_t>
2158 * std::map<int64_t, float>
2159 * std::map<int64_t, double>
2160 *
2161 * Sequence types
2162 * ==============
2163 * std::vector<std::string>
2164 * std::vector<int64_t>
2165 * std::vector<float>
2166 * std::vector<double>
2167 * std::vector<std::map<std::string, float>>
2168 * std::vector<std::map<int64_t, float>
2169 */
2170
2185 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
2186 _Outptr_ OrtValue** out);
2187
2198 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
2199
2215 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
2216 enum ONNXType value_type, _Outptr_ OrtValue** out);
2217
2240 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
2241 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
2242
2257 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
2258 _Out_ void* data_container, size_t data_container_size);
2259
2264
2273 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2274 _Out_ float* out);
2275
2284 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2285 _Out_ int64_t* out);
2286
2307 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
2308 _Inout_ size_t* size);
2309
2314
2319 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2320
2325 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2326
2338 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
2339 _Out_ const OrtValue** out);
2340
2354 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
2355 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
2356
2360 ORT_CLASS_RELEASE(Env);
2364 ORT_CLASS_RELEASE(Status);
2368 ORT_CLASS_RELEASE(MemoryInfo);
2372 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
2376 ORT_CLASS_RELEASE(Value);
2380 ORT_CLASS_RELEASE(RunOptions);
2384 ORT_CLASS_RELEASE(TypeInfo);
2388 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
2392 ORT_CLASS_RELEASE(SessionOptions);
2396 ORT_CLASS_RELEASE(CustomOpDomain);
2397
2401
2414 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
2415 _Out_ size_t* len);
2416
2430 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
2431 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
2432
2446 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
2447 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
2448
2452
2464 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
2465
2474 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2475
2479
2490 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2491 _Outptr_ OrtTypeInfo** type_info);
2492
2496 ORT_CLASS_RELEASE(MapTypeInfo);
2500 ORT_CLASS_RELEASE(SequenceTypeInfo);
2501
2505
2516 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2517
2525 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2526
2530
2539 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2540 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2541
2550 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2551 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2552
2561 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2562 _Outptr_ char** value);
2563
2572 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2573 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2574
2585 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2586 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2587
2595 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2596
2597 ORT_CLASS_RELEASE(ModelMetadata);
2598
2602
2616 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2617 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2618
2622
2632 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2633
2637
2643 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2644
2645 ORT_CLASS_RELEASE(ThreadingOptions);
2646
2650
2662 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2663 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2664
2668
2676 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2677 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2678 _In_ int64_t dim_value);
2679
2683
2695 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2696
2705 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2706 _In_ int providers_length);
2707
2711
2720 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2721
2731 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2732
2741 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2742
2746
2759 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2760 _In_z_ const char* config_key, _In_z_ const char* config_value);
2761
2765
2776 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2777 _Outptr_ OrtAllocator** out);
2778
2781 ORT_CLASS_RELEASE(Allocator);
2782
2786
2797 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2798
2810 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2811
2815
2818 ORT_CLASS_RELEASE(IoBinding);
2819
2830 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2831
2842 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2843
2859 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2860
2878 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2879 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2880
2898 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2899 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2900
2903 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2904
2907 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2908
2912
2927 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2928
2932
2947 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2948 _In_ const OrtArenaCfg* arena_cfg);
2949
2961 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2962
2966
2976 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2977
2981
2993 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2994
3006 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
3007
3021 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
3022
3026
3041 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
3042 _In_ const OrtValue* val);
3043
3047
3063 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
3064 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
3065
3069
3080 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
3081
3092 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
3093
3104 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
3105
3109
3120 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
3121
3125
3138 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
3139 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
3140
3141 ORT_CLASS_RELEASE(ArenaCfg);
3142
3146
3158 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
3159 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
3160
3164
3175 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
3176
3180
3191 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
3192
3203 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
3204
3209
3232 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
3233 _Out_ float* out, _Inout_ size_t* size);
3234
3256 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
3257 _Out_ int64_t* out, _Inout_ size_t* size);
3258
3262
3294 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
3295 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
3296 _Outptr_ OrtArenaCfg** out);
3297
3301
3314 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
3315 _In_z_ const char* config_key, _In_z_ const char* config_value);
3316
3320
3334
3339 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
3340
3344
3362 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
3363 _In_ const OrtSessionOptions* options,
3364 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3365 _Outptr_ OrtSession** out);
3366
3385 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
3386 _In_ const void* model_data, size_t model_data_length,
3387 _In_ const OrtSessionOptions* options,
3388 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3389 _Outptr_ OrtSession** out);
3390
3394
3413 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
3414
3418
3426
3442 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
3443 _In_reads_(num_keys) const char* const* provider_options_keys,
3444 _In_reads_(num_keys) const char* const* provider_options_values,
3445 _In_ size_t num_keys);
3446
3458 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3459
3464 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
3465
3469
3476 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
3477
3481
3497 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3498
3509 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3510 _In_ const OrtMemoryInfo* mem_info);
3511
3515
3524 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3525
3542 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3543 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3544
3562 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3563 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3564 _In_ const int64_t* indices_data, size_t indices_num);
3565
3585 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3586 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3587 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3588 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3589
3608 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3609 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3610 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3611 _In_ const int32_t* indices_data);
3612
3637 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3638 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3639 _In_ const int64_t* values_shape, size_t values_shape_len,
3641
3656 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3657
3674 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3675 _Inout_ int64_t* outer_data, size_t outer_num);
3676
3690 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3691
3699 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3700
3708 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3709
3717 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3718
3728 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3729
3739 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3743
3756 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3757
3762
3774 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3775
3779
3785 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3786
3790
3800 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3801
3803
3806
3813 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3814
3822 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3823
3831 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3833
3836
3843 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3844
3852 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3853
3861 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3863
3872 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3873
3882 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3883
3886
3907 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3908
3912
3921 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3922
3940 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3941 _In_reads_(num_keys) const char* const* provider_options_keys,
3942 _In_reads_(num_keys) const char* const* provider_options_values,
3943 _In_ size_t num_keys);
3944
3959 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3960
3967 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3968
3970
3983 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3984
4006 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
4007 _In_reads_(num_initializers) const char* const* initializer_names,
4008 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
4009
4021 ORT_API2_STATUS(CreateOpAttr,
4022 _In_ const char* name,
4023 _In_ const void* data,
4024 _In_ int len,
4025 _In_ OrtOpAttrType type,
4026 _Outptr_ OrtOpAttr** op_attr);
4027
4028 /* \brief: Release op attribute
4029 *
4030 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
4031 *
4032 * \since Version 1.12.
4033 */
4034 ORT_CLASS_RELEASE(OpAttr);
4035
4053 ORT_API2_STATUS(CreateOp,
4054 _In_ const OrtKernelInfo* info,
4055 _In_z_ const char* op_name,
4056 _In_z_ const char* domain,
4057 int version,
4058 _In_reads_(type_constraint_count) const char** type_constraint_names,
4059 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
4060 int type_constraint_count,
4061 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
4062 int attr_count,
4063 int input_count,
4064 int output_count,
4065 _Outptr_ OrtOp** ort_op);
4066
4079 ORT_API2_STATUS(InvokeOp,
4080 _In_ const OrtKernelContext* context,
4081 _In_ const OrtOp* ort_op,
4082 _In_ const OrtValue* const* input_values,
4083 _In_ int input_count,
4084 _Inout_ OrtValue* const* output_values,
4085 _In_ int output_count);
4086
4087 /* \brief: Release an onnxruntime operator
4088 *
4089 * \param[in] Op Operator created by OrtApi::CreateOp
4090 *
4091 * \since Version 1.12.
4092 */
4093 ORT_CLASS_RELEASE(Op);
4094
4217 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
4218 _In_ const char* provider_name,
4219 _In_reads_(num_keys) const char* const* provider_options_keys,
4220 _In_reads_(num_keys) const char* const* provider_options_values,
4221 _In_ size_t num_keys);
4222
4223 /* \brief: Get a copy of kernel info
4224 *
4225 * \param[in] info Kernel info
4226 * \param[out] info_copy Copy of kernel info
4227 *
4228 * \since Version 1.12.
4229 */
4230 ORT_API2_STATUS(CopyKernelInfo,
4231 _In_ const OrtKernelInfo* info,
4232 _Outptr_ OrtKernelInfo** info_copy);
4233
4234 /* \brief: Release kernel info
4235 *
4236 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
4237 *
4238 * \since Version 1.12.
4239 */
4240 ORT_CLASS_RELEASE(KernelInfo);
4241
4244
4258 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
4259
4261
4274 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
4275
4284 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
4285
4297 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
4298 _In_reads_(num_keys) const char* const* provider_options_keys,
4299 _In_reads_(num_keys) const char* const* provider_options_values,
4300 _In_ size_t num_keys);
4301
4315 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
4316 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4317
4324 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
4325
4326 /* \brief Get OrtDevice type from MemoryInfo
4327 *
4328 * \since Version 1.14
4329 */
4330 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
4331
4332 /* \brief Update the OrtEnv instance with custom log severity level
4333 *
4334 * \param[in] ort_env The OrtEnv instance being used
4335 * \param[in] log_severity_level The log severity level.
4336 *
4337 * \since Version 1.14.
4338 */
4339 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
4340
4341 /* \brief Set affinities for intra op threads
4342 *
4343 * Affinity string follows format:
4344 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
4345 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
4346 * e.g. 1,2,3;4,5
4347 * specifies affinities for two threads, with the 1st thread attach to the 1st, 2nd, and 3rd processor, and 2nd thread to the 4th and 5th.
4348 * To ease the configuration, an "interval" is also allowed:
4349 * e.g. 1-8;8-16;17-24
4350 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
4351 * Note:
4352 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
4353 * ort does not set affinity on the main thread which is started and managed by the calling app;
4354 * 2. For windows, ort will infer the group id from a logical processor id, for example, assuming there are two groups with each has 64 logical processors,
4355 * an id of 64 will be inferred as the last processor of the 1st group, while 65 will be interpreted as the 1st processor of the second group.
4356 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
4357 *
4358 * \since Version 1.14
4359 */
4360 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
4361
4380 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
4381
4406 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
4407 _In_ const char* registration_func_name);
4408
4412
4424 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4425
4437 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4438
4463 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_opt_ char* out,
4464 _Inout_ size_t* size);
4465
4491 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_opt_ char* out,
4492 _Inout_ size_t* size);
4493
4506 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4507 _Outptr_ OrtTypeInfo** type_info);
4508
4521 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4522 _Outptr_ OrtTypeInfo** type_info);
4523
4536 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4537 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4538
4543
4559 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4560 _In_z_ const char* config_key, _Out_ int* out);
4561
4590 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4591 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4592
4594
4607 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4608
4617 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4618
4635 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4636 _In_reads_(num_keys) const char* const* provider_options_keys,
4637 _In_reads_(num_keys) const char* const* provider_options_values,
4638 _In_ size_t num_keys);
4639
4654 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4655
4660 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4661
4665
4688 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_opt_ char* out, _Inout_ size_t* size);
4689
4701 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4702
4707
4719 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4720
4725
4744 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4745 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4746 _In_z_ const char* func_name);
4747
4759 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4760
4762
4776 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4777
4798 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4799 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4800
4817 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4818 _Outptr_ OrtTypeInfo** out);
4819
4830 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4831
4842 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4843
4850 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4851
4854
4863 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4864
4882 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4883 _In_reads_(num_keys) const char* const* provider_options_keys,
4884 _In_reads_(num_keys) const char* const* provider_options_values,
4885 _In_ size_t num_keys);
4886
4901 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4902
4909 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
4910
4924 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type,
4925 _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
4926 _In_reads_(num_keys) const char* const* provider_options_keys, _In_reads_(num_keys) const char* const* provider_options_values, _In_ size_t num_keys);
4927
4946 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
4947 _In_reads_(input_len) const char* const* input_names,
4948 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
4949 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
4950 _Inout_updates_all_(output_names_len) OrtValue** output,
4951 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
4952
4965 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
4966
4977 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
4978
4991 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
4992
5003 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
5004
5016 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
5017 _In_ int resource_id, _Outptr_ void** resource);
5018
5036 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
5037 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
5038
5047 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
5048
5058 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
5059
5069 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
5070
5080 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
5081
5091 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
5092
5106 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
5107
5118 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
5119
5131 ORT_API2_STATUS(KernelContext_ParallelFor, _In_ const OrtKernelContext* context, _In_ void (*fn)(void*, size_t), _In_ size_t total, _In_ size_t num_batch, _In_ void* usr_data);
5132
5147 _In_ OrtSessionOptions* options,
5148 _In_reads_(num_keys) const char* const* provider_options_keys,
5149 _In_reads_(num_keys) const char* const* provider_options_values,
5150 _In_ size_t num_keys);
5151
5166 _In_ OrtSessionOptions* options,
5167 _In_reads_(num_keys) const char* const* provider_options_keys,
5168 _In_reads_(num_keys) const char* const* provider_options_values,
5169 _In_ size_t num_keys);
5170
5182 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
5183
5194 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
5195
5217 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
5218 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
5219 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
5220 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
5221 size_t num_external_initializer_files);
5222
5241 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
5242 _Outptr_ OrtLoraAdapter** out);
5243
5261 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
5262 _Outptr_ OrtLoraAdapter** out);
5263
5266 ORT_CLASS_RELEASE(LoraAdapter);
5267
5284 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
5285
5289
5304 ORT_API2_STATUS(SetEpDynamicOptions, _Inout_ OrtSession* sess, _In_reads_(kv_len) const char* const* keys,
5305 _In_reads_(kv_len) const char* const* values, _In_ size_t kv_len);
5306
5308
5312 ORT_CLASS_RELEASE(ValueInfo);
5313
5317 ORT_CLASS_RELEASE(Node);
5318
5323 ORT_CLASS_RELEASE(Graph);
5324
5329 ORT_CLASS_RELEASE(Model);
5330
5337 ORT_API2_STATUS(GetValueInfoName, _In_ const OrtValueInfo* value_info, _Out_ const char** name);
5338
5345 ORT_API2_STATUS(GetValueInfoTypeInfo, _In_ const OrtValueInfo* value_info, _Outptr_ const OrtTypeInfo** type_info);
5346
5355 const OrtModelEditorApi*(ORT_API_CALL* GetModelEditorApi)(void);
5356
5375 ORT_API2_STATUS(CreateTensorWithDataAndDeleterAsOrtValue, _In_ OrtAllocator* deleter,
5376 _In_ void* p_data, size_t p_data_len,
5377 _In_ const int64_t* shape, size_t shape_len,
5379 _Outptr_ OrtValue** out);
5380
5397 ORT_API2_STATUS(SessionOptionsSetLoadCancellationFlag, _Inout_ OrtSessionOptions* options,
5398 _In_ bool cancel);
5399
5413 const OrtCompileApi*(ORT_API_CALL* GetCompileApi)(void);
5414
5415 //
5416 // OrtKeyValuePairs
5417 //
5418
5427 void(ORT_API_CALL* CreateKeyValuePairs)(_Outptr_ OrtKeyValuePairs** out);
5428
5442 void(ORT_API_CALL* AddKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key, _In_ const char* value);
5443
5453 const char*(ORT_API_CALL* GetKeyValue)(_In_ const OrtKeyValuePairs* kvps, _In_ const char* key);
5454
5464 void(ORT_API_CALL* GetKeyValuePairs)(_In_ const OrtKeyValuePairs* kvps,
5465 _Outptr_ const char* const** keys, _Outptr_ const char* const** values,
5466 _Out_ size_t* num_entries);
5467
5475 void(ORT_API_CALL* RemoveKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key);
5476
5483 ORT_CLASS_RELEASE(KeyValuePairs);
5484
5498 ORT_API2_STATUS(RegisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name,
5499 _In_ const ORTCHAR_T* path);
5500
5515 ORT_API2_STATUS(UnregisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name);
5516
5529 ORT_API2_STATUS(GetEpDevices, _In_ const OrtEnv* env,
5530 _Outptr_ const OrtEpDevice* const** ep_devices, _Out_ size_t* num_ep_devices);
5531
5551 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_V2, _In_ OrtSessionOptions* session_options,
5552 _In_ OrtEnv* env,
5553 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices, _In_ size_t num_ep_devices,
5554 _In_reads_(num_op_options) const char* const* ep_option_keys,
5555 _In_reads_(num_op_options) const char* const* ep_option_vals,
5556 size_t num_ep_options);
5557
5568 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicy, _In_ OrtSessionOptions* session_options,
5570
5581 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicyDelegate, _In_ OrtSessionOptions* session_options,
5582 _In_ EpSelectionDelegate delegate,
5583 _In_opt_ void* delegate_state);
5584
5593
5601 uint32_t(ORT_API_CALL* HardwareDevice_VendorId)(_In_ const OrtHardwareDevice* device);
5602
5610 const char*(ORT_API_CALL* HardwareDevice_Vendor)(_In_ const OrtHardwareDevice* device);
5611
5620 uint32_t(ORT_API_CALL* HardwareDevice_DeviceId)(_In_ const OrtHardwareDevice* device);
5621
5630 const OrtKeyValuePairs*(ORT_API_CALL* HardwareDevice_Metadata)(_In_ const OrtHardwareDevice* device);
5631
5639 const char*(ORT_API_CALL* EpDevice_EpName)(_In_ const OrtEpDevice* ep_device);
5640
5648 const char*(ORT_API_CALL* EpDevice_EpVendor)(_In_ const OrtEpDevice* ep_device);
5649
5657 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpMetadata)(_In_ const OrtEpDevice* ep_device);
5658
5666 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpOptions)(_In_ const OrtEpDevice* ep_device);
5667
5675 const OrtHardwareDevice*(ORT_API_CALL* EpDevice_Device)(_In_ const OrtEpDevice* ep_device);
5676
5681 const OrtEpApi*(ORT_API_CALL* GetEpApi)(void);
5682
5696 ORT_API2_STATUS(GetTensorSizeInBytes, _In_ const OrtValue* ort_value, _Out_ size_t* size);
5697
5712 ORT_API2_STATUS(AllocatorGetStats, _In_ const OrtAllocator* ort_allocator, _Outptr_ OrtKeyValuePairs** out);
5713
5734 ORT_API2_STATUS(CreateMemoryInfo_V2, _In_ const char* name, _In_ enum OrtMemoryInfoDeviceType device_type,
5735 _In_ uint32_t vendor_id, _In_ int32_t device_id, _In_ enum OrtDeviceMemoryType mem_type,
5736 _In_ size_t alignment, enum OrtAllocatorType allocator_type,
5737 _Outptr_ OrtMemoryInfo** out);
5738
5747
5755 ORT_API_T(uint32_t, MemoryInfoGetVendorId, _In_ const OrtMemoryInfo* ptr);
5756
5759
5770 ORT_API2_STATUS(ValueInfo_GetValueProducer, _In_ const OrtValueInfo* value_info,
5771 _Outptr_ const OrtNode** producer_node, _Out_opt_ size_t* producer_output_index);
5772
5788 ORT_API2_STATUS(ValueInfo_GetValueNumConsumers, _In_ const OrtValueInfo* value_info, _Out_ size_t* num_consumers);
5789
5816 ORT_API2_STATUS(ValueInfo_GetValueConsumers, _In_ const OrtValueInfo* value_info,
5817 _Out_writes_all_(num_consumers) const OrtNode** nodes,
5818 _Out_writes_all_(num_consumers) int64_t* input_indices,
5819 _In_ size_t num_consumers);
5820
5840 ORT_API2_STATUS(ValueInfo_GetInitializerValue, _In_ const OrtValueInfo* value_info,
5841 _Outptr_ const OrtValue** initializer_value);
5842
5858 ORT_API2_STATUS(ValueInfo_GetExternalInitializerInfo, _In_ const OrtValueInfo* value_info,
5859 _Outptr_result_maybenull_ OrtExternalInitializerInfo** info);
5860
5875 ORT_API2_STATUS(ValueInfo_IsRequiredGraphInput, _In_ const OrtValueInfo* value_info,
5876 _Out_ bool* is_required_graph_input);
5877
5891 ORT_API2_STATUS(ValueInfo_IsOptionalGraphInput, _In_ const OrtValueInfo* value_info,
5892 _Out_ bool* is_optional_graph_input);
5893
5903 ORT_API2_STATUS(ValueInfo_IsGraphOutput, _In_ const OrtValueInfo* value_info, _Out_ bool* is_graph_output);
5904
5919 ORT_API2_STATUS(ValueInfo_IsConstantInitializer, _In_ const OrtValueInfo* value_info,
5920 _Out_ bool* is_constant_initializer);
5921
5935 ORT_API2_STATUS(ValueInfo_IsFromOuterScope, _In_ const OrtValueInfo* value_info,
5936 _Out_ bool* is_from_outer_scope);
5937
5939
5942
5952 ORT_API2_STATUS(Graph_GetName, _In_ const OrtGraph* graph, _Outptr_ const char** graph_name);
5953
5967 ORT_API2_STATUS(Graph_GetModelPath, _In_ const OrtGraph* graph, _Outptr_ const ORTCHAR_T** model_path);
5968
5978 ORT_API2_STATUS(Graph_GetOnnxIRVersion, _In_ const OrtGraph* graph, _Out_ int64_t* onnx_ir_version);
5979
5993 ORT_API2_STATUS(Graph_GetNumOperatorSets, _In_ const OrtGraph* graph, _Out_ size_t* num_operator_sets);
5994
6015 ORT_API2_STATUS(Graph_GetOperatorSets, _In_ const OrtGraph* graph,
6016 _Out_writes_(num_operator_sets) const char** domains,
6017 _Out_writes_(num_operator_sets) int64_t* opset_versions, _In_ size_t num_operator_sets);
6018
6030 ORT_API2_STATUS(Graph_GetNumInputs, _In_ const OrtGraph* graph, _Out_ size_t* num_inputs);
6031
6046 ORT_API2_STATUS(Graph_GetInputs, _In_ const OrtGraph* graph,
6047 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6048
6058 ORT_API2_STATUS(Graph_GetNumOutputs, _In_ const OrtGraph* graph, _Out_ size_t* num_outputs);
6059
6072 ORT_API2_STATUS(Graph_GetOutputs, _In_ const OrtGraph* graph,
6073 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6074
6086 ORT_API2_STATUS(Graph_GetNumInitializers, _In_ const OrtGraph* graph, _Out_ size_t* num_initializers);
6087
6109 ORT_API2_STATUS(Graph_GetInitializers, _In_ const OrtGraph* graph,
6110 _Out_writes_(num_initializers) const OrtValueInfo** initializers,
6111 _In_ size_t num_initializers);
6112
6122 ORT_API2_STATUS(Graph_GetNumNodes, _In_ const OrtGraph* graph, _Out_ size_t* num_nodes);
6123
6139 ORT_API2_STATUS(Graph_GetNodes, _In_ const OrtGraph* graph,
6140 _Out_writes_(num_nodes) const OrtNode** nodes, _In_ size_t num_nodes);
6141
6155 ORT_API2_STATUS(Graph_GetParentNode, _In_ const OrtGraph* graph, _Outptr_result_maybenull_ const OrtNode** node);
6156
6172 ORT_API2_STATUS(Graph_GetGraphView, _In_ const OrtGraph* src_graph, _In_ const OrtNode** nodes,
6173 _In_ size_t num_nodes, _Outptr_ OrtGraph** dst_graph);
6174
6176
6179
6192 ORT_API2_STATUS(Node_GetId, _In_ const OrtNode* node, _Out_ size_t* node_id);
6193
6203 ORT_API2_STATUS(Node_GetName, _In_ const OrtNode* node, _Outptr_ const char** node_name);
6204
6214 ORT_API2_STATUS(Node_GetOperatorType, _In_ const OrtNode* node, _Outptr_ const char** operator_type);
6215
6225 ORT_API2_STATUS(Node_GetDomain, _In_ const OrtNode* node, _Outptr_ const char** domain_name);
6226
6236 ORT_API2_STATUS(Node_GetSinceVersion, _In_ const OrtNode* node, _Out_ int* since_version);
6237
6247 ORT_API2_STATUS(Node_GetNumInputs, _In_ const OrtNode* node, _Out_ size_t* num_inputs);
6248
6261 ORT_API2_STATUS(Node_GetInputs, _In_ const OrtNode* node,
6262 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6263
6273 ORT_API2_STATUS(Node_GetNumOutputs, _In_ const OrtNode* node, _Out_ size_t* num_outputs);
6274
6287 ORT_API2_STATUS(Node_GetOutputs, _In_ const OrtNode* node,
6288 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6289
6303 ORT_API2_STATUS(Node_GetNumImplicitInputs, _In_ const OrtNode* node, _Out_ size_t* num_implicit_inputs);
6304
6322 ORT_API2_STATUS(Node_GetImplicitInputs, _In_ const OrtNode* node,
6323 _Out_writes_(num_implicit_inputs) const OrtValueInfo** implicit_inputs,
6324 _In_ size_t num_implicit_inputs);
6325
6335 ORT_API2_STATUS(Node_GetNumAttributes, _In_ const OrtNode* node, _Out_ size_t* num_attributes);
6336
6354 ORT_API2_STATUS(Node_GetAttributes, _In_ const OrtNode* node,
6355 _Out_writes_(num_attributes) const OrtOpAttr** attributes, _In_ size_t num_attributes);
6356
6375 ORT_API2_STATUS(Node_GetAttributeByName, _In_ const OrtNode* node, _In_ const char* attribute_name,
6376 _Outptr_result_maybenull_ const OrtOpAttr** attribute);
6377
6388 ORT_API2_STATUS(OpAttr_GetTensorAttributeAsOrtValue, _In_ const OrtOpAttr* attribute,
6389 _Outptr_result_maybenull_ OrtValue** attr_tensor);
6390
6400 ORT_API2_STATUS(OpAttr_GetType, _In_ const OrtOpAttr* attribute, _Out_ OrtOpAttrType* type);
6401
6411 ORT_API2_STATUS(OpAttr_GetName, _In_ const OrtOpAttr* attribute, _Outptr_ const char** name);
6412
6424 ORT_API2_STATUS(Node_GetNumSubgraphs, _In_ const OrtNode* node, _Out_ size_t* num_subgraphs);
6425
6443 ORT_API2_STATUS(Node_GetSubgraphs, _In_ const OrtNode* node,
6444 _Out_writes_(num_subgraphs) const OrtGraph** subgraphs, _In_ size_t num_subgraphs,
6445 _Out_writes_opt_(num_subgraphs) const char** attribute_names);
6446
6462 ORT_API2_STATUS(Node_GetGraph, _In_ const OrtNode* node, _Outptr_result_maybenull_ const OrtGraph** graph);
6463
6475 ORT_API2_STATUS(Node_GetEpName, _In_ const OrtNode* node, _Outptr_result_maybenull_ const char** out);
6476
6478
6481
6488 ORT_CLASS_RELEASE(ExternalInitializerInfo);
6489
6501 ORT_API_T(const ORTCHAR_T*, ExternalInitializerInfo_GetFilePath, _In_ const OrtExternalInitializerInfo* info);
6502
6511
6520
6522
6525
6540 ORT_API_T(const char*, GetRunConfigEntry, _In_ const OrtRunOptions* options,
6541 _In_z_ const char* config_key);
6542
6544
6554 ORT_API_T(const OrtMemoryInfo*, EpDevice_MemoryInfo, _In_ const OrtEpDevice* ep_device,
6555 _In_ OrtDeviceMemoryType memory_type);
6556
6580 ORT_API2_STATUS(CreateSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6581 _In_ OrtDeviceMemoryType mem_type, _In_ OrtAllocatorType allocator_type,
6582 _In_opt_ const OrtKeyValuePairs* allocator_options,
6583 _Outptr_opt_ OrtAllocator** allocator);
6584
6603 ORT_API2_STATUS(GetSharedAllocator, _In_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
6604 _Outptr_result_maybenull_ OrtAllocator** allocator);
6605
6619 ORT_API2_STATUS(ReleaseSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6620 _In_ OrtDeviceMemoryType mem_type);
6621
6634 ORT_API2_STATUS(GetTensorData, _In_ const OrtValue* value, _Outptr_ const void** out);
6635
6646 ORT_API2_STATUS(GetSessionOptionsConfigEntries, _In_ const OrtSessionOptions* options, _Outptr_ OrtKeyValuePairs** out);
6647
6665 ORT_API2_STATUS(SessionGetMemoryInfoForInputs, _In_ const OrtSession* session,
6666 _Out_writes_(num_inputs) const OrtMemoryInfo** inputs_memory_info,
6667 _In_ size_t num_inputs);
6668
6688 ORT_API2_STATUS(SessionGetMemoryInfoForOutputs, _In_ const OrtSession* session,
6689 _Out_writes_(num_outputs) const OrtMemoryInfo** outputs_memory_info,
6690 _In_ size_t num_outputs);
6691
6716 ORT_API2_STATUS(SessionGetEpDeviceForInputs, _In_ const OrtSession* session,
6717 _Out_writes_(num_inputs) const OrtEpDevice** inputs_ep_devices,
6718 _In_ size_t num_inputs);
6719
6735 ORT_API2_STATUS(CreateSyncStreamForEpDevice, _In_ const OrtEpDevice* ep_device,
6736 _In_opt_ const OrtKeyValuePairs* stream_options,
6737 _Outptr_ OrtSyncStream** stream);
6738
6749 ORT_API_T(void*, SyncStream_GetHandle, _In_ OrtSyncStream* stream);
6750
6751 ORT_CLASS_RELEASE(SyncStream);
6752
6777 ORT_API2_STATUS(CopyTensors, _In_ const OrtEnv* env,
6778 _In_reads_(num_tensors) const OrtValue* const* src_tensors,
6779 _In_reads_(num_tensors) OrtValue* const* dst_tensors,
6780 _In_opt_ OrtSyncStream* stream,
6781 _In_ size_t num_tensors);
6782
6792 ORT_API2_STATUS(Graph_GetModelMetadata, _In_ const OrtGraph* graph, _Outptr_ OrtModelMetadata** out);
6793
6806 ORT_API2_STATUS(GetModelCompatibilityForEpDevices,
6807 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices,
6808 _In_ size_t num_ep_devices,
6809 _In_ const char* compatibility_info,
6811
6814
6827 ORT_API2_STATUS(CreateExternalInitializerInfo, _In_ const ORTCHAR_T* filepath, _In_ int64_t file_offset,
6828 _In_ size_t byte_size, _Outptr_ OrtExternalInitializerInfo** out);
6829
6831
6837 ORT_API_T(bool, TensorTypeAndShape_HasShape, _In_ const OrtTensorTypeAndShapeInfo* info);
6838
6854 ORT_API2_STATUS(KernelInfo_GetConfigEntries, _In_ const OrtKernelInfo* info, _Outptr_ OrtKeyValuePairs** out);
6855
6877 ORT_API2_STATUS(KernelInfo_GetOperatorDomain, _In_ const OrtKernelInfo* info, _Out_opt_ char* out,
6878 _Inout_ size_t* size);
6879
6901 ORT_API2_STATUS(KernelInfo_GetOperatorType, _In_ const OrtKernelInfo* info, _Out_opt_ char* out,
6902 _Inout_ size_t* size);
6903
6912 ORT_API2_STATUS(KernelInfo_GetOperatorSinceVersion, _In_ const OrtKernelInfo* info,
6913 _Out_ int* since_version);
6914
6925 const OrtInteropApi*(ORT_API_CALL* GetInteropApi)(void);
6926
6948 ORT_API2_STATUS(SessionGetEpDeviceForOutputs, _In_ const OrtSession* session,
6949 _Out_writes_(num_outputs) const OrtEpDevice** outputs_ep_devices,
6950 _In_ size_t num_outputs);
6963 ORT_API2_STATUS(GetNumHardwareDevices, _In_ const OrtEnv* env, _Out_ size_t* num_devices);
6964
6984 ORT_API2_STATUS(GetHardwareDevices, _In_ const OrtEnv* env,
6985 _Out_writes_(num_devices) const OrtHardwareDevice** devices,
6986 _In_ size_t num_devices);
6987
7009 ORT_API2_STATUS(GetHardwareDeviceEpIncompatibilityDetails, _In_ const OrtEnv* env,
7010 _In_ const char* ep_name,
7011 _In_ const OrtHardwareDevice* hw,
7013
7017
7028 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7029 _Out_ uint32_t* reasons_bitmask);
7030
7042 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7043 _Outptr_result_maybenull_ const char** notes);
7044
7058 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7059 _Out_ int32_t* error_code);
7060
7065 ORT_CLASS_RELEASE(DeviceEpIncompatibilityDetails);
7066
7068
7071
7103 ORT_API2_STATUS(GetCompatibilityInfoFromModel,
7104 _In_ const ORTCHAR_T* model_path,
7105 _In_ const char* ep_type,
7106 _Inout_ OrtAllocator* allocator,
7107 _Outptr_result_maybenull_ char** compatibility_info);
7108
7131 ORT_API2_STATUS(GetCompatibilityInfoFromModelBytes,
7132 _In_reads_(model_data_length) const void* model_data,
7133 _In_ size_t model_data_length,
7134 _In_ const char* ep_type,
7135 _Inout_ OrtAllocator* allocator,
7136 _Outptr_result_maybenull_ char** compatibility_info);
7137
7139
7152 ORT_API2_STATUS(CreateEnvWithOptions, _In_ const OrtEnvCreationOptions* options, _Outptr_ OrtEnv** out);
7153
7183 ORT_API2_STATUS(Session_GetEpGraphAssignmentInfo, _In_ const OrtSession* session,
7184 _Outptr_ const OrtEpAssignedSubgraph* const** ep_subgraphs,
7185 _Out_ size_t* num_ep_subgraphs);
7186
7197 ORT_API2_STATUS(EpAssignedSubgraph_GetEpName, _In_ const OrtEpAssignedSubgraph* ep_subgraph,
7198 _Outptr_ const char** out);
7199
7210 ORT_API2_STATUS(EpAssignedSubgraph_GetNodes, _In_ const OrtEpAssignedSubgraph* ep_subgraph,
7211 _Outptr_ const OrtEpAssignedNode* const** ep_nodes, _Out_ size_t* num_ep_nodes);
7212
7223 ORT_API2_STATUS(EpAssignedNode_GetName, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7224
7235 ORT_API2_STATUS(EpAssignedNode_GetDomain, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7236
7247 ORT_API2_STATUS(EpAssignedNode_GetOperatorType, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7248
7260 ORT_API_T(void, RunOptionsSetSyncStream, _Inout_ OrtRunOptions* options, _In_ OrtSyncStream* sync_stream);
7261
7282 ORT_API2_STATUS(GetTensorElementTypeAndShapeDataReference, _In_ const OrtValue* value,
7283 _Out_ ONNXTensorElementDataType* elem_type,
7284 _Outptr_result_maybenull_ const int64_t** shape_data,
7285 _Out_ size_t* shape_data_count);
7286
7297 ORT_API2_STATUS(RunOptionsEnableProfiling, _Inout_ OrtRunOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
7298
7307 ORT_API2_STATUS(RunOptionsDisableProfiling, _Inout_ OrtRunOptions* options);
7308
7328 ORT_API2_STATUS(KernelInfoGetAttributeArray_string, _In_ const OrtKernelInfo* info, _In_ const char* name,
7329 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*size) char*** out, _Out_ size_t* size);
7330};
7331
7332/*
7333 * Steps to use a custom op:
7334 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
7335 * 2 Create an OrtCustomOp structure for each op and add them to the domain
7336 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
7337 */
7338
7339// Specifies some characteristics of inputs/outputs of custom ops:
7340// Specify if the inputs/outputs are one of:
7341// 1) Non-optional (input/output must be present in the node)
7342// 2) Optional (input/output may be absent in the node)
7343// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
7344// Only the last input or output of a custom op may be marked as variadic.
7345// The homogeneity of the variadic input or output determines whether all operands must be of the same
7346// tensor element type.
7352
7353/*
7354 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
7355 * the implementor of the custom op.
7356 */
7358 uint32_t version; // Must be initialized to ORT_API_VERSION
7359
7360 // This callback creates the kernel, which is a user defined
7361 // parameter that is passed to the Kernel* callbacks below. It is
7362 // recommended to use CreateKernelV2 which allows for a safe error
7363 // propagation by returning an OrtStatusPtr.
7364 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
7365 _In_ const OrtKernelInfo* info);
7366
7367 // Returns the name of the op
7368 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
7369
7370 // Returns the type of the execution provider, return nullptr to use CPU execution provider
7371 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
7372
7373 // Returns the count and types of the input & output tensors
7374 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7375 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
7376 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7377 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
7378
7379 // Perform a computation step. It is recommended to use
7380 // KernelComputeV2 which allows for a safe error propagation by
7381 // returning an OrtStatusPtr.
7382 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
7383 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
7384
7385 // Returns the characteristics of the input & output tensors
7386 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7387 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7388
7389 // Returns the memory type of the input tensors. This API allows the custom op
7390 // to place the inputs on specific devices. By default, it returns
7391 // OrtMemTypeDefault, which means the input is placed on the default device for
7392 // the execution provider. If the inputs need to be with different memory types,
7393 // this function can be overridden to return the specific memory types.
7394 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7395
7396 // Returns the minimum number of input arguments expected for the variadic input.
7397 // Applicable only for custom ops that have a variadic input.
7398 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
7399
7400 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
7401 // and false (zero) otherwise.
7402 // Applicable only for custom ops that have a variadic input.
7403 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
7404
7405 // Returns the minimum number of output values expected for the variadic output.
7406 // Applicable only for custom ops that have a variadic output.
7407 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
7408
7409 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
7410 // and false (zero) otherwise.
7411 // Applicable only for custom ops that have a variadic output.
7412 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
7413
7414 // Create the kernel state which is passed to each compute call.
7415 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
7416 _In_ const OrtKernelInfo* info,
7417 _Out_ void** kernel);
7418
7419 // Perform the computation step.
7420 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
7421
7422 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
7423
7424 // Get start range
7425 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
7426 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
7427
7428 // Get the inplace_map that defines which output can reuse which input
7429 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
7430 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
7431 // The return value is the size of these 2 arrays.
7432 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
7433 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
7434
7435 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
7436 // If GetMayInplace() is defined, this function MUST be defined as well.
7437 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
7438
7439 // Same as GetMayInplace() and ReleaseMayInplace()
7440 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
7441 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
7442};
7443
7456 // Model building/editing requires a full build. We return nullptr from GetModelEditorApi if this is a minimal
7457 // build, so it doesn't matter if there are no function pointers in this struct as a user will never get an
7458 // OrtModelEditorApi instance. We do however need a dummy field to avoid empty struct warning.
7459#if defined(ORT_MINIMAL_BUILD)
7460 const bool not_defined_in_this_build;
7461#else
7475 ORT_API2_STATUS(CreateTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
7476 _Outptr_ OrtTypeInfo** type_info);
7477
7491 ORT_API2_STATUS(CreateSparseTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
7492 _Outptr_ OrtTypeInfo** type_info);
7493
7508 ORT_API2_STATUS(CreateMapTypeInfo, ONNXTensorElementDataType map_key_type, _In_ const OrtTypeInfo* map_value_type,
7509 _Outptr_ OrtTypeInfo** type_info);
7510
7524 ORT_API2_STATUS(CreateSequenceTypeInfo, _In_ const OrtTypeInfo* sequence_type, _Outptr_ OrtTypeInfo** type_info);
7525
7539 ORT_API2_STATUS(CreateOptionalTypeInfo, _In_ const OrtTypeInfo* contained_type, _Outptr_ OrtTypeInfo** type_info);
7540
7551 ORT_API2_STATUS(CreateValueInfo, _In_ const char* name, _In_ const OrtTypeInfo* type_info,
7552 _Outptr_ OrtValueInfo** value_info);
7553
7575 ORT_API2_STATUS(CreateNode, _In_ const char* operator_name, _In_ const char* domain_name, _In_ const char* node_name,
7576 _In_reads_(input_names_len) const char* const* input_names, size_t input_names_len,
7577 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
7578 _In_reads_(attribs_len) _In_opt_ OrtOpAttr** attributes, _In_ size_t attribs_len,
7579 _Outptr_ OrtNode** node);
7580
7585 ORT_API2_STATUS(CreateGraph, _Outptr_ OrtGraph** graph);
7586
7600 ORT_API2_STATUS(SetGraphInputs, _Inout_ OrtGraph* graph,
7601 _In_reads_(inputs_len) _In_ OrtValueInfo** inputs, _In_ size_t inputs_len);
7602
7616 ORT_API2_STATUS(SetGraphOutputs, _Inout_ OrtGraph* graph,
7617 _In_reads_(outputs_len) _In_ OrtValueInfo** outputs, _In_ size_t outputs_len);
7618
7657 ORT_API2_STATUS(AddInitializerToGraph, _Inout_ OrtGraph* graph, _In_ const char* name, _In_ OrtValue* tensor,
7658 bool data_is_external);
7659
7671 ORT_API2_STATUS(AddNodeToGraph, _Inout_ OrtGraph* graph, _In_ OrtNode* node);
7672
7691 ORT_API2_STATUS(CreateModel,
7692 _In_reads_(opset_entries_len) const char* const* domain_names,
7693 _In_reads_(opset_entries_len) const int* opset_versions,
7694 size_t opset_entries_len,
7695 _Outptr_ OrtModel** model);
7696
7710 ORT_API2_STATUS(AddGraphToModel, _Inout_ OrtModel* model, _In_ OrtGraph* graph);
7711
7730 ORT_API2_STATUS(CreateSessionFromModel, _In_ const OrtEnv* env, _In_ const OrtModel* model,
7731 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
7732
7755 ORT_API2_STATUS(CreateModelEditorSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
7756 _In_ const OrtSessionOptions* options,
7757 _Outptr_ OrtSession** out);
7758
7783 ORT_API2_STATUS(CreateModelEditorSessionFromArray, _In_ const OrtEnv* env,
7784 _In_ const void* model_data, size_t model_data_length,
7785 _In_ const OrtSessionOptions* options,
7786 _Outptr_ OrtSession** out);
7787
7802 ORT_API2_STATUS(SessionGetOpsetForDomain, _In_ const OrtSession* session, _In_ const char* domain, _Out_ int* opset);
7803
7822 ORT_API2_STATUS(ApplyModelToModelEditorSession, _Inout_ OrtSession* session, _In_ OrtModel* model);
7823
7837 ORT_API2_STATUS(FinalizeModelEditorSession, _Inout_ OrtSession* session, _In_ const OrtSessionOptions* options,
7838 _In_opt_ OrtPrepackedWeightsContainer* prepacked_weights_container);
7839#endif // !defined(ORT_MINIMAL_BUILD)
7840};
7841
7849 // Default. Do not enable any additional compilation options.
7851
7852 // Force compilation to return an error (ORT_FAIL) if no nodes were compiled.
7853 // Otherwise, a model with basic optimizations (ORT_ENABLE_BASIC) is still generated by default.
7855
7856 // Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists.
7857 // Otherwise, compilation will automatically overwrite the output file if it exists.
7860
7887 ORT_CLASS_RELEASE(ModelCompilationOptions);
7888
7907 ORT_API2_STATUS(CreateModelCompilationOptionsFromSessionOptions, _In_ const OrtEnv* env,
7908 _In_ const OrtSessionOptions* session_options, _Outptr_ OrtModelCompilationOptions** out);
7909
7922 ORT_API2_STATUS(ModelCompilationOptions_SetInputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
7923 _In_ const ORTCHAR_T* input_model_path);
7924
7939 _In_ OrtModelCompilationOptions* model_compile_options,
7940 _In_ const void* input_model_data,
7941 size_t input_model_data_size);
7942
7960 ORT_API2_STATUS(ModelCompilationOptions_SetOutputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
7961 _In_ const ORTCHAR_T* output_model_path);
7962
7979 _In_ OrtModelCompilationOptions* model_compile_options,
7980 _In_ const ORTCHAR_T* external_initializers_file_path,
7981 size_t external_initializers_size_threshold);
7982
8005 _In_ OrtModelCompilationOptions* model_compile_options,
8006 _Inout_ OrtAllocator* allocator,
8007 _Outptr_ void** output_model_buffer_ptr,
8008 _Out_ size_t* output_model_buffer_size_ptr);
8009
8032 ORT_API2_STATUS(ModelCompilationOptions_SetEpContextEmbedMode, _In_ OrtModelCompilationOptions* model_compile_options,
8033 bool embed_ep_context_in_model);
8034
8044 ORT_API2_STATUS(CompileModel, _In_ const OrtEnv* env, _In_ const OrtModelCompilationOptions* model_options);
8045
8055 ORT_API2_STATUS(ModelCompilationOptions_SetFlags, _In_ OrtModelCompilationOptions* model_compile_options,
8056 uint32_t flags);
8057
8072 _In_ OrtModelCompilationOptions* model_compile_options,
8073 _In_ const ORTCHAR_T* output_directory,
8074 _In_ const ORTCHAR_T* model_name);
8075
8086 _In_ OrtModelCompilationOptions* model_compile_options,
8087 _In_ GraphOptimizationLevel graph_optimization_level);
8088
8107 _In_ OrtModelCompilationOptions* model_compile_options,
8108 _In_ OrtWriteBufferFunc write_func, _In_ void* state);
8109
8123 _In_ OrtModelCompilationOptions* model_compile_options,
8124 _In_ OrtGetInitializerLocationFunc get_initializer_location_func, _In_ void* state);
8125
8146 _In_ OrtModelCompilationOptions* model_compile_options,
8147 _In_ const OrtModel* model);
8148};
8149
8183
8203 _In_ const OrtEpDevice* ep_device,
8204 _Outptr_result_maybenull_ OrtExternalResourceImporter** out_importer);
8205
8212 ORT_CLASS_RELEASE(ExternalResourceImporter);
8213
8217
8228 ORT_API2_STATUS(CanImportMemory,
8229 _In_ const OrtExternalResourceImporter* importer,
8230 _In_ OrtExternalMemoryHandleType handle_type,
8231 _Out_ bool* out_supported);
8232
8244 ORT_API2_STATUS(ImportMemory,
8245 _In_ OrtExternalResourceImporter* importer,
8246 _In_ const OrtExternalMemoryDescriptor* desc,
8247 _Outptr_ OrtExternalMemoryHandle** out_handle);
8248
8255 ORT_CLASS_RELEASE(ExternalMemoryHandle);
8256
8272 ORT_API2_STATUS(CreateTensorFromMemory,
8273 _In_ OrtExternalResourceImporter* importer,
8274 _In_ const OrtExternalMemoryHandle* mem_handle,
8275 _In_ const OrtExternalTensorDescriptor* tensor_desc,
8276 _Outptr_ OrtValue** out_tensor);
8277
8281
8292 ORT_API2_STATUS(CanImportSemaphore,
8293 _In_ const OrtExternalResourceImporter* importer,
8294 _In_ OrtExternalSemaphoreType type,
8295 _Out_ bool* out_supported);
8296
8310 ORT_API2_STATUS(ImportSemaphore,
8311 _In_ OrtExternalResourceImporter* importer,
8312 _In_ const OrtExternalSemaphoreDescriptor* desc,
8313 _Outptr_ OrtExternalSemaphoreHandle** out_handle);
8314
8321 ORT_CLASS_RELEASE(ExternalSemaphoreHandle);
8322
8338 ORT_API2_STATUS(WaitSemaphore,
8339 _In_ OrtExternalResourceImporter* importer,
8340 _In_ OrtExternalSemaphoreHandle* semaphore_handle,
8341 _In_ OrtSyncStream* stream,
8342 _In_ uint64_t value);
8343
8359 ORT_API2_STATUS(SignalSemaphore,
8360 _In_ OrtExternalResourceImporter* importer,
8361 _In_ OrtExternalSemaphoreHandle* semaphore_handle,
8362 _In_ OrtSyncStream* stream,
8363 _In_ uint64_t value);
8364
8368
8390 ORT_API2_STATUS(InitGraphicsInteropForEpDevice, _In_ const OrtEpDevice* ep_device,
8391 _In_ const OrtGraphicsInteropConfig* config);
8392
8409 ORT_API2_STATUS(DeinitGraphicsInteropForEpDevice, _In_ const OrtEpDevice* ep_device);
8410
8412};
8413
8414/*
8415 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
8416 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
8417 *
8418 * \param device_id CUDA device id, starts from zero.
8419 */
8420ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
8421
8422/*
8423 * This is the old way to add the ROCm provider to the session, please use
8424 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
8425 * This function always exists, but will only succeed if Onnxruntime was built with
8426 * HIP support and the ROCm provider shared library exists
8427 *
8428 * \param device_id HIP device id, starts from zero.
8429 */
8430ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
8431
8432/*
8433 * This is the old way to add the MIGraphX provider to the session, please use
8434 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
8435 * This function always exists, but will only succeed if Onnxruntime was built with
8436 * HIP support and the MIGraphX provider shared library exists
8437 *
8438 * \param device_id HIP device id, starts from zero.
8439 */
8440ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
8441
8442/*
8443 * This is the old way to add the oneDNN provider to the session, please use
8444 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
8445 * This function always exists, but will only succeed if Onnxruntime was built with
8446 * oneDNN support and the oneDNN provider shared library exists
8447 *
8448 * \param use_arena zero: false. non-zero: true.
8449 */
8450ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
8451
8452/*
8453 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
8454 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
8455 *
8456 * \param device_id CUDA device id, starts from zero.
8457 */
8458ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
8459
8460#ifdef __cplusplus
8461}
8462#endif
8464
8465#include "onnxruntime_ep_c_api.h"
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:299
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:325
struct OrtHardwareDevice OrtHardwareDevice
Definition onnxruntime_c_api.h:331
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:459
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:327
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Tensorrt(OrtSessionOptions *options, int device_id)
struct OrtEpAssignedNode OrtEpAssignedNode
Definition onnxruntime_c_api.h:341
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:249
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:494
struct OrtModelCompilationOptions OrtModelCompilationOptions
Definition onnxruntime_c_api.h:330
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:324
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:423
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:960
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:962
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:7347
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:316
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:322
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:313
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:307
OrtGraphicsApi
Graphics API type for interop configuration.
Definition onnxruntime_c_api.h:1031
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:448
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:326
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:320
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:238
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:315
OrtExternalMemoryHandleType
External memory handle type for importing GPU resources.
Definition onnxruntime_c_api.h:981
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:301
OrtCompiledModelCompatibility
Definition onnxruntime_c_api.h:1106
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:548
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:310
OrtExternalSemaphoreType
External semaphore type for GPU synchronization.
Definition onnxruntime_c_api.h:1006
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:300
struct OrtExternalInitializerInfo OrtExternalInitializerInfo
Definition onnxruntime_c_api.h:335
OrtAllocatorType
Definition onnxruntime_c_api.h:465
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:321
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:311
OrtDeviceEpIncompatibilityReason
Reasons why an execution provider might not be compatible with a device.
Definition onnxruntime_c_api.h:521
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:304
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:305
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:318
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:461
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:610
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:319
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:332
struct OrtExternalResourceImporter OrtExternalResourceImporter
Definition onnxruntime_c_api.h:336
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:971
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:303
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:501
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:329
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:328
struct OrtSyncStream OrtSyncStream
Definition onnxruntime_c_api.h:334
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:942
struct OrtEpAssignedSubgraph OrtEpAssignedSubgraph
Definition onnxruntime_c_api.h:340
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:308
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:309
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:487
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:302
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:567
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:432
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:333
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:346
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:475
OrtSparseFormat
Definition onnxruntime_c_api.h:230
ONNXType
Definition onnxruntime_c_api.h:218
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:297
OrtErrorCode
Definition onnxruntime_c_api.h:257
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:298
struct OrtDeviceEpIncompatibilityDetails OrtDeviceEpIncompatibilityDetails
Definition onnxruntime_c_api.h:339
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:601
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:323
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:306
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:314
ExecutionMode
Definition onnxruntime_c_api.h:440
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:275
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:953
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:184
OrtCompileApiFlags
Flags representing options to enable when compiling a model.
Definition onnxruntime_c_api.h:7848
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:509
const OrtApiBase * OrtGetApiBase(void)
The Onnxruntime library's entry point to access the C API.
@ ORT_LOGGING_LEVEL_VERBOSE
Verbose informational messages (least severe).
Definition onnxruntime_c_api.h:250
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition onnxruntime_c_api.h:251
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition onnxruntime_c_api.h:253
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:252
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition onnxruntime_c_api.h:254
@ OrtMemoryInfoDeviceType_GPU
Definition onnxruntime_c_api.h:496
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:497
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:495
@ OrtMemoryInfoDeviceType_NPU
Definition onnxruntime_c_api.h:498
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:7350
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:7348
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:7349
@ ORT_GRAPHICS_API_D3D12
Definition onnxruntime_c_api.h:1033
@ ORT_GRAPHICS_API_VULKAN
Definition onnxruntime_c_api.h:1034
@ ORT_GRAPHICS_API_NONE
Definition onnxruntime_c_api.h:1032
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:449
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:452
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:450
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:454
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:451
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:453
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:455
@ ORT_SPARSE_COO_INDICES
Definition onnxruntime_c_api.h:239
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition onnxruntime_c_api.h:242
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition onnxruntime_c_api.h:241
@ ORT_SPARSE_CSR_INNER_INDICES
Definition onnxruntime_c_api.h:240
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE
Definition onnxruntime_c_api.h:982
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP
Definition onnxruntime_c_api.h:983
@ OrtCompiledModelCompatibility_EP_SUPPORTED_PREFER_RECOMPILATION
Definition onnxruntime_c_api.h:1109
@ OrtCompiledModelCompatibility_EP_NOT_APPLICABLE
Definition onnxruntime_c_api.h:1107
@ OrtCompiledModelCompatibility_EP_SUPPORTED_OPTIMAL
Definition onnxruntime_c_api.h:1108
@ OrtCompiledModelCompatibility_EP_UNSUPPORTED
Definition onnxruntime_c_api.h:1110
@ ORT_EXTERNAL_SEMAPHORE_D3D12_FENCE
Definition onnxruntime_c_api.h:1007
@ OrtDeviceAllocator
Definition onnxruntime_c_api.h:467
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:468
@ OrtReadOnlyAllocator
Definition onnxruntime_c_api.h:469
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:466
@ OrtDeviceEpIncompatibility_DEVICE_INCOMPATIBLE
Definition onnxruntime_c_api.h:524
@ OrtDeviceEpIncompatibility_MISSING_DEPENDENCY
Definition onnxruntime_c_api.h:525
@ OrtDeviceEpIncompatibility_DRIVER_INCOMPATIBLE
Definition onnxruntime_c_api.h:523
@ OrtDeviceEpIncompatibility_NONE
Definition onnxruntime_c_api.h:522
@ OrtDeviceEpIncompatibility_UNKNOWN
Definition onnxruntime_c_api.h:526
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:613
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:611
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:612
@ OrtHardwareDeviceType_CPU
Definition onnxruntime_c_api.h:502
@ OrtHardwareDeviceType_NPU
Definition onnxruntime_c_api.h:504
@ OrtHardwareDeviceType_GPU
Definition onnxruntime_c_api.h:503
@ OrtDeviceMemoryType_HOST_ACCESSIBLE
Shared/pinned memory for transferring between CPU and the device.
Definition onnxruntime_c_api.h:489
@ OrtDeviceMemoryType_DEFAULT
Device memory.
Definition onnxruntime_c_api.h:488
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:434
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:437
@ ORT_ENABLE_LAYOUT
Definition onnxruntime_c_api.h:436
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:433
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:435
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:477
@ OrtMemTypeCPU
CPU accessible memory allocated by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:481
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:483
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:479
@ ORT_SPARSE_CSRC
Definition onnxruntime_c_api.h:233
@ ORT_SPARSE_COO
Definition onnxruntime_c_api.h:232
@ ORT_SPARSE_BLOCK_SPARSE
Definition onnxruntime_c_api.h:234
@ ORT_SPARSE_UNDEFINED
Definition onnxruntime_c_api.h:231
@ ONNX_TYPE_SEQUENCE
Definition onnxruntime_c_api.h:221
@ ONNX_TYPE_MAP
Definition onnxruntime_c_api.h:222
@ ONNX_TYPE_OPAQUE
Definition onnxruntime_c_api.h:223
@ ONNX_TYPE_UNKNOWN
Definition onnxruntime_c_api.h:219
@ ONNX_TYPE_TENSOR
Definition onnxruntime_c_api.h:220
@ ONNX_TYPE_SPARSETENSOR
Definition onnxruntime_c_api.h:224
@ ONNX_TYPE_OPTIONAL
Definition onnxruntime_c_api.h:225
@ ORT_MODEL_LOAD_CANCELED
Definition onnxruntime_c_api.h:270
@ ORT_NO_SUCHFILE
Definition onnxruntime_c_api.h:261
@ ORT_OK
Definition onnxruntime_c_api.h:258
@ ORT_INVALID_ARGUMENT
Definition onnxruntime_c_api.h:260
@ ORT_EP_FAIL
Definition onnxruntime_c_api.h:269
@ ORT_NOT_IMPLEMENTED
Definition onnxruntime_c_api.h:267
@ ORT_RUNTIME_EXCEPTION
Definition onnxruntime_c_api.h:264
@ ORT_ENGINE_ERROR
Definition onnxruntime_c_api.h:263
@ ORT_FAIL
Definition onnxruntime_c_api.h:259
@ ORT_NOT_FOUND
Definition onnxruntime_c_api.h:272
@ ORT_MODEL_REQUIRES_COMPILATION
Definition onnxruntime_c_api.h:271
@ ORT_INVALID_PROTOBUF
Definition onnxruntime_c_api.h:265
@ ORT_NO_MODEL
Definition onnxruntime_c_api.h:262
@ ORT_INVALID_GRAPH
Definition onnxruntime_c_api.h:268
@ ORT_MODEL_LOADED
Definition onnxruntime_c_api.h:266
@ ORT_PARALLEL
Definition onnxruntime_c_api.h:442
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:441
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:277
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:280
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:282
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:276
@ ORT_OP_ATTR_GRAPH
Definition onnxruntime_c_api.h:283
@ ORT_OP_ATTR_TENSOR
Definition onnxruntime_c_api.h:284
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:278
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:281
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:279
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition onnxruntime_c_api.h:193
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition onnxruntime_c_api.h:191
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition onnxruntime_c_api.h:197
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT2
Definition onnxruntime_c_api.h:213
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition onnxruntime_c_api.h:189
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition onnxruntime_c_api.h:185
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition onnxruntime_c_api.h:200
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ
Definition onnxruntime_c_api.h:206
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition onnxruntime_c_api.h:198
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4
Definition onnxruntime_c_api.h:208
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition onnxruntime_c_api.h:192
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT4E2M1
Definition onnxruntime_c_api.h:211
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2
Definition onnxruntime_c_api.h:205
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition onnxruntime_c_api.h:194
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition onnxruntime_c_api.h:195
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition onnxruntime_c_api.h:187
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition onnxruntime_c_api.h:190
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition onnxruntime_c_api.h:196
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition onnxruntime_c_api.h:188
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:186
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN
Definition onnxruntime_c_api.h:203
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition onnxruntime_c_api.h:201
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4
Definition onnxruntime_c_api.h:209
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition onnxruntime_c_api.h:199
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ
Definition onnxruntime_c_api.h:204
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT2
Definition onnxruntime_c_api.h:214
@ OrtCompileApiFlags_NONE
Definition onnxruntime_c_api.h:7850
@ OrtCompileApiFlags_ERROR_IF_NO_NODES_COMPILED
Definition onnxruntime_c_api.h:7854
@ OrtCompileApiFlags_ERROR_IF_OUTPUT_FILE_EXISTS
Definition onnxruntime_c_api.h:7858
@ OrtExecutionProviderDevicePolicy_DEFAULT
Definition onnxruntime_c_api.h:510
@ OrtExecutionProviderDevicePolicy_PREFER_CPU
Definition onnxruntime_c_api.h:511
@ OrtExecutionProviderDevicePolicy_MAX_PERFORMANCE
Definition onnxruntime_c_api.h:514
@ OrtExecutionProviderDevicePolicy_PREFER_NPU
Definition onnxruntime_c_api.h:512
@ OrtExecutionProviderDevicePolicy_MAX_EFFICIENCY
Definition onnxruntime_c_api.h:515
@ OrtExecutionProviderDevicePolicy_PREFER_GPU
Definition onnxruntime_c_api.h:513
@ OrtExecutionProviderDevicePolicy_MIN_OVERALL_POWER
Definition onnxruntime_c_api.h:516
Memory allocation interface.
Definition onnxruntime_c_api.h:355
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:362
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:365
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:356
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition onnxruntime_c_api.h:359
void *(* AllocOnStream)(struct OrtAllocator *this_, size_t size, OrtSyncStream *stream)
Allocate using a stream.
Definition onnxruntime_c_api.h:420
void *(* Reserve)(struct OrtAllocator *this_, size_t size)
Optional allocation function to use for memory allocations made during session initialization....
Definition onnxruntime_c_api.h:376
OrtStatus * GetStats(const struct OrtAllocator *this_, OrtKeyValuePairs **out)
Function used to get the statistics of the allocator.
The helper interface to get the right version of OrtApi.
Definition onnxruntime_c_api.h:910
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:926
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:920
The C API.
Definition onnxruntime_c_api.h:1208
OrtStatus * SetGlobalIntraOpThreadAffinity(OrtThreadingOptions *tp_options, const char *affinity_string)
OrtStatus * ShapeInferContext_SetOutputTypeShape(const OrtShapeInferContext *context, size_t index, const OrtTensorTypeAndShapeInfo *info)
OrtStatus * SessionGetOverridableInitializerTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get overridable initializer type information.
OrtStatus * SessionOptionsSetCustomJoinThreadFn(OrtSessionOptions *options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Set custom thread join function.
OrtStatus * KernelInfoGetAttributeArray_int64(const OrtKernelInfo *info, const char *name, int64_t *out, size_t *size)
Fetch an array of int64_t values stored as an attribute in the graph node.
OrtStatus * Graph_GetNumInputs(const OrtGraph *graph, size_t *num_inputs)
Returns the number of graph inputs.
OrtStatus * Node_GetOperatorType(const OrtNode *node, const char **operator_type)
Returns a node's operator type (e.g., "Conv").
OrtStatus * CreateSessionOptions(OrtSessionOptions **options)
Create an OrtSessionOptions object.
OrtHardwareDeviceType(* HardwareDevice_Type)(const OrtHardwareDevice *device)
Get the hardware device type.
Definition onnxruntime_c_api.h:5592
void(* ReleaseDnnlProviderOptions)(OrtDnnlProviderOptions *input)
Release an OrtDnnlProviderOptions.
Definition onnxruntime_c_api.h:4660
OrtStatus * GetTensorData(const OrtValue *value, const void **out)
Get a const pointer to the raw data inside a tensor.
OrtStatus * TensorAt(OrtValue *value, const int64_t *location_values, size_t location_values_count, void **out)
Direct memory access to a specified tensor element.
OrtStatus * KernelInfoGetAttribute_float(const OrtKernelInfo *info, const char *name, float *out)
Get a float stored as an attribute in the graph node.
OrtStatus * GetCANNProviderOptionsAsString(const OrtCANNProviderOptions *cann_options, OrtAllocator *allocator, char **ptr)
Get serialized CANN provider options string.
OrtStatus * InvokeOp(const OrtKernelContext *context, const OrtOp *ort_op, const OrtValue *const *input_values, int input_count, OrtValue *const *output_values, int output_count)
: Invoke the operator created by OrtApi::CreateOp The inputs must follow the order as specified in on...
OrtStatus * HasSessionConfigEntry(const OrtSessionOptions *options, const char *config_key, int *out)
Checks if the given session configuration entry exists.
const char *(* GetBuildInfoString)(void)
Returns a null terminated string of the build info including git info and cxx flags.
Definition onnxruntime_c_api.h:4850
OrtStatus * AddExternalInitializersFromFilesInMemory(OrtSessionOptions *options, const char *const *external_initializer_file_names, char *const *external_initializer_file_buffer_array, const size_t *external_initializer_file_lengths, size_t num_external_initializer_files)
Replace initialized Tensors with external data with the provided files in memory.
OrtStatus * ValueInfo_IsFromOuterScope(const OrtValueInfo *value_info, bool *is_from_outer_scope)
Returns a boolean indicating if the given value is defined in an outer scope.
OrtStatus * GetTensorMemoryInfo(const OrtValue *value, const OrtMemoryInfo **mem_info)
Returns a pointer to the OrtMemoryInfo of a Tensor.
OrtStatus * EnableCpuMemArena(OrtSessionOptions *options)
Enable the memory arena on CPU.
OrtStatus * CreateSparseTensorWithValuesAsOrtValue(const OrtMemoryInfo *info, void *p_data, const int64_t *dense_shape, size_t dense_shape_len, const int64_t *values_shape, size_t values_shape_len, ONNXTensorElementDataType type, OrtValue **out)
OrtStatus * GetValueCount(const OrtValue *value, size_t *out)
Get non tensor value count from an OrtValue.
OrtStatus * SetGlobalCustomJoinThreadFn(OrtThreadingOptions *tp_options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Set custom thread join function for global thread pools.
OrtStatus * CreateCUDAProviderOptions(OrtCUDAProviderOptionsV2 **out)
Create an OrtCUDAProviderOptionsV2.
OrtStatus * DisableProfiling(OrtSessionOptions *options)
Disable profiling for a session.
OrtStatus * KernelInfoGetAttributeArray_float(const OrtKernelInfo *info, const char *name, float *out, size_t *size)
Fetch an array of int64_t values stored as an attribute in the graph node.
OrtStatus * CreatePrepackedWeightsContainer(OrtPrepackedWeightsContainer **out)
Create an OrtPrepackedWeightsContainer.
OrtStatus * SetDeterministicCompute(OrtSessionOptions *options, bool value)
Set whether to use deterministic compute.
OrtStatus * UpdateTensorRTProviderOptionsWithValue(OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *key, void *value)
OrtStatus * CreateSessionFromArrayWithPrepackedWeightsContainer(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container, OrtSession **out)
Create session from memory with prepacked weights container.
OrtStatus * AddFreeDimensionOverrideByName(OrtSessionOptions *options, const char *dim_name, int64_t dim_value)
OrtStatus * GetSharedAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info, OrtAllocator **allocator)
Get a shared allocator from the OrtEnv.
OrtStatus * KernelInfo_GetInputCount(const OrtKernelInfo *info, size_t *out)
Get the number of inputs from OrtKernelInfo.
OrtStatus * Graph_GetOperatorSets(const OrtGraph *graph, const char **domains, int64_t *opset_versions, size_t num_operator_sets)
Returns the operator sets that the graph's model uses.
OrtStatus * GetSparseTensorFormat(const OrtValue *ort_value, enum OrtSparseFormat *out)
Returns sparse tensor format enum iff a given ort value contains an instance of sparse tensor.
OrtStatus * KernelContext_GetGPUComputeStream(const OrtKernelContext *context, void **out)
Used for custom operators, gets the GPU compute stream to use to launch the custom a GPU kernel.
OrtStatus * UpdateCANNProviderOptions(OrtCANNProviderOptions *cann_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CANN Execution Provider.
OrtStatus * GetTensorSizeInBytes(const OrtValue *ort_value, size_t *size)
Compute total size in bytes of the tensor data contained in an OrtValue.
const OrtEpApi *(* GetEpApi)(void)
Get the OrtEpApi instance for implementing an execution provider.
Definition onnxruntime_c_api.h:5681
OrtStatus * GetCompatibilityInfoFromModel(const char *model_path, const char *ep_type, OrtAllocator *allocator, char **compatibility_info)
Extract EP compatibility info from a precompiled model file.
OrtStatus * CreateAndRegisterAllocatorV2(OrtEnv *env, const char *provider_type, const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Create an allocator with specific type and register it with the OrtEnv This API enhance CreateAndRegi...
OrtStatus * SessionGetOutputName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get output name.
OrtStatus * SessionOptionsAppendExecutionProvider_TensorRT(OrtSessionOptions *options, const OrtTensorRTProviderOptions *tensorrt_options)
Append TensorRT provider to session options.
const char *(* HardwareDevice_Vendor)(const OrtHardwareDevice *device)
Get the hardware device's vendor name.
Definition onnxruntime_c_api.h:5610
OrtStatus * Node_GetAttributeByName(const OrtNode *node, const char *attribute_name, const OrtOpAttr **attribute)
Gets the OrtNode's attribute as OrtOpAttr by name.
const OrtTrainingApi *(* GetTrainingApi)(uint32_t version)
Gets the Training C Api struct.
Definition onnxruntime_c_api.h:4258
OrtStatus * SetIntraOpNumThreads(OrtSessionOptions *options, int intra_op_num_threads)
Sets the number of threads used to parallelize the execution within nodes.
OrtStatus * GetTypeInfo(const OrtValue *value, OrtTypeInfo **out)
Get type information of an OrtValue.
OrtStatus * AllocatorGetStats(const OrtAllocator *ort_allocator, OrtKeyValuePairs **out)
Calls OrtAllocator::GetStats function.
OrtStatus * CastTypeInfoToMapTypeInfo(const OrtTypeInfo *type_info, const OrtMapTypeInfo **out)
Get detailed map information from an OrtTypeInfo.
OrtStatus * KernelContext_GetLogger(const OrtKernelContext *context, const OrtLogger **logger)
Get the runtime logger from OrtKernelContext.
OrtStatus * SetGlobalCustomThreadCreationOptions(OrtThreadingOptions *tp_options, void *ort_custom_thread_creation_options)
Set custom thread creation options for global thread pools.
OrtStatus * AddSessionConfigEntry(OrtSessionOptions *options, const char *config_key, const char *config_value)
Set a session configuration entry as a pair of strings.
OrtStatus * SetGlobalDenormalAsZero(OrtThreadingOptions *tp_options)
Set threading flush-to-zero and denormal-as-zero.
void(* ClearBoundInputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Inputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2903
const char *(* GetRunConfigEntry)(const OrtRunOptions *options, const char *config_key)
Get a run configuration entry.
Definition onnxruntime_c_api.h:6541
OrtStatus * KernelInfo_GetInputTypeInfo(const OrtKernelInfo *info, size_t index, OrtTypeInfo **type_info)
Get the type information for a OrtKernelInfo's input.
OrtStatus * Graph_GetOnnxIRVersion(const OrtGraph *graph, int64_t *onnx_ir_version)
Returns the ONNX IR version.
OrtStatus * KernelInfoGetAttribute_string(const OrtKernelInfo *info, const char *name, char *out, size_t *size)
Fetch a string stored as an attribute in the graph node.
OrtStatus * Graph_GetName(const OrtGraph *graph, const char **graph_name)
Returns a graph's name.
OrtStatus * GetSparseTensorIndicesTypeShape(const OrtValue *ort_value, enum OrtSparseIndicesFormat indices_format, OrtTensorTypeAndShapeInfo **out)
Returns data type, shape for the type of indices specified by indices_format.
OrtStatus * SessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, const OrtMIGraphXProviderOptions *migraphx_options)
Append MIGraphX provider to session options.
OrtStatus * RunOptionsSetRunLogVerbosityLevel(OrtRunOptions *options, int log_verbosity_level)
Set per-run log verbosity level.
OrtStatus * AddInitializer(OrtSessionOptions *options, const char *name, const OrtValue *val)
Add a pre-allocated initializer to a session.
OrtStatus * CreateEnv(OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * UseCooIndices(OrtValue *ort_value, int64_t *indices_data, size_t indices_num)
OrtStatus * GetTensorMutableData(OrtValue *value, void **out)
Get a pointer to the raw data inside a tensor.
OrtStatus * CreateExternalInitializerInfo(const char *filepath, int64_t file_offset, size_t byte_size, OrtExternalInitializerInfo **out)
Creates an OrtExternalInitializerInfo instance.
OrtStatus * KernelInfoGetAllocator(const OrtKernelInfo *info, OrtMemType mem_type, OrtAllocator **out)
Get allocator from KernelInfo for a specific memory type. Please use C API ReleaseAllocator to releas...
OrtStatus * SessionOptionsAppendExecutionProvider_OpenVINO(OrtSessionOptions *options, const OrtOpenVINOProviderOptions *provider_options)
Append OpenVINO execution provider to the session options.
OrtStatus * IsSparseTensor(const OrtValue *value, int *out)
Sets *out to 1 iff an OrtValue is a SparseTensor, and 0 otherwise.
OrtStatus * SessionOptionsAppendExecutionProvider_V2(OrtSessionOptions *session_options, OrtEnv *env, const OrtEpDevice *const *ep_devices, size_t num_ep_devices, const char *const *ep_option_keys, const char *const *ep_option_vals, size_t num_ep_options)
Append the execution provider that is responsible for the selected OrtEpDevice instances to the sessi...
void(* GetKeyValuePairs)(const OrtKeyValuePairs *kvps, const char *const **keys, const char *const **values, size_t *num_entries)
Get all the key-value pairs from the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5464
OrtStatus * GetTensorElementType(const OrtTensorTypeAndShapeInfo *info, enum ONNXTensorElementDataType *out)
Get element type in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionOptionsSetEpSelectionPolicyDelegate(OrtSessionOptions *session_options, EpSelectionDelegate delegate, void *delegate_state)
Set the execution provider selection policy delegate for the session.
OrtStatus * CreateSparseTensorAsOrtValue(OrtAllocator *allocator, const int64_t *dense_shape, size_t dense_shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create an OrtValue with a sparse tensor that is empty.
OrtStatus * FillStringTensorElement(OrtValue *value, const char *s, size_t index)
Set a single string in a string tensor.
OrtStatus * CreateTensorWithDataAsOrtValue(const OrtMemoryInfo *info, void *p_data, size_t p_data_len, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create a tensor backed by a user supplied buffer.
OrtStatus * AddExternalInitializers(OrtSessionOptions *options, const char *const *initializer_names, const OrtValue *const *initializers, size_t num_initializers)
Replace initialized Tensors with external data with the data provided in initializers.
OrtStatus * SessionOptionsSetEpSelectionPolicy(OrtSessionOptions *session_options, OrtExecutionProviderDevicePolicy policy)
Set the execution provider selection policy for the session.
const OrtHardwareDevice *(* EpDevice_Device)(const OrtEpDevice *ep_device)
Get the OrtHardwareDevice instance for the OrtEpDevice.
Definition onnxruntime_c_api.h:5675
OrtStatus * ModelMetadataGetGraphDescription(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
OrtStatus * UpdateDnnlProviderOptions(OrtDnnlProviderOptions *dnnl_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a oneDNN Execution Provider.
OrtStatus * GetStringTensorElementLength(const OrtValue *value, size_t index, size_t *out)
Get the length of a single string in a string tensor.
OrtStatus * GetTensorElementTypeAndShapeDataReference(const OrtValue *value, ONNXTensorElementDataType *elem_type, const int64_t **shape_data, size_t *shape_data_count)
Get the element data type and shape for an OrtValue that represents a Tensor (scalar,...
uint32_t(* MemoryInfoGetVendorId)(const OrtMemoryInfo *ptr)
Get the vendor id from OrtMemoryInfo.
Definition onnxruntime_c_api.h:5755
OrtStatus * Node_GetNumOutputs(const OrtNode *node, size_t *num_outputs)
Returns the number of node outputs.
void(* MemoryInfoGetDeviceType)(const OrtMemoryInfo *ptr, OrtMemoryInfoDeviceType *out)
Definition onnxruntime_c_api.h:4330
OrtStatus * AddRunConfigEntry(OrtRunOptions *options, const char *config_key, const char *config_value)
Set a single run configuration entry as a pair of strings.
OrtStatus * GetBoundOutputValues(const OrtIoBinding *binding_ptr, OrtAllocator *allocator, OrtValue ***output, size_t *output_count)
Get the output OrtValue objects from an OrtIoBinding.
OrtStatus * ModelMetadataGetDomain(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get domain from an OrtModelMetadata.
OrtStatus * SetLanguageProjection(const OrtEnv *ort_env, OrtLanguageProjection projection)
Set language projection.
OrtStatus * GetSessionOptionsConfigEntries(const OrtSessionOptions *options, OrtKeyValuePairs **out)
Get Session configuration entries.
OrtStatus * FillStringTensor(OrtValue *value, const char *const *s, size_t s_len)
Set all strings at once in a string tensor.
OrtStatus * KernelInfoGetAttributeArray_string(const OrtKernelInfo *info, const char *name, OrtAllocator *allocator, char ***out, size_t *size)
Fetch an array of strings stored as an attribute in the graph node.
OrtStatus * Node_GetInputs(const OrtNode *node, const OrtValueInfo **inputs, size_t num_inputs)
Returns the node's inputs as OrtValueInfo instances.
OrtStatus * SetSessionLogId(OrtSessionOptions *options, const char *logid)
Set session log id.
OrtStatus * GetValueInfoTypeInfo(const OrtValueInfo *value_info, const OrtTypeInfo **type_info)
Get the type information from an OrtValueInfo instance.
OrtStatus * SessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, const OrtCUDAProviderOptions *cuda_options)
Append CUDA provider to session options.
OrtStatus * SessionGetMemoryInfoForOutputs(const OrtSession *session, const OrtMemoryInfo **outputs_memory_info, size_t num_outputs)
Get the OrtMemoryInfo for each output of the session.
OrtStatus * RegisterAllocator(OrtEnv *env, OrtAllocator *allocator)
Register a custom allocator.
OrtStatus * SetGlobalSpinControl(OrtThreadingOptions *tp_options, int allow_spinning)
Set global spin control options.
OrtStatus * MemoryInfoGetId(const OrtMemoryInfo *ptr, int *out)
Get the device id from OrtMemoryInfo.
const OrtMemoryInfo *(* EpDevice_MemoryInfo)(const OrtEpDevice *ep_device, OrtDeviceMemoryType memory_type)
Get the OrtMemoryInfo for the device.
Definition onnxruntime_c_api.h:6555
OrtStatus * KernelInfo_GetOutputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's output.
OrtStatus * Node_GetAttributes(const OrtNode *node, const OrtOpAttr **attributes, size_t num_attributes)
Returns a node's attributes as OrtOpAttr instances.
OrtStatus * Logger_LogMessage(const OrtLogger *logger, OrtLoggingLevel log_severity_level, const char *message, const char *file_path, int line_number, const char *func_name)
Logs a message at the given severity level using the provided OrtLogger.
OrtStatus * Graph_GetInputs(const OrtGraph *graph, const OrtValueInfo **inputs, size_t num_inputs)
Returns the graph's inputs as OrtValueInfo instances.
OrtStatus * CreateEnvWithCustomLogger(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * UpdateCUDAProviderOptionsWithValue(OrtCUDAProviderOptionsV2 *cuda_options, const char *key, void *value)
OrtStatus * MemoryInfoGetName(const OrtMemoryInfo *ptr, const char **out)
Get name from OrtMemoryInfo.
OrtStatus * Logger_GetLoggingSeverityLevel(const OrtLogger *logger, OrtLoggingLevel *out)
Get the logging severity level of the OrtLogger.
OrtStatus * GetExecutionProviderApi(const char *provider_name, uint32_t version, const void **provider_api)
Get a pointer to the requested version of the Execution Provider specific API extensions to the OrtAp...
OrtStatus * KernelContext_GetOutputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the output count of a kernel.
void(* RunOptionsSetSyncStream)(OrtRunOptions *options, OrtSyncStream *sync_stream)
Sets OrtSyncStream for the run options.
Definition onnxruntime_c_api.h:7260
OrtStatus * GetTensorShapeElementCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get total number of elements in a tensor shape from an OrtTensorTypeAndShapeInfo.
OrtStatus * GetModelCompatibilityForEpDevices(const OrtEpDevice *const *ep_devices, size_t num_ep_devices, const char *compatibility_info, OrtCompiledModelCompatibility *out_status)
Validate a compiled model's compatibility information for one or more EP devices.
OrtStatus * CastTypeInfoToTensorInfo(const OrtTypeInfo *type_info, const OrtTensorTypeAndShapeInfo **out)
Get OrtTensorTypeAndShapeInfo from an OrtTypeInfo.
OrtStatus * GetOptionalContainedTypeInfo(const OrtOptionalTypeInfo *optional_type_info, OrtTypeInfo **out)
Get OrtTypeInfo for the allowed contained type from an OrtOptionalTypeInfo.
OrtStatus * CreateOp(const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, int type_constraint_count, const OrtOpAttr *const *attr_values, int attr_count, int input_count, int output_count, OrtOp **ort_op)
: Create onnxruntime native operator
OrtStatus * MemoryInfoGetType(const OrtMemoryInfo *ptr, OrtAllocatorType *out)
Get the OrtAllocatorType from OrtMemoryInfo.
OrtStatus * HasValue(const OrtValue *value, int *out)
Sets out to 1 iff an optional type OrtValue has an element, 0 otherwise (OrtValue is None) Use this A...
OrtStatus * CreateEnvWithGlobalThreadPools(OrtLoggingLevel log_severity_level, const char *logid, const OrtThreadingOptions *tp_options, OrtEnv **out)
Create an OrtEnv.
OrtStatus * ValueInfo_GetValueNumConsumers(const OrtValueInfo *value_info, size_t *num_consumers)
Get the number of consumers of a value as a node input.
OrtStatus * KernelContext_GetAllocator(const OrtKernelContext *context, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Get Allocator from KernelContext for a specific memoryInfo. Please use C API ReleaseAllocator to rele...
OrtStatus * KernelInfoGetConstantInput_tensor(const OrtKernelInfo *info, size_t index, int *is_constant, const OrtValue **out)
Get a OrtValue tensor stored as a constant initializer in the graph node.
OrtStatus * GetCUDAProviderOptionsAsString(const OrtCUDAProviderOptionsV2 *cuda_options, OrtAllocator *allocator, char **ptr)
OrtStatus * ValueInfo_IsConstantInitializer(const OrtValueInfo *value_info, bool *is_constant_initializer)
Returns a boolean indicating if the given value is a constant initializer.
OrtStatus * UpdateCUDAProviderOptions(OrtCUDAProviderOptionsV2 *cuda_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CUDA Execution Provider.
OrtStatus * CopyKernelInfo(const OrtKernelInfo *info, OrtKernelInfo **info_copy)
OrtStatus * Graph_GetModelMetadata(const OrtGraph *graph, OrtModelMetadata **out)
Get OrtModelMetadata from an OrtGraph.
OrtStatus * RunOptionsDisableProfiling(OrtRunOptions *options)
Disable profiling for this run.
OrtStatus * GetTensorRTProviderOptionsAsString(const OrtTensorRTProviderOptionsV2 *tensorrt_options, OrtAllocator *allocator, char **ptr)
Get serialized TensorRT provider options string.
int64_t(* ExternalInitializerInfo_GetFileOffset)(const OrtExternalInitializerInfo *info)
Get the byte offset within the file where the initializer's data is stored.
Definition onnxruntime_c_api.h:6510
OrtStatus * SessionOptionsSetCustomThreadCreationOptions(OrtSessionOptions *options, void *ort_custom_thread_creation_options)
Set creation options for custom thread.
OrtStatus * GetDimensionsCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get dimension count in OrtTensorTypeAndShapeInfo.
OrtStatus * KernelInfo_GetConfigEntries(const OrtKernelInfo *info, OrtKeyValuePairs **out)
Get all config entries from OrtKernelInfo.
OrtStatus * Session_GetEpGraphAssignmentInfo(const OrtSession *session, const OrtEpAssignedSubgraph *const **ep_subgraphs, size_t *num_ep_subgraphs)
Get information about the subgraphs assigned to each execution provider (EP) and the nodes within.
void(* ReleaseROCMProviderOptions)(OrtROCMProviderOptions *input)
Release an OrtROCMProviderOptions.
Definition onnxruntime_c_api.h:4909
OrtStatus * UpdateROCMProviderOptions(OrtROCMProviderOptions *rocm_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a ROCm Execution Provider.
OrtStatus * KernelInfo_GetInputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's input.
OrtStatus * KernelContext_GetResource(const OrtKernelContext *context, int resource_version, int resource_id, void **resource)
OrtStatus * RegisterCustomOpsLibrary(OrtSessionOptions *options, const char *library_path, void **library_handle)
OrtStatus * Node_GetNumAttributes(const OrtNode *node, size_t *num_attributes)
Returns the number of node attributes.
OrtStatus * SetCurrentGpuDeviceId(int device_id)
Set current GPU device ID.
OrtStatus * Node_GetNumInputs(const OrtNode *node, size_t *num_inputs)
Returns the number of node inputs.
OrtStatus * GetOnnxTypeFromTypeInfo(const OrtTypeInfo *type_info, enum ONNXType *out)
Get ONNXType from OrtTypeInfo.
OrtStatus * CreateMemoryInfo_V2(const char *name, enum OrtMemoryInfoDeviceType device_type, uint32_t vendor_id, int32_t device_id, enum OrtDeviceMemoryType mem_type, size_t alignment, enum OrtAllocatorType allocator_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo.
OrtStatus * GetEpDevices(const OrtEnv *env, const OrtEpDevice *const **ep_devices, size_t *num_ep_devices)
Get the list of available OrtEpDevice instances.
OrtStatus * CreateLoraAdapterFromArray(const void *bytes, size_t num_bytes, OrtAllocator *allocator, OrtLoraAdapter **out)
Create an OrtLoraAdapter.
OrtStatus * DeviceEpIncompatibilityDetails_GetErrorCode(const OrtDeviceEpIncompatibilityDetails *details, int32_t *error_code)
Get the execution provider error code from OrtDeviceEpIncompatibilityDetails.
const OrtInteropApi *(* GetInteropApi)(void)
Get the EP Interop API instance.
Definition onnxruntime_c_api.h:6925
OrtStatus * GetDenotationFromTypeInfo(const OrtTypeInfo *type_info, const char **const denotation, size_t *len)
Get denotation from type information.
OrtStatus * KernelContext_ParallelFor(const OrtKernelContext *context, void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data)
OrtStatus * RunOptionsEnableProfiling(OrtRunOptions *options, const char *profile_file_prefix)
Enable profiling for this run.
void(* ReleaseCANNProviderOptions)(OrtCANNProviderOptions *input)
Release an OrtCANNProviderOptions.
Definition onnxruntime_c_api.h:4324
OrtStatus * SetGlobalInterOpNumThreads(OrtThreadingOptions *tp_options, int inter_op_num_threads)
Set global inter-op thread count.
OrtStatus * CloneSessionOptions(const OrtSessionOptions *in_options, OrtSessionOptions **out_options)
Create a copy of an existing OrtSessionOptions.
OrtStatus * GetSessionConfigEntry(const OrtSessionOptions *options, const char *config_key, char *config_value, size_t *size)
Get a session configuration value.
OrtStatus * SessionOptionsAppendExecutionProvider_TensorRT_V2(OrtSessionOptions *options, const OrtTensorRTProviderOptionsV2 *tensorrt_options)
Append TensorRT execution provider to the session options.
OrtStatus * AddFreeDimensionOverride(OrtSessionOptions *options, const char *dim_denotation, int64_t dim_value)
Override session symbolic dimensions.
OrtStatus * KernelContext_GetOutput(OrtKernelContext *context, size_t index, const int64_t *dim_values, size_t dim_count, OrtValue **out)
Used for custom operators, get an output of a kernel.
OrtStatus * ValueInfo_GetInitializerValue(const OrtValueInfo *value_info, const OrtValue **initializer_value)
Get the underlying initializer value, as an OrtValue, from the given OrtValueInfo.
OrtStatus * EnableTelemetryEvents(const OrtEnv *env)
Enable Telemetry.
OrtStatus * OpAttr_GetTensorAttributeAsOrtValue(const OrtOpAttr *attribute, OrtValue **attr_tensor)
Get the OrtNode's 'TENSOR' attribute as an OrtValue.
OrtStatus * EpAssignedNode_GetDomain(const OrtEpAssignedNode *ep_node, const char **out)
Get the domain of the node assigned to an execution provider.
OrtStatus * OpAttr_GetType(const OrtOpAttr *attribute, OrtOpAttrType *type)
Get the attribute type as OrtOpAttrType from an OrtOpAttr.
OrtStatus * CreateMemoryInfo(const char *name, enum OrtAllocatorType type, int id, enum OrtMemType mem_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo.
OrtStatus * SessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, const OrtROCMProviderOptions *rocm_options)
Append ROCM execution provider to the session options.
OrtStatus * SessionGetInputTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get input type information.
OrtStatus * GetSymbolicDimensions(const OrtTensorTypeAndShapeInfo *info, const char *dim_params[], size_t dim_params_length)
Get symbolic dimension names in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionOptionsAppendExecutionProvider_OpenVINO_V2(OrtSessionOptions *options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Append OpenVINO execution provider to the session options.
OrtStatus * GetStringTensorDataLength(const OrtValue *value, size_t *len)
Get total byte length for all strings in a string tensor.
OrtStatus * KernelContext_GetInputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the input count of a kernel.
OrtStatus * BindOutputToDevice(OrtIoBinding *binding_ptr, const char *name, const OrtMemoryInfo *mem_info_ptr)
Bind an OrtIoBinding output to a device.
OrtStatus * SessionGetEpDeviceForInputs(const OrtSession *session, const OrtEpDevice **inputs_ep_devices, size_t num_inputs)
Get the OrtEpDevice (if available) for each input of the session.
OrtStatus * SessionOptionsAppendExecutionProvider(OrtSessionOptions *options, const char *provider_name, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
: Append execution provider to the session options.
OrtStatus * SetSessionGraphOptimizationLevel(OrtSessionOptions *options, GraphOptimizationLevel graph_optimization_level)
Set the optimization level to apply when loading a graph.
OrtStatus * SessionGetEpDeviceForOutputs(const OrtSession *session, const OrtEpDevice **outputs_ep_devices, size_t num_outputs)
Get the EP device assigned to each session output.
OrtStatus * ModelMetadataGetDescription(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get description from an OrtModelMetadata.
OrtStatus * CreateCANNProviderOptions(OrtCANNProviderOptions **out)
Create an OrtCANNProviderOptions.
OrtStatus * ReadOpAttr(const OrtOpAttr *op_attr, OrtOpAttrType type, void *data, size_t len, size_t *out)
OrtStatus * DisablePerSessionThreads(OrtSessionOptions *options)
Use global thread pool on a session.
OrtStatus * SetDimensions(OrtTensorTypeAndShapeInfo *info, const int64_t *dim_values, size_t dim_count)
Set shape information in OrtTensorTypeAndShapeInfo.
OrtStatus * SetInterOpNumThreads(OrtSessionOptions *options, int inter_op_num_threads)
Sets the number of threads used to parallelize the execution of the graph.
OrtStatus * CustomOpDomain_Add(OrtCustomOpDomain *custom_op_domain, const OrtCustomOp *op)
Add a custom op to a custom op domain.
OrtStatus * GetSequenceElementType(const OrtSequenceTypeInfo *sequence_type_info, OrtTypeInfo **type_info)
Get element type from an OrtSequenceTypeInfo.
OrtStatus * RunOptionsGetRunLogVerbosityLevel(const OrtRunOptions *options, int *log_verbosity_level)
Get per-run log verbosity level.
OrtStatus * FillSparseTensorCsr(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *inner_indices_data, size_t inner_indices_num, const int64_t *outer_indices_data, size_t outer_indices_num)
OrtStatus * CreateAndRegisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Create an allocator and register it with the OrtEnv.
OrtStatus * CreateCpuMemoryInfo(enum OrtAllocatorType type, enum OrtMemType mem_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo for CPU memory.
OrtStatus * Node_GetGraph(const OrtNode *node, const OrtGraph **graph)
Get the node's parent OrtGraph instance.
OrtStatus * ValueInfo_GetExternalInitializerInfo(const OrtValueInfo *value_info, OrtExternalInitializerInfo **info)
Get information about an external initializer (e.g., filepath, file offset, byte size).
OrtStatus * AddCustomOpDomain(OrtSessionOptions *options, OrtCustomOpDomain *custom_op_domain)
Add custom op domain to a session options.
OrtStatus * Graph_GetGraphView(const OrtGraph *src_graph, const OrtNode **nodes, size_t num_nodes, OrtGraph **dst_graph)
Returns an OrtGraph that contains a subset of nodes in the source OrtGraph.
OrtStatus * KernelInfo_GetOutputTypeInfo(const OrtKernelInfo *info, size_t index, OrtTypeInfo **type_info)
Get the type information for a OrtKernelInfo's output.
OrtStatus * GetHardwareDevices(const OrtEnv *env, const OrtHardwareDevice **devices, size_t num_devices)
Get the list of available hardware devices.
OrtStatus * KernelContext_GetInput(const OrtKernelContext *context, size_t index, const OrtValue **out)
Used for custom operators, get an input of a kernel.
OrtStatus * CreateEnvWithCustomLoggerAndGlobalThreadPools(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, const struct OrtThreadingOptions *tp_options, OrtEnv **out)
uint32_t(* HardwareDevice_VendorId)(const OrtHardwareDevice *device)
Get the hardware device's vendor identifier.
Definition onnxruntime_c_api.h:5601
OrtStatus * KernelInfo_GetOperatorType(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node's operator type from OrtKernelInfo.
OrtStatus * DisableTelemetryEvents(const OrtEnv *env)
Disable Telemetry.
OrtStatus * KernelInfo_GetOutputCount(const OrtKernelInfo *info, size_t *out)
Get the number of outputs from OrtKernelInfo.
OrtStatus * CreateTensorWithDataAndDeleterAsOrtValue(OrtAllocator *deleter, void *p_data, size_t p_data_len, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create an OrtValue for a Tensor that uses pre-existing memory.
OrtStatus * ShapeInferContext_GetInputCount(const OrtShapeInferContext *context, size_t *out)
OrtStatus * Graph_GetInitializers(const OrtGraph *graph, const OrtValueInfo **initializers, size_t num_initializers)
Returns the graph's initializers as OrtValueInfo instances.
OrtStatus * GetHardwareDeviceEpIncompatibilityDetails(const OrtEnv *env, const char *ep_name, const OrtHardwareDevice *hw, OrtDeviceEpIncompatibilityDetails **details)
Check for known incompatibility issues between hardware device and a specific execution provider.
OrtStatus * ModelMetadataGetGraphName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get graph name from an OrtModelMetadata.
OrtStatus * CreateROCMProviderOptions(OrtROCMProviderOptions **out)
Create an OrtROCMProviderOptions.
OrtStatus * ModelMetadataLookupCustomMetadataMap(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, const char *key, char **value)
Return data for a key in the custom metadata map in an OrtModelMetadata.
OrtStatus * EpAssignedNode_GetOperatorType(const OrtEpAssignedNode *ep_node, const char **out)
Get the operator type of the node assigned to an execution provider.
OrtStatus * CopyTensors(const OrtEnv *env, const OrtValue *const *src_tensors, OrtValue *const *dst_tensors, OrtSyncStream *stream, size_t num_tensors)
Copy OrtValue instances containing Tensors between devices.
OrtStatus * RegisterExecutionProviderLibrary(OrtEnv *env, const char *registration_name, const char *path)
Register an execution provider library with ORT.
OrtStatus * RunOptionsSetRunLogSeverityLevel(OrtRunOptions *options, int log_severity_level)
Set per-run log severity level.
OrtStatus * GetCUDAProviderOptionsByName(const OrtCUDAProviderOptionsV2 *cuda_options, const char *key, void **ptr)
OrtStatus * SessionOptionsSetLoadCancellationFlag(OrtSessionOptions *options, bool cancel)
sets load cancellation flag to abort session loading process.
OrtStatus * Node_GetDomain(const OrtNode *node, const char **domain_name)
Returns a node's domain name.
OrtStatus * SetSessionExecutionMode(OrtSessionOptions *options, ExecutionMode execution_mode)
Set execution mode.
OrtStatus * SessionGetInputName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get input name.
OrtStatus * Graph_GetNumOutputs(const OrtGraph *graph, size_t *num_outputs)
Returns the number of graph outputs.
OrtStatus * ValueInfo_IsOptionalGraphInput(const OrtValueInfo *value_info, bool *is_optional_graph_input)
Returns a boolean indicating if the given value is an optional graph input.
OrtStatus * CreateLoraAdapter(const char *adapter_file_path, OrtAllocator *allocator, OrtLoraAdapter **out)
Create an OrtLoraAdapter.
OrtStatus * GetDnnlProviderOptionsAsString(const OrtDnnlProviderOptions *dnnl_options, OrtAllocator *allocator, char **ptr)
void(* AddKeyValuePair)(OrtKeyValuePairs *kvps, const char *key, const char *value)
Add a key-value pair to the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5442
OrtStatus * CreateRunOptions(OrtRunOptions **out)
Create an OrtRunOptions.
OrtStatus * RunOptionsGetRunTag(const OrtRunOptions *options, const char **run_tag)
Get per-run tag.
size_t(* ExternalInitializerInfo_GetByteSize)(const OrtExternalInitializerInfo *info)
Get the size in bytes of the initializer's data within the file.
Definition onnxruntime_c_api.h:6519
OrtStatus * CreateCustomOpDomain(const char *domain, OrtCustomOpDomain **out)
Create a custom op domain.
OrtStatus * ModelMetadataGetCustomMetadataMapKeys(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char ***keys, int64_t *num_keys)
const char *(* GetErrorMessage)(const OrtStatus *status) __attribute__((nonnull))
Get error string from OrtStatus.
Definition onnxruntime_c_api.h:1233
OrtStatus * IsTensor(const OrtValue *value, int *out)
Return if an OrtValue is a tensor type.
OrtStatus * Graph_GetNumNodes(const OrtGraph *graph, size_t *num_nodes)
Returns the number of graph nodes.
OrtStatus * AllocatorFree(OrtAllocator *ort_allocator, void *p)
Calls OrtAllocator::Free function.
OrtStatus * GetMapValueType(const OrtMapTypeInfo *map_type_info, OrtTypeInfo **type_info)
Get the value type from an OrtMapTypeInfo.
OrtStatus * ValueInfo_GetValueConsumers(const OrtValueInfo *value_info, const OrtNode **nodes, int64_t *input_indices, size_t num_consumers)
Returns information (OrtNode and input index) for all consumer nodes that use the value as an input.
OrtStatus * CreateSessionFromArray(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession from memory.
OrtStatus * CreateArenaCfgV2(const char *const *arena_config_keys, const size_t *arena_config_values, size_t num_keys, OrtArenaCfg **out)
Create an OrtArenaCfg.
OrtStatus * GetAllocatorWithDefaultOptions(OrtAllocator **out)
Get the default allocator.
OrtStatus * CreateSession(const OrtEnv *env, const char *model_path, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession from a model file.
OrtStatus * SessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, const OrtDnnlProviderOptions *dnnl_options)
Append dnnl provider to session options.
OrtStatus * CreateArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk, OrtArenaCfg **out)
OrtStatus * SessionGetInputCount(const OrtSession *session, size_t *out)
Get input count for a session.
const char *(* GetKeyValue)(const OrtKeyValuePairs *kvps, const char *key)
Get the value associated with a key in the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5453
OrtStatus * EpAssignedSubgraph_GetEpName(const OrtEpAssignedSubgraph *ep_subgraph, const char **out)
Get the name of the execution provider to which the subgraph was assigned.
OrtStatus * GetValue(const OrtValue *value, int index, OrtAllocator *allocator, OrtValue **out)
Get non tensor data from an OrtValue.
OrtStatus * ShapeInferContext_GetAttribute(const OrtShapeInferContext *context, const char *attr_name, const OrtOpAttr **attr)
OrtStatus * GetSparseTensorIndices(const OrtValue *ort_value, enum OrtSparseIndicesFormat indices_format, size_t *num_indices, const void **indices)
Returns indices data for the type of the indices specified by indices_format.
const char *(* EpDevice_EpName)(const OrtEpDevice *ep_device)
Get the execution provider name.
Definition onnxruntime_c_api.h:5639
OrtStatus * EnableProfiling(OrtSessionOptions *options, const char *profile_file_prefix)
Enable profiling for a session.
OrtStatus * Node_GetName(const OrtNode *node, const char **node_name)
Returns a node's name. Can be an empty string.
uint32_t(* HardwareDevice_DeviceId)(const OrtHardwareDevice *device)
Get the hardware device's unique identifier.
Definition onnxruntime_c_api.h:5620
OrtStatus * Node_GetId(const OrtNode *node, size_t *node_id)
Returns a node's identifier.
OrtStatus * SetUserLoggingFunction(OrtSessionOptions *options, OrtLoggingFunction user_logging_function, void *user_logging_param)
Set user logging function.
OrtStatus * GetStringTensorElement(const OrtValue *value, size_t s_len, size_t index, void *s)
Get a single string from a string tensor.
OrtStatus * Graph_GetNumOperatorSets(const OrtGraph *graph, size_t *num_operator_sets)
Returns the number of operator sets that the graph's model uses.
OrtStatus * GetTensorTypeAndShape(const OrtValue *value, OrtTensorTypeAndShapeInfo **out)
Get type and shape information from a tensor OrtValue.
OrtStatus * BindInput(OrtIoBinding *binding_ptr, const char *name, const OrtValue *val_ptr)
Bind an OrtValue to an OrtIoBinding input.
const OrtKeyValuePairs *(* EpDevice_EpMetadata)(const OrtEpDevice *ep_device)
Get the metadata for the OrtEpDevice.
Definition onnxruntime_c_api.h:5657
OrtStatus * CreateEnvWithOptions(const OrtEnvCreationOptions *options, OrtEnv **out)
Create an OrtEnv instance with the given options.
OrtStatus * GetResizedStringTensorElementBuffer(OrtValue *value, size_t index, size_t length_in_bytes, char **buffer)
Set a single string in a string tensor Do not zero terminate the string data.
OrtStatus * DisableCpuMemArena(OrtSessionOptions *options)
Disable the memory arena on CPU.
OrtDeviceMemoryType(* MemoryInfoGetDeviceMemType)(const OrtMemoryInfo *ptr)
Get the device memory type from OrtMemoryInfo.
Definition onnxruntime_c_api.h:5746
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2907
OrtStatus * KernelInfo_GetOperatorDomain(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node's operator domain from OrtKernelInfo.
OrtStatus * SetSymbolicDimensions(OrtTensorTypeAndShapeInfo *info, const char *dim_params[], size_t dim_params_length)
OrtStatus * SessionOptionsAppendExecutionProvider_CANN(OrtSessionOptions *options, const OrtCANNProviderOptions *cann_options)
Append CANN provider to session options.
OrtStatus * MemoryInfoGetMemType(const OrtMemoryInfo *ptr, OrtMemType *out)
Get the OrtMemType from OrtMemoryInfo.
OrtStatus * AllocatorGetInfo(const OrtAllocator *ort_allocator, const struct OrtMemoryInfo **out)
Calls OrtAllocator::Info function.
OrtStatus * CreateSharedAllocator(OrtEnv *env, const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type, OrtAllocatorType allocator_type, const OrtKeyValuePairs *allocator_options, OrtAllocator **allocator)
Create/replace a shared allocator for the OrtEpDevice in the OrtEnv.
OrtStatus * CompareMemoryInfo(const OrtMemoryInfo *info1, const OrtMemoryInfo *info2, int *out)
Compare OrtMemoryInfo objects for equality.
OrtStatus * GetAvailableProviders(char ***out_ptr, int *provider_length)
Get the names of all available providers.
OrtStatus * SynchronizeBoundInputs(OrtIoBinding *binding_ptr)
Synchronize bound inputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * GetOpaqueValue(const char *domain_name, const char *type_name, const OrtValue *in, void *data_container, size_t data_container_size)
Get internal data from an opaque (custom user defined type) OrtValue.
OrtStatus * AllocatorAlloc(OrtAllocator *ort_allocator, size_t size, void **out)
Calls OrtAllocator::Alloc function.
OrtStatus * RunAsync(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *input, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **output, RunAsyncCallbackFn run_async_callback, void *user_data)
Run the model asynchronously in a thread owned by intra op thread pool.
OrtStatus * GetTensorRTProviderOptionsByName(const OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *key, void **ptr)
OrtStatus * RegisterCustomOpsLibrary_V2(OrtSessionOptions *options, const char *library_name)
Register custom ops from a shared library.
OrtStatus * SessionGetOverridableInitializerName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get overridable initializer name.
OrtStatus * GetROCMProviderOptionsAsString(const OrtROCMProviderOptions *rocm_options, OrtAllocator *allocator, char **ptr)
OrtStatus * UnregisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info)
Unregister a custom allocator.
OrtStatus * Graph_GetParentNode(const OrtGraph *graph, const OrtNode **node)
Get the parent node for the given graph, if any exists.
OrtStatus * DisableMemPattern(OrtSessionOptions *options)
Disable the memory pattern optimization.
OrtStatus * UseBlockSparseIndices(OrtValue *ort_value, const int64_t *indices_shape, size_t indices_shape_len, int32_t *indices_data)
OrtStatus * SetEpDynamicOptions(OrtSession *sess, const char *const *keys, const char *const *values, size_t kv_len)
Set DynamicOptions for EPs (Execution Providers)
void(* CreateKeyValuePairs)(OrtKeyValuePairs **out)
Create an OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5427
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:1219
OrtStatus * RunWithBinding(OrtSession *session, const OrtRunOptions *run_options, const OrtIoBinding *binding_ptr)
Run a model using Io Bindings for the inputs & outputs.
OrtStatus * CreateDnnlProviderOptions(OrtDnnlProviderOptions **out)
Create an OrtDnnlProviderOptions.
OrtStatus * GetMapKeyType(const OrtMapTypeInfo *map_type_info, enum ONNXTensorElementDataType *out)
Get key type from an OrtMapTypeInfo.
OrtStatus * DeviceEpIncompatibilityDetails_GetReasonsBitmask(const OrtDeviceEpIncompatibilityDetails *details, uint32_t *reasons_bitmask)
Get the incompatibility reasons bitmask from OrtDeviceEpIncompatibilityDetails.
OrtStatus * RunOptionsGetRunLogSeverityLevel(const OrtRunOptions *options, int *log_severity_level)
Get per-run log severity level.
OrtStatus * CastTypeInfoToOptionalTypeInfo(const OrtTypeInfo *type_info, const OrtOptionalTypeInfo **out)
Get Optional Type information from an OrtTypeInfo.
const OrtCompileApi *(* GetCompileApi)(void)
Get the Compile API instance.
Definition onnxruntime_c_api.h:5413
OrtStatus * SessionGetModelMetadata(const OrtSession *session, OrtModelMetadata **out)
Get OrtModelMetadata from an OrtSession.
OrtStatus * Node_GetSinceVersion(const OrtNode *node, int *since_version)
Get the opset version in which the given node's operator type was first defined.
OrtStatus * Node_GetNumSubgraphs(const OrtNode *node, size_t *num_subgraphs)
Returns the number of subgraphs contained by the given node.
OrtStatus * GetCurrentGpuDeviceId(int *device_id)
Get current GPU device ID.
OrtStatus * SessionGetOutputTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get output type information.
OrtStatus * KernelContext_GetScratchBuffer(const OrtKernelContext *context, const OrtMemoryInfo *mem_info, size_t count_or_bytes, void **out)
Get scratch buffer from the corresponding allocator under the specific OrtMemoryInfo object....
OrtStatus * Graph_GetOutputs(const OrtGraph *graph, const OrtValueInfo **outputs, size_t num_outputs)
Returns the graph's outputs as OrtValueInfo instances.
OrtStatus * EnableOrtCustomOps(OrtSessionOptions *options)
Enable custom operators.
OrtStatus * UpdateEnvWithCustomLogLevel(OrtEnv *ort_env, OrtLoggingLevel log_severity_level)
OrtStatus * Node_GetEpName(const OrtNode *node, const char **out)
Returns the execution provider name that this node is assigned to run on. Returns NULL if the node ha...
OrtStatus * SessionGetMemoryInfoForInputs(const OrtSession *session, const OrtMemoryInfo **inputs_memory_info, size_t num_inputs)
Get the OrtMemoryInfo for each input of the session.
OrtStatus * ReleaseSharedAllocator(OrtEnv *env, const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type)
Release a shared allocator from the OrtEnv for the OrtEpDevice and memory type.
OrtStatus * CreateValue(const OrtValue *const *in, size_t num_values, enum ONNXType value_type, OrtValue **out)
Create a map or sequence OrtValue.
OrtStatus * SessionOptionsAppendExecutionProvider_VitisAI(OrtSessionOptions *options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Append VitisAI provider to session options.
OrtStatus * RegisterCustomOpsUsingFunction(OrtSessionOptions *options, const char *registration_func_name)
Register custom ops by calling a RegisterCustomOpsFn function.
OrtStatus * RunOptionsSetTerminate(OrtRunOptions *options)
Set terminate flag.
OrtStatus * SetSessionLogVerbosityLevel(OrtSessionOptions *options, int session_log_verbosity_level)
Set session log verbosity level.
OrtStatus * SetSessionLogSeverityLevel(OrtSessionOptions *options, int session_log_severity_level)
Set session log severity level.
bool(* TensorTypeAndShape_HasShape)(const OrtTensorTypeAndShapeInfo *info)
Fetch whether the tensor has shape information.
Definition onnxruntime_c_api.h:6837
OrtStatus * GetNumHardwareDevices(const OrtEnv *env, size_t *num_devices)
Get the number of available hardware devices.
OrtStatus * CreateThreadingOptions(OrtThreadingOptions **out)
Create an OrtThreadingOptions.
OrtStatus * UseCsrIndices(OrtValue *ort_value, int64_t *inner_data, size_t inner_num, int64_t *outer_data, size_t outer_num)
OrtStatus * Graph_GetModelPath(const OrtGraph *graph, const char **model_path)
Get the filepath to the model from which an OrtGraph is constructed.
OrtStatus * KernelInfo_GetOperatorSinceVersion(const OrtKernelInfo *info, int *since_version)
Get the opset version in which the given node's operator type was first defined from OrtKernelInfo.
OrtStatus * SessionGetOverridableInitializerCount(const OrtSession *session, size_t *out)
Get overridable initializer count.
OrtStatus * GetValueInfoName(const OrtValueInfo *value_info, const char **name)
Get the value name from an OrtValueInfo instance.
OrtStatus * UnregisterExecutionProviderLibrary(OrtEnv *env, const char *registration_name)
Unregister an execution provider library with ORT.
OrtStatus * CreateSessionWithPrepackedWeightsContainer(const OrtEnv *env, const char *model_path, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container, OrtSession **out)
Create session with prepacked weights container.
OrtStatus * KernelInfo_GetLogger(const OrtKernelInfo *info, const OrtLogger **logger)
Get the session logger from OrtKernelInfo.
OrtStatus * UpdateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a TensorRT Execution Provider.
OrtStatus * KernelInfoGetAttribute_tensor(const OrtKernelInfo *info, const char *name, OrtAllocator *allocator, OrtValue **out)
Get a OrtValue tensor stored as an attribute in the graph node.
OrtStatus * EnableMemPattern(OrtSessionOptions *options)
Enable the memory pattern optimization.
OrtStatus * SetOptimizedModelFilePath(OrtSessionOptions *options, const char *optimized_model_filepath)
Set filepath to save optimized model after graph level transformations.
const OrtKeyValuePairs *(* EpDevice_EpOptions)(const OrtEpDevice *ep_device)
Get the execution provider options for the OrtEpDevice.
Definition onnxruntime_c_api.h:5666
OrtStatus * CreateAllocator(const OrtSession *session, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Create an allocator for an OrtSession following an OrtMemoryInfo.
OrtStatus * SynchronizeBoundOutputs(OrtIoBinding *binding_ptr)
Synchronize bound outputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * SessionGetOutputCount(const OrtSession *session, size_t *out)
Get output count for a session.
OrtStatus * EpAssignedNode_GetName(const OrtEpAssignedNode *ep_node, const char **out)
Get the name of the node assigned to an execution provider.
OrtStatus * CastTypeInfoToSequenceTypeInfo(const OrtTypeInfo *type_info, const OrtSequenceTypeInfo **out)
Cast OrtTypeInfo to an OrtSequenceTypeInfo.
OrtStatus * Run(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *inputs, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **outputs)
Run the model in an OrtSession.
OrtStatus * ValueInfo_IsGraphOutput(const OrtValueInfo *value_info, bool *is_graph_output)
Returns a boolean indicating if the given value is a graph output.
OrtStatus * GetValueType(const OrtValue *value, enum ONNXType *out)
Get ONNXType of an OrtValue.
OrtStatus * Node_GetImplicitInputs(const OrtNode *node, const OrtValueInfo **implicit_inputs, size_t num_implicit_inputs)
Get the implicit inputs, as OrtValueInfo instances, that are used within the given node's subgraphs.
OrtStatus * Node_GetNumImplicitInputs(const OrtNode *node, size_t *num_implicit_inputs)
Returns the number of node implicit inputs.
OrtStatus * ShapeInferContext_GetInputTypeShape(const OrtShapeInferContext *context, size_t index, OrtTensorTypeAndShapeInfo **info)
OrtStatus * EpAssignedSubgraph_GetNodes(const OrtEpAssignedSubgraph *ep_subgraph, const OrtEpAssignedNode *const **ep_nodes, size_t *num_ep_nodes)
Get the nodes in a subgraph assigned to a specific execution provider.
OrtStatus * CreateSyncStreamForEpDevice(const OrtEpDevice *ep_device, const OrtKeyValuePairs *stream_options, OrtSyncStream **stream)
Create an OrtSyncStream for the given OrtEpDevice.
OrtStatus * KernelInfo_GetNodeName(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node name from OrtKernelInfo.
OrtStatus * CreateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 **out)
Create an OrtTensorRTProviderOptionsV2.
OrtStatus * GetDimensions(const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)
Get dimensions in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionGetProfilingStartTimeNs(const OrtSession *session, uint64_t *out)
Return the time that profiling was started.
OrtStatus * RunOptionsUnsetTerminate(OrtRunOptions *options)
Clears the terminate flag.
OrtStatus * CreateOpaqueValue(const char *domain_name, const char *type_name, const void *data_container, size_t data_container_size, OrtValue **out)
Create an opaque (custom user defined type) OrtValue.
OrtStatus * GetSparseTensorValuesTypeAndShape(const OrtValue *ort_value, OrtTensorTypeAndShapeInfo **out)
Returns data type and shape of sparse tensor values (nnz) iff OrtValue contains a SparseTensor.
void(* ReleaseTensorRTProviderOptions)(OrtTensorRTProviderOptionsV2 *input)
Release an OrtTensorRTProviderOptionsV2.
Definition onnxruntime_c_api.h:3464
OrtStatus * Graph_GetNodes(const OrtGraph *graph, const OrtNode **nodes, size_t num_nodes)
Returns the graph's nodes as OrtNode instances.
OrtStatus * ReleaseAvailableProviders(char **ptr, int providers_length)
Release data from OrtApi::GetAvailableProviders. This API will never fail so you can rely on it in a ...
const char *(* ExternalInitializerInfo_GetFilePath)(const OrtExternalInitializerInfo *info)
Get the relative path to the file that stores the initializer's data.
Definition onnxruntime_c_api.h:6501
OrtStatus * RunOptionsSetRunTag(OrtRunOptions *options, const char *run_tag)
Set per-run tag.
OrtStatus * CreateIoBinding(OrtSession *session, OrtIoBinding **out)
Create an OrtIoBinding instance.
OrtStatus * SetGlobalIntraOpNumThreads(OrtThreadingOptions *tp_options, int intra_op_num_threads)
Set global intra-op thread count.
OrtStatus * CreateOpAttr(const char *name, const void *data, int len, OrtOpAttrType type, OrtOpAttr **op_attr)
: Create attribute of onnxruntime operator
const char *(* EpDevice_EpVendor)(const OrtEpDevice *ep_device)
Get the execution provider's vendor name.
Definition onnxruntime_c_api.h:5648
OrtStatus * FillSparseTensorBlockSparse(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *indices_shape_data, size_t indices_shape_len, const int32_t *indices_data)
const OrtKeyValuePairs *(* HardwareDevice_Metadata)(const OrtHardwareDevice *device)
Get hardware device metadata.
Definition onnxruntime_c_api.h:5630
const OrtModelEditorApi *(* GetModelEditorApi)(void)
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:5355
OrtStatus * ValueInfo_GetValueProducer(const OrtValueInfo *value_info, const OrtNode **producer_node, size_t *producer_output_index)
Get the OrtNode that produces the value represented by the given OrtValueInfo. Optionally returns the...
OrtStatus * ModelMetadataGetVersion(const OrtModelMetadata *model_metadata, int64_t *value)
Get version number from an OrtModelMetadata.
OrtStatus * GetStringTensorContent(const OrtValue *value, void *s, size_t s_len, size_t *offsets, size_t offsets_len)
Get all strings from a string tensor.
OrtStatus * OpAttr_GetName(const OrtOpAttr *attribute, const char **name)
Get the attribute name from an OrtOpAttr.
OrtStatus * GetBoundOutputNames(const OrtIoBinding *binding_ptr, OrtAllocator *allocator, char **buffer, size_t **lengths, size_t *count)
Get the names of an OrtIoBinding's outputs.
OrtStatus * ValueInfo_IsRequiredGraphInput(const OrtValueInfo *value_info, bool *is_required_graph_input)
Returns a boolean indicating if the given value is a required graph input.
OrtStatus * Node_GetOutputs(const OrtNode *node, const OrtValueInfo **outputs, size_t num_outputs)
Returns the node's outputs as OrtValueInfo instances.
OrtStatus * CreateTensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo **out)
Create an OrtTensorTypeAndShapeInfo object.
OrtStatus * FillSparseTensorCoo(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *indices_data, size_t indices_num)
OrtStatus * SessionEndProfiling(OrtSession *session, OrtAllocator *allocator, char **out)
End profiling and return filename of the profile data.
OrtStatus * DeviceEpIncompatibilityDetails_GetNotes(const OrtDeviceEpIncompatibilityDetails *details, const char **notes)
Get the notes from OrtDeviceEpIncompatibilityDetails.
OrtStatus * ModelMetadataGetProducerName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get producer name from an OrtModelMetadata.
OrtStatus * GetCompatibilityInfoFromModelBytes(const void *model_data, size_t model_data_length, const char *ep_type, OrtAllocator *allocator, char **compatibility_info)
Extract EP compatibility info from precompiled model bytes in memory.
OrtStatus * SessionOptionsSetCustomCreateThreadFn(OrtSessionOptions *options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Set custom thread creation function.
OrtStatus * SetGlobalCustomCreateThreadFn(OrtThreadingOptions *tp_options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Set custom thread creation function for global thread pools.
OrtStatus * Node_GetSubgraphs(const OrtNode *node, const OrtGraph **subgraphs, size_t num_subgraphs, const char **attribute_names)
Get the subgraphs, as OrtGraph instances, contained by the given node.
OrtStatus * SessionOptionsAppendExecutionProvider_CUDA_V2(OrtSessionOptions *options, const OrtCUDAProviderOptionsV2 *cuda_options)
Append CUDA execution provider to the session options.
OrtStatus * CreateTensorAsOrtValue(OrtAllocator *allocator, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create a tensor.
void(* RemoveKeyValuePair)(OrtKeyValuePairs *kvps, const char *key)
Remove a key-value pair from the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5475
void *(* SyncStream_GetHandle)(OrtSyncStream *stream)
Get the native handle of the sync stream.
Definition onnxruntime_c_api.h:6749
OrtStatus * Graph_GetNumInitializers(const OrtGraph *graph, size_t *num_initializers)
Returns the number of graph initializers.
void(* ReleaseCUDAProviderOptions)(OrtCUDAProviderOptionsV2 *input)
Release an OrtCUDAProviderOptionsV2.
Definition onnxruntime_c_api.h:3967
OrtStatus * RunOptionsAddActiveLoraAdapter(OrtRunOptions *options, const OrtLoraAdapter *adapter)
Add the Lora Adapter to the list of active adapters.
OrtStatus * KernelInfoGetAttribute_int64(const OrtKernelInfo *info, const char *name, int64_t *out)
Fetch a 64-bit int stored as an attribute in the graph node.
OrtErrorCode(* GetErrorCode)(const OrtStatus *status) __attribute__((nonnull))
Get OrtErrorCode from OrtStatus.
Definition onnxruntime_c_api.h:1226
OrtStatus * SetTensorElementType(OrtTensorTypeAndShapeInfo *info, enum ONNXTensorElementDataType type)
Set element type in OrtTensorTypeAndShapeInfo.
OrtStatus * BindOutput(OrtIoBinding *binding_ptr, const char *name, const OrtValue *val_ptr)
Bind an OrtValue to an OrtIoBinding output.
OrtStatus * GetSparseTensorValues(const OrtValue *ort_value, const void **out)
Returns numeric data for sparse tensor values (nnz). For string values use GetStringTensor*().
CUDA Provider Options.
Definition onnxruntime_c_api.h:620
int tunable_op_max_tuning_duration_ms
Max tuning duration time limit for each instance of TunableOp. Defaults to 0 to disable the limit.
Definition onnxruntime_c_api.h:699
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:673
int do_copy_in_default_stream
Flag indicating if copying needs to take place on the same stream as the compute stream in the CUDA E...
Definition onnxruntime_c_api.h:668
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:678
int tunable_op_enable
Enable TunableOp for using. Set it to 1/0 to enable/disable TunableOp. Otherwise, it is disabled by d...
Definition onnxruntime_c_api.h:688
size_t gpu_mem_limit
CUDA memory limit (To use all possible memory pass in maximum size_t) Defaults to SIZE_MAX.
Definition onnxruntime_c_api.h:651
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:659
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:622
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:682
int tunable_op_tuning_enable
Enable TunableOp for tuning. Set it to 1/0 to enable/disable TunableOp tuning. Otherwise,...
Definition onnxruntime_c_api.h:694
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:645
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:639
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:7884
OrtStatus * ModelCompilationOptions_SetFlags(OrtModelCompilationOptions *model_compile_options, uint32_t flags)
Sets flags from OrtCompileApiFlags that represent one or more boolean options to enable.
OrtStatus * ModelCompilationOptions_SetOutputModelWriteFunc(OrtModelCompilationOptions *model_compile_options, OrtWriteBufferFunc write_func, void *state)
Sets a OrtWriteBufferFunc function that is called by ORT to write out the output model's serialized O...
OrtStatus * ModelCompilationOptions_SetOutputModelBuffer(OrtModelCompilationOptions *model_compile_options, OrtAllocator *allocator, void **output_model_buffer_ptr, size_t *output_model_buffer_size_ptr)
Configures model compilation to store the output compiled ONNX model in a buffer.
OrtStatus * ModelCompilationOptions_SetInputModelFromBuffer(OrtModelCompilationOptions *model_compile_options, const void *input_model_data, size_t input_model_data_size)
Sets the buffer that stores the bytes of the loaded ONNX model to compile.
OrtStatus * ModelCompilationOptions_SetInputModelPath(OrtModelCompilationOptions *model_compile_options, const char *input_model_path)
Sets the file path to the input ONNX model to compile.
OrtStatus * ModelCompilationOptions_SetOutputModelExternalInitializersFile(OrtModelCompilationOptions *model_compile_options, const char *external_initializers_file_path, size_t external_initializers_size_threshold)
Optionally sets the file that should store external initializers for the compiled ONNX model....
OrtStatus * ModelCompilationOptions_SetInputModel(OrtModelCompilationOptions *model_compile_options, const OrtModel *model)
Sets the OrtModel to compile.
OrtStatus * ModelCompilationOptions_SetGraphOptimizationLevel(OrtModelCompilationOptions *model_compile_options, GraphOptimizationLevel graph_optimization_level)
OrtStatus * CreateModelCompilationOptionsFromSessionOptions(const OrtEnv *env, const OrtSessionOptions *session_options, OrtModelCompilationOptions **out)
Creates an OrtModelCompilationOptions object from an existing OrtSessionOptions object.
OrtStatus * ModelCompilationOptions_SetEpContextEmbedMode(OrtModelCompilationOptions *model_compile_options, bool embed_ep_context_in_model)
Enables or disables the embedding of EPContext binary data into the ep_cache_context attribute of EPC...
OrtStatus * ModelCompilationOptions_SetOutputModelPath(OrtModelCompilationOptions *model_compile_options, const char *output_model_path)
Sets the file path for the output ONNX model generated by CompileModel.
OrtStatus * ModelCompilationOptions_SetOutputModelGetInitializerLocationFunc(OrtModelCompilationOptions *model_compile_options, OrtGetInitializerLocationFunc get_initializer_location_func, void *state)
Sets a OrtGetInitializerLocationFunc function that is called by ORT for every initializer in the gene...
OrtStatus * CompileModel(const OrtEnv *env, const OrtModelCompilationOptions *model_options)
Compiles an input ONNX model with the given compilation options.
OrtStatus * ModelCompilationOptions_SetEpContextBinaryInformation(OrtModelCompilationOptions *model_compile_options, const char *output_directory, const char *model_name)
Definition onnxruntime_c_api.h:944
char __place_holder
Definition onnxruntime_c_api.h:945
Definition onnxruntime_c_api.h:7357
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7403
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7387
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7375
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7407
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7440
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7425
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7437
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7368
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7377
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:7383
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7412
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7394
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:7364
uint32_t version
Definition onnxruntime_c_api.h:7358
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7374
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7441
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7386
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7371
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7376
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7398
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:7422
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7426
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:7415
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7433
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7420
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7382
Configuration options for creating an OrtEnv.
Definition onnxruntime_c_api.h:1120
uint32_t version
Must be set to ORT_API_VERSION.
Definition onnxruntime_c_api.h:1121
const OrtKeyValuePairs * config_entries
Optional environment configuration entries represented as string key-value pairs. May be set to NULL.
Definition onnxruntime_c_api.h:1193
const OrtThreadingOptions * threading_options
Optional threading options for creating an environment with global thread pools shared across session...
Definition onnxruntime_c_api.h:1173
OrtLoggingFunction custom_logging_function
Optional custom logging function. May be set to NULL.
Definition onnxruntime_c_api.h:1152
void * custom_logging_param
Optional state to pass as the first argument to OrtEnvCreationOptions::custom_logger_function....
Definition onnxruntime_c_api.h:1159
const char * log_id
The log identifier. Must be set to a valid UTF-8 null-terminated string.
Definition onnxruntime_c_api.h:1141
int32_t logging_severity_level
The logging severity level for the environment. Must be set to a value from OrtLoggingLevel.
Definition onnxruntime_c_api.h:1133
The OrtEpApi struct provides functions that are relevant to the implementation of an execution provid...
Definition onnxruntime_ep_c_api.h:751
Descriptor for importing external memory.
Definition onnxruntime_c_api.h:993
OrtExternalMemoryHandleType handle_type
Definition onnxruntime_c_api.h:995
size_t size_bytes
Definition onnxruntime_c_api.h:997
void * native_handle
Definition onnxruntime_c_api.h:996
uint32_t version
Definition onnxruntime_c_api.h:994
size_t offset_bytes
Definition onnxruntime_c_api.h:998
Base struct for imported external memory handles.
Definition onnxruntime_ep_c_api.h:45
Descriptor for importing external semaphores.
Definition onnxruntime_c_api.h:1017
void * native_handle
Definition onnxruntime_c_api.h:1020
OrtExternalSemaphoreType type
Definition onnxruntime_c_api.h:1019
uint32_t version
Definition onnxruntime_c_api.h:1018
Base struct for imported external semaphore handles.
Definition onnxruntime_ep_c_api.h:72
Descriptor for creating a tensor from imported external memory.
Definition onnxruntime_c_api.h:1093
ONNXTensorElementDataType element_type
Definition onnxruntime_c_api.h:1095
size_t offset_bytes
Definition onnxruntime_c_api.h:1098
uint32_t version
Definition onnxruntime_c_api.h:1094
size_t rank
Definition onnxruntime_c_api.h:1097
const int64_t * shape
Definition onnxruntime_c_api.h:1096
Configuration for initializing graphics interop on an EP factory.
Definition onnxruntime_c_api.h:1063
OrtGraphicsApi graphics_api
Definition onnxruntime_c_api.h:1065
const OrtKeyValuePairs * additional_options
Additional API-specific options (optional).
Definition onnxruntime_c_api.h:1083
uint32_t version
Definition onnxruntime_c_api.h:1064
void * command_queue
Command queue/submission queue for graphics workloads (optional).
Definition onnxruntime_c_api.h:1076
The OrtInteropApi struct provides functions for external resource interop with execution providers.
Definition onnxruntime_c_api.h:8180
OrtStatus * WaitSemaphore(OrtExternalResourceImporter *importer, OrtExternalSemaphoreHandle *semaphore_handle, OrtSyncStream *stream, uint64_t value)
Wait on an external semaphore on the EP's stream.
OrtStatus * CreateTensorFromMemory(OrtExternalResourceImporter *importer, const OrtExternalMemoryHandle *mem_handle, const OrtExternalTensorDescriptor *tensor_desc, OrtValue **out_tensor)
Create a tensor backed by imported external memory.
OrtStatus * InitGraphicsInteropForEpDevice(const OrtEpDevice *ep_device, const OrtGraphicsInteropConfig *config)
Initialize graphics interop for an execution provider device.
OrtStatus * ImportMemory(OrtExternalResourceImporter *importer, const OrtExternalMemoryDescriptor *desc, OrtExternalMemoryHandle **out_handle)
Import external memory into the execution provider.
OrtStatus * SignalSemaphore(OrtExternalResourceImporter *importer, OrtExternalSemaphoreHandle *semaphore_handle, OrtSyncStream *stream, uint64_t value)
Signal an external semaphore from the EP's stream.
OrtStatus * ImportSemaphore(OrtExternalResourceImporter *importer, const OrtExternalSemaphoreDescriptor *desc, OrtExternalSemaphoreHandle **out_handle)
Import an external semaphore into the execution provider.
OrtStatus * CanImportSemaphore(const OrtExternalResourceImporter *importer, OrtExternalSemaphoreType type, bool *out_supported)
Check if the external resource importer can import a specific semaphore type.
OrtStatus * CreateExternalResourceImporterForDevice(const OrtEpDevice *ep_device, OrtExternalResourceImporter **out_importer)
Create an external resource importer for a specific EP device.
OrtStatus * CanImportMemory(const OrtExternalResourceImporter *importer, OrtExternalMemoryHandleType handle_type, bool *out_supported)
Check if the external resource importer can import a specific memory handle type.
OrtStatus * DeinitGraphicsInteropForEpDevice(const OrtEpDevice *ep_device)
Deinitialize graphics interop for an execution provider device.
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:824
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:835
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:831
int migraphx_fp8_enable
Definition onnxruntime_c_api.h:827
int migraphx_int8_enable
Definition onnxruntime_c_api.h:828
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:833
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:826
int device_id
Definition onnxruntime_c_api.h:825
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:829
size_t migraphx_mem_limit
MIGraphX memory limit (To use all possible memory pass in maximum size_t) Defaults to SIZE_MAX.
Definition onnxruntime_c_api.h:841
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:834
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:832
int migraphx_arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:849
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:830
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:7455
OrtStatus * CreateModel(const char *const *domain_names, const int *opset_versions, size_t opset_entries_len, OrtModel **model)
Create an OrtModel.
OrtStatus * CreateGraph(OrtGraph **graph)
Create an OrtGraph.
OrtStatus * ApplyModelToModelEditorSession(OrtSession *session, OrtModel *model)
Apply changes to augment the ONNX model in a session created using CreateModelEditorSession[FromArray...
OrtStatus * AddInitializerToGraph(OrtGraph *graph, const char *name, OrtValue *tensor, bool data_is_external)
Add an initializer to the OrtGraph.
OrtStatus * SessionGetOpsetForDomain(const OrtSession *session, const char *domain, int *opset)
Query the session for the opset version of a domain.
OrtStatus * CreateValueInfo(const char *name, const OrtTypeInfo *type_info, OrtValueInfo **value_info)
Create an OrtValueInfo for use as an OrtGraph input or output.
OrtStatus * CreateModelEditorSessionFromArray(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession to augment an existing model.
OrtStatus * CreateSequenceTypeInfo(const OrtTypeInfo *sequence_type, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a Sequence.
OrtStatus * CreateOptionalTypeInfo(const OrtTypeInfo *contained_type, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for an Optional.
OrtStatus * AddGraphToModel(OrtModel *model, OrtGraph *graph)
Add an OrtGraph to an OrtModel.
OrtStatus * FinalizeModelEditorSession(OrtSession *session, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Finalize the Model Editor session that was created using CreateModelEditorSession[FromArray].
OrtStatus * CreateMapTypeInfo(ONNXTensorElementDataType map_key_type, const OrtTypeInfo *map_value_type, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a Map.
OrtStatus * CreateSparseTensorTypeInfo(const OrtTensorTypeAndShapeInfo *tensor_info, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a SparseTensor.
OrtStatus * CreateNode(const char *operator_name, const char *domain_name, const char *node_name, const char *const *input_names, size_t input_names_len, const char *const *output_names, size_t output_names_len, OrtOpAttr **attributes, size_t attribs_len, OrtNode **node)
Create an OrtNode to add to an OrtGraph.
OrtStatus * CreateModelEditorSession(const OrtEnv *env, const char *model_path, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession to augment an existing model.
OrtStatus * CreateSessionFromModel(const OrtEnv *env, const OrtModel *model, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession using the OrtModel.
OrtStatus * SetGraphOutputs(OrtGraph *graph, OrtValueInfo **outputs, size_t outputs_len)
Set the outputs for the OrtGraph.
OrtStatus * CreateTensorTypeInfo(const OrtTensorTypeAndShapeInfo *tensor_info, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a Tensor.
OrtStatus * AddNodeToGraph(OrtGraph *graph, OrtNode *node)
Add an OrtNode to an OrtGraph.
OrtStatus * SetGraphInputs(OrtGraph *graph, OrtValueInfo **inputs, size_t inputs_len)
Set the inputs for the OrtGraph.
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:863
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:884
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:881
void * context
Definition onnxruntime_c_api.h:883
const char * cache_dir
Definition onnxruntime_c_api.h:882
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:878
const char * device_id
Definition onnxruntime_c_api.h:880
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:879
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:865
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:885
ROCM Provider Options.
Definition onnxruntime_c_api.h:707
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:727
int tunable_op_max_tuning_duration_ms
Max tuning duration time limit for each instance of TunableOp. Defaults to 0 to disable the limit.
Definition onnxruntime_c_api.h:788
int do_copy_in_default_stream
Flag indicating if copying needs to take place on the same stream as the compute stream in the ROCM E...
Definition onnxruntime_c_api.h:755
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:769
size_t gpu_mem_limit
ROCM memory limit (To use all possible memory pass in maximum size_t) Defaults to SIZE_MAX.
Definition onnxruntime_c_api.h:738
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:709
int enable_hip_graph
Definition onnxruntime_c_api.h:771
int tunable_op_enable
Enable TunableOp for using. Set it to 1/0 to enable/disable TunableOp. Otherwise, it is disabled by d...
Definition onnxruntime_c_api.h:777
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:765
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:746
int tunable_op_tuning_enable
Enable TunableOp for tuning. Set it to 1/0 to enable/disable TunableOp tuning. Otherwise,...
Definition onnxruntime_c_api.h:783
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:760
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exhaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:732
TensorRT Provider Options.
Definition onnxruntime_c_api.h:796
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:810
void * user_compute_stream
Definition onnxruntime_c_api.h:799
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:797
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:811
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:812
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:800
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:802
int trt_dla_enable
Definition onnxruntime_c_api.h:807
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:805
int has_user_compute_stream
Definition onnxruntime_c_api.h:798
int trt_dla_core
Definition onnxruntime_c_api.h:808
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:806
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:801
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:814
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:809
int trt_fp16_enable
Definition onnxruntime_c_api.h:803
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:813
int trt_int8_enable
Definition onnxruntime_c_api.h:804
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122