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 23
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)
213
214// Synced with onnx TypeProto oneof
224
225// These types are synced with internal
226// SparseFormatFlags
233
234// Enum allows to query sparse tensor indices
241
253
271
283
285#define ORT_RUNTIME_CLASS(X) \
286 struct Ort##X; \
287 typedef struct Ort##X Ort##X
288
293// The actual types defined have an Ort prefix
294ORT_RUNTIME_CLASS(Env);
295ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
296ORT_RUNTIME_CLASS(MemoryInfo);
297ORT_RUNTIME_CLASS(IoBinding);
298ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
299ORT_RUNTIME_CLASS(Value);
300ORT_RUNTIME_CLASS(RunOptions);
301ORT_RUNTIME_CLASS(TypeInfo);
302ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
303ORT_RUNTIME_CLASS(MapTypeInfo);
304ORT_RUNTIME_CLASS(SequenceTypeInfo);
305ORT_RUNTIME_CLASS(OptionalTypeInfo);
306ORT_RUNTIME_CLASS(SessionOptions);
307ORT_RUNTIME_CLASS(CustomOpDomain);
308ORT_RUNTIME_CLASS(ModelMetadata);
309ORT_RUNTIME_CLASS(ThreadPoolParams);
310ORT_RUNTIME_CLASS(ThreadingOptions);
311ORT_RUNTIME_CLASS(ArenaCfg);
312ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
313ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
314ORT_RUNTIME_CLASS(NvTensorRtRtxProviderOptions);
315ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
316ORT_RUNTIME_CLASS(CANNProviderOptions);
317ORT_RUNTIME_CLASS(DnnlProviderOptions);
318ORT_RUNTIME_CLASS(Op);
319ORT_RUNTIME_CLASS(OpAttr);
320ORT_RUNTIME_CLASS(Logger);
321ORT_RUNTIME_CLASS(ShapeInferContext);
322ORT_RUNTIME_CLASS(LoraAdapter);
323ORT_RUNTIME_CLASS(ValueInfo);
324ORT_RUNTIME_CLASS(Node);
325ORT_RUNTIME_CLASS(Graph);
326ORT_RUNTIME_CLASS(Model);
327ORT_RUNTIME_CLASS(ModelCompilationOptions);
328ORT_RUNTIME_CLASS(HardwareDevice);
329ORT_RUNTIME_CLASS(EpDevice);
330ORT_RUNTIME_CLASS(KeyValuePairs);
331ORT_RUNTIME_CLASS(SyncStream); // Opaque class to create an onnxruntime::Stream.
332ORT_RUNTIME_CLASS(ExternalInitializerInfo);
333
334#ifdef _MSC_VER
335typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
336#else
338#endif
339
346typedef struct OrtAllocator {
347 uint32_t version;
348
350 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
351
353 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
354
356 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
367 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
368
394 ORT_API2_STATUS(GetStats, _In_ const struct OrtAllocator* this_, _Outptr_ OrtKeyValuePairs** out);
395
411 void*(ORT_API_CALL* AllocOnStream)(struct OrtAllocator* this_, size_t size, OrtSyncStream* stream);
413
414typedef void(ORT_API_CALL* OrtLoggingFunction)(
415 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
416 const char* message);
417
430
435
448
449struct OrtKernelInfo;
451struct OrtKernelContext;
453struct OrtCustomOp;
455
462
465// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
476
482
491
497
509
529typedef OrtStatus*(ORT_API_CALL* EpSelectionDelegate)(_In_ const OrtEpDevice** ep_devices,
530 _In_ size_t num_devices,
531 _In_ const OrtKeyValuePairs* model_metadata,
532 _In_opt_ const OrtKeyValuePairs* runtime_metadata,
533 _Inout_ const OrtEpDevice** selected,
534 _In_ size_t max_selected,
535 _Out_ size_t* num_selected,
536 _In_ void* state);
537
548typedef OrtStatus*(ORT_API_CALL* OrtWriteBufferFunc)(_In_ void* state,
549 _In_ const void* buffer,
550 _In_ size_t buffer_num_bytes);
551
583 _In_ void* state,
584 _In_ const char* initializer_name,
585 _In_ const OrtValue* initializer_value,
586 _In_opt_ const OrtExternalInitializerInfo* external_info,
587 _Outptr_result_maybenull_ OrtExternalInitializerInfo** new_external_info);
588
592 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
593 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
594 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
596
683
772
779 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
780 void* user_compute_stream; // user specified CUDA compute stream.
781 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
782 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
783 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
784 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
785 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
786 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
787 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
788 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
789 int trt_dla_core; // DLA core number. Default 0
790 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
791 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
792 const char* trt_engine_cache_path; // specify engine cache path
793 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
794 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
795 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
796 // This is the legacy struct and don't add new fields here.
797 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
798 // For non-string field, need to create a new separate api to handle it.
800
806 int device_id; // hip device id.
807 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
808 int migraphx_fp8_enable; // MIGraphX FP8 precision. Default 0 = false, nonzero = true
809 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
810 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, nonzero = true
811 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
812 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, nonzero = true
813 const char* migraphx_save_model_path; // migraphx model path name
814 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, nonzero = true
815 const char* migraphx_load_model_path; // migraphx model path name
816 bool migraphx_exhaustive_tune; // MIGraphX tuned compile. Default = false, nonzero = true
817
823
831
832 // This is the legacy struct and don't add new fields here.
834
845#ifdef __cplusplus
854#endif
859 const char* device_type;
861 const char* device_id;
863 const char* cache_dir; // path is set to empty by default
864 void* context;
866 unsigned char enable_dynamic_shapes;
868
869struct OrtApi;
870typedef struct OrtApi OrtApi;
871
872struct OrtTrainingApi;
874
875struct OrtModelEditorApi;
877
878struct OrtCompileApi;
880
881struct OrtEpApi;
882typedef struct OrtEpApi OrtEpApi;
883
898 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
899
904 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
905};
906
907typedef struct OrtApiBase OrtApiBase;
908
913ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
914
920typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
921
925
931typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
932
938typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
939
940typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
941
949typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
950
958/*
959 * Public enum for compiled model compatibility across EPs.
960 */
967
968struct OrtApi {
971
979 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
980
986 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
987
993 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
994
998
1009 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1010
1025 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
1026 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1027
1035 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
1043 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
1044
1048
1058 // TODO: document the path separator convention? '/' vs '\'
1059 // TODO: should specify the access characteristics of model_path. Is this read only during the
1060 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
1061 // and continue to access throughout the OrtSession lifetime?
1062 // What sort of access is needed to model_path : read or read/write?
1063 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
1064 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1065
1076 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env,
1077 _In_ const void* model_data, size_t model_data_length,
1078 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1079
1098 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
1099 _In_reads_(input_len) const char* const* input_names,
1100 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
1101 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
1102 _Inout_updates_all_(output_names_len) OrtValue** outputs);
1103
1107
1123 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
1124
1132 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
1133 _In_ const ORTCHAR_T* optimized_model_filepath);
1134
1142 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
1143 _Outptr_ OrtSessionOptions** out_options);
1144
1156 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
1157
1165 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
1166
1173 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
1174
1188 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
1189
1198 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
1199
1208 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
1209
1216 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
1217
1225 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
1226
1236 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1237
1245 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1246
1255 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1256 GraphOptimizationLevel graph_optimization_level);
1257
1271 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1272
1285 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1286
1290
1298 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1299
1309 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1310
1314
1324 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1325
1342 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1343
1347
1359 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1360
1372 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1373
1383 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1384
1393 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1394
1403 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1404
1413 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1414
1424 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1425
1435 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1436
1446 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1447 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1448
1452
1459 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1460
1470 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1471
1479 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1480
1490 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1491
1501 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1502 _Out_ int* log_verbosity_level);
1503
1511 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1512
1524 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1525
1534 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1535
1544 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1545
1549
1562 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1564
1582 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1583 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1584 _Outptr_ OrtValue** out);
1585
1593 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1594
1605 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1606
1615 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1616
1626 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1627
1647 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1648 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1649
1653
1662 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1663 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1664
1672 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1673
1677
1685
1694
1703 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1704
1714 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1716
1726 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1727
1736 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1737 size_t dim_values_length);
1738
1747 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1748 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1749
1766 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1767
1771
1779 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
1780
1788 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
1789
1797 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
1798
1802
1813 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
1814 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
1815
1826 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
1827 _Outptr_ OrtMemoryInfo** out);
1828
1839 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
1840
1848 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
1849
1852 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
1853
1856 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
1857
1860 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
1861
1865
1867 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
1869 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
1871 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
1872
1881 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
1882
1886
1898 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
1899 _In_ int64_t dim_value);
1900
1904
1905 /* Internal information (not seen in Doxygen)
1906 *
1907 * APIs to support non-tensor types - map and sequence.
1908 * Currently only the following types are supported
1909 * Note: the following types should be kept in sync with data_types.h
1910 * Map types
1911 * =========
1912 * std::map<std::string, std::string>
1913 * std::map<std::string, int64_t>
1914 * std::map<std::string, float>
1915 * std::map<std::string, double>
1916 * std::map<int64_t, std::string>
1917 * std::map<int64_t, int64_t>
1918 * std::map<int64_t, float>
1919 * std::map<int64_t, double>
1920 *
1921 * Sequence types
1922 * ==============
1923 * std::vector<std::string>
1924 * std::vector<int64_t>
1925 * std::vector<float>
1926 * std::vector<double>
1927 * std::vector<std::map<std::string, float>>
1928 * std::vector<std::map<int64_t, float>
1929 */
1930
1945 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
1946 _Outptr_ OrtValue** out);
1947
1958 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
1959
1975 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
1976 enum ONNXType value_type, _Outptr_ OrtValue** out);
1977
2000 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
2001 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
2002
2017 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
2018 _Out_ void* data_container, size_t data_container_size);
2019
2024
2033 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2034 _Out_ float* out);
2035
2044 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2045 _Out_ int64_t* out);
2046
2067 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
2068 _Inout_ size_t* size);
2069
2074
2079 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2080
2085 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2086
2098 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
2099 _Out_ const OrtValue** out);
2100
2114 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
2115 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
2116
2120 ORT_CLASS_RELEASE(Env);
2124 ORT_CLASS_RELEASE(Status);
2128 ORT_CLASS_RELEASE(MemoryInfo);
2132 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
2136 ORT_CLASS_RELEASE(Value);
2140 ORT_CLASS_RELEASE(RunOptions);
2144 ORT_CLASS_RELEASE(TypeInfo);
2148 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
2152 ORT_CLASS_RELEASE(SessionOptions);
2156 ORT_CLASS_RELEASE(CustomOpDomain);
2157
2161
2174 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
2175 _Out_ size_t* len);
2176
2190 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
2191 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
2192
2206 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
2207 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
2208
2212
2224 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
2225
2234 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2235
2239
2250 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2251 _Outptr_ OrtTypeInfo** type_info);
2252
2256 ORT_CLASS_RELEASE(MapTypeInfo);
2260 ORT_CLASS_RELEASE(SequenceTypeInfo);
2261
2265
2276 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2277
2285 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2286
2290
2299 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2300 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2301
2310 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2311 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2312
2321 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2322 _Outptr_ char** value);
2323
2332 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2333 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2334
2345 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2346 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2347
2355 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2356
2357 ORT_CLASS_RELEASE(ModelMetadata);
2358
2362
2376 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2377 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2378
2382
2392 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2393
2397
2403 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2404
2405 ORT_CLASS_RELEASE(ThreadingOptions);
2406
2410
2422 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2423 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2424
2428
2436 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2437 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2438 _In_ int64_t dim_value);
2439
2443
2455 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2456
2465 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2466 _In_ int providers_length);
2467
2471
2480 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2481
2491 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2492
2501 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2502
2506
2519 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2520 _In_z_ const char* config_key, _In_z_ const char* config_value);
2521
2525
2536 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2537 _Outptr_ OrtAllocator** out);
2538
2541 ORT_CLASS_RELEASE(Allocator);
2542
2546
2557 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2558
2570 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2571
2575
2578 ORT_CLASS_RELEASE(IoBinding);
2579
2590 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2591
2602 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2603
2619 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2620
2638 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2639 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2640
2658 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2659 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2660
2663 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2664
2667 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2668
2672
2687 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2688
2692
2707 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2708 _In_ const OrtArenaCfg* arena_cfg);
2709
2721 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2722
2726
2736 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2737
2741
2753 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2754
2766 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
2767
2781 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
2782
2786
2801 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
2802 _In_ const OrtValue* val);
2803
2807
2823 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
2824 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2825
2829
2840 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
2841
2852 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
2853
2864 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
2865
2869
2880 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
2881
2885
2898 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
2899 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
2900
2901 ORT_CLASS_RELEASE(ArenaCfg);
2902
2906
2918 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
2919 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2920
2924
2935 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
2936
2940
2951 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
2952
2963 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
2964
2969
2992 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2993 _Out_ float* out, _Inout_ size_t* size);
2994
3016 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
3017 _Out_ int64_t* out, _Inout_ size_t* size);
3018
3022
3054 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
3055 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
3056 _Outptr_ OrtArenaCfg** out);
3057
3061
3074 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
3075 _In_z_ const char* config_key, _In_z_ const char* config_value);
3076
3080
3094
3099 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
3100
3104
3122 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
3123 _In_ const OrtSessionOptions* options,
3124 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3125 _Outptr_ OrtSession** out);
3126
3145 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
3146 _In_ const void* model_data, size_t model_data_length,
3147 _In_ const OrtSessionOptions* options,
3148 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3149 _Outptr_ OrtSession** out);
3150
3154
3173 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
3174
3178
3186
3202 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
3203 _In_reads_(num_keys) const char* const* provider_options_keys,
3204 _In_reads_(num_keys) const char* const* provider_options_values,
3205 _In_ size_t num_keys);
3206
3218 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3219
3224 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
3225
3229
3236 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
3237
3241
3257 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3258
3269 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3270 _In_ const OrtMemoryInfo* mem_info);
3271
3275
3284 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3285
3302 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3303 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3304
3322 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3323 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3324 _In_ const int64_t* indices_data, size_t indices_num);
3325
3345 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3346 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3347 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3348 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3349
3368 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3369 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3370 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3371 _In_ const int32_t* indices_data);
3372
3397 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3398 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3399 _In_ const int64_t* values_shape, size_t values_shape_len,
3401
3416 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3417
3434 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3435 _Inout_ int64_t* outer_data, size_t outer_num);
3436
3450 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3451
3459 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3460
3468 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3469
3477 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3478
3488 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3489
3499 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3503
3516 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3517
3522
3534 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3535
3539
3545 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3546
3550
3560 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3561
3563
3566
3573 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3574
3582 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3583
3591 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3593
3596
3603 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3604
3612 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3613
3621 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3623
3632 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3633
3642 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3643
3646
3667 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3668
3672
3681 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3682
3700 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3701 _In_reads_(num_keys) const char* const* provider_options_keys,
3702 _In_reads_(num_keys) const char* const* provider_options_values,
3703 _In_ size_t num_keys);
3704
3719 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3720
3727 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3728
3730
3743 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3744
3766 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
3767 _In_reads_(num_initializers) const char* const* initializer_names,
3768 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
3769
3781 ORT_API2_STATUS(CreateOpAttr,
3782 _In_ const char* name,
3783 _In_ const void* data,
3784 _In_ int len,
3785 _In_ OrtOpAttrType type,
3786 _Outptr_ OrtOpAttr** op_attr);
3787
3788 /* \brief: Release op attribute
3789 *
3790 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
3791 *
3792 * \since Version 1.12.
3793 */
3794 ORT_CLASS_RELEASE(OpAttr);
3795
3813 ORT_API2_STATUS(CreateOp,
3814 _In_ const OrtKernelInfo* info,
3815 _In_z_ const char* op_name,
3816 _In_z_ const char* domain,
3817 int version,
3818 _In_reads_(type_constraint_count) const char** type_constraint_names,
3819 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
3820 int type_constraint_count,
3821 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
3822 int attr_count,
3823 int input_count,
3824 int output_count,
3825 _Outptr_ OrtOp** ort_op);
3826
3839 ORT_API2_STATUS(InvokeOp,
3840 _In_ const OrtKernelContext* context,
3841 _In_ const OrtOp* ort_op,
3842 _In_ const OrtValue* const* input_values,
3843 _In_ int input_count,
3844 _Inout_ OrtValue* const* output_values,
3845 _In_ int output_count);
3846
3847 /* \brief: Release an onnxruntime operator
3848 *
3849 * \param[in] Op Operator created by OrtApi::CreateOp
3850 *
3851 * \since Version 1.12.
3852 */
3853 ORT_CLASS_RELEASE(Op);
3854
3973 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
3974 _In_ const char* provider_name,
3975 _In_reads_(num_keys) const char* const* provider_options_keys,
3976 _In_reads_(num_keys) const char* const* provider_options_values,
3977 _In_ size_t num_keys);
3978
3979 /* \brief: Get a copy of kernel info
3980 *
3981 * \param[in] info Kernel info
3982 * \param[out] info_copy Copy of kernel info
3983 *
3984 * \since Version 1.12.
3985 */
3986 ORT_API2_STATUS(CopyKernelInfo,
3987 _In_ const OrtKernelInfo* info,
3988 _Outptr_ OrtKernelInfo** info_copy);
3989
3990 /* \brief: Release kernel info
3991 *
3992 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
3993 *
3994 * \since Version 1.12.
3995 */
3996 ORT_CLASS_RELEASE(KernelInfo);
3997
4000
4014 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
4015
4017
4030 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
4031
4040 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
4041
4053 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
4054 _In_reads_(num_keys) const char* const* provider_options_keys,
4055 _In_reads_(num_keys) const char* const* provider_options_values,
4056 _In_ size_t num_keys);
4057
4071 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
4072 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4073
4080 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
4081
4082 /* \brief Get OrtDevice type from MemoryInfo
4083 *
4084 * \since Version 1.14
4085 */
4086 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
4087
4088 /* \brief Update the OrtEnv instance with custom log severity level
4089 *
4090 * \param[in] ort_env The OrtEnv instance being used
4091 * \param[in] log_severity_level The log severity level.
4092 *
4093 * \since Version 1.14.
4094 */
4095 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
4096
4097 /* \brief Set affinities for intra op threads
4098 *
4099 * Affinity string follows format:
4100 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
4101 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
4102 * e.g. 1,2,3;4,5
4103 * 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.
4104 * To ease the configuration, an "interval" is also allowed:
4105 * e.g. 1-8;8-16;17-24
4106 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
4107 * Note:
4108 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
4109 * ort does not set affinity on the main thread which is started and managed by the calling app;
4110 * 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,
4111 * 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.
4112 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
4113 *
4114 * \since Version 1.14
4115 */
4116 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
4117
4136 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
4137
4162 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
4163 _In_ const char* registration_func_name);
4164
4168
4180 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4181
4193 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4194
4219 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
4220 _Inout_ size_t* size);
4221
4247 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
4248 _Inout_ size_t* size);
4249
4262 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4263 _Outptr_ OrtTypeInfo** type_info);
4264
4277 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4278 _Outptr_ OrtTypeInfo** type_info);
4279
4292 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4293 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4294
4299
4315 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4316 _In_z_ const char* config_key, _Out_ int* out);
4317
4346 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4347 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4348
4350
4363 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4364
4373 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4374
4391 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4392 _In_reads_(num_keys) const char* const* provider_options_keys,
4393 _In_reads_(num_keys) const char* const* provider_options_values,
4394 _In_ size_t num_keys);
4395
4410 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4411
4416 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4417
4421
4444 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_ char* out, _Inout_ size_t* size);
4445
4457 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4458
4463
4475 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4476
4481
4500 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4501 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4502 _In_z_ const char* func_name);
4503
4515 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4516
4518
4532 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4533
4554 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4555 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4556
4573 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4574 _Outptr_ OrtTypeInfo** out);
4575
4586 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4587
4598 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4599
4606 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4607
4610
4619 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4620
4638 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4639 _In_reads_(num_keys) const char* const* provider_options_keys,
4640 _In_reads_(num_keys) const char* const* provider_options_values,
4641 _In_ size_t num_keys);
4642
4657 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4658
4665 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
4666
4680 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type,
4681 _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
4682 _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);
4683
4702 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
4703 _In_reads_(input_len) const char* const* input_names,
4704 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
4705 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
4706 _Inout_updates_all_(output_names_len) OrtValue** output,
4707 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
4708
4721 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
4722
4733 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
4734
4747 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
4748
4759 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
4760
4772 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
4773 _In_ int resource_id, _Outptr_ void** resource);
4774
4792 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
4793 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
4794
4803 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
4804
4814 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
4815
4825 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
4826
4836 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
4837
4847 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
4848
4862 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
4863
4874 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
4875
4887 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);
4888
4903 _In_ OrtSessionOptions* options,
4904 _In_reads_(num_keys) const char* const* provider_options_keys,
4905 _In_reads_(num_keys) const char* const* provider_options_values,
4906 _In_ size_t num_keys);
4907
4922 _In_ OrtSessionOptions* options,
4923 _In_reads_(num_keys) const char* const* provider_options_keys,
4924 _In_reads_(num_keys) const char* const* provider_options_values,
4925 _In_ size_t num_keys);
4926
4938 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
4939
4950 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
4951
4973 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
4974 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
4975 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
4976 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
4977 size_t num_external_initializer_files);
4978
4997 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
4998 _Outptr_ OrtLoraAdapter** out);
4999
5017 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
5018 _Outptr_ OrtLoraAdapter** out);
5019
5022 ORT_CLASS_RELEASE(LoraAdapter);
5023
5040 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
5041
5045
5060 ORT_API2_STATUS(SetEpDynamicOptions, _Inout_ OrtSession* sess, _In_reads_(kv_len) const char* const* keys,
5061 _In_reads_(kv_len) const char* const* values, _In_ size_t kv_len);
5062
5064
5068 ORT_CLASS_RELEASE(ValueInfo);
5069
5073 ORT_CLASS_RELEASE(Node);
5074
5079 ORT_CLASS_RELEASE(Graph);
5080
5085 ORT_CLASS_RELEASE(Model);
5086
5093 ORT_API2_STATUS(GetValueInfoName, _In_ const OrtValueInfo* value_info, _Out_ const char** name);
5094
5101 ORT_API2_STATUS(GetValueInfoTypeInfo, _In_ const OrtValueInfo* value_info, _Outptr_ const OrtTypeInfo** type_info);
5102
5111 const OrtModelEditorApi*(ORT_API_CALL* GetModelEditorApi)();
5112
5131 ORT_API2_STATUS(CreateTensorWithDataAndDeleterAsOrtValue, _In_ OrtAllocator* deleter,
5132 _In_ void* p_data, size_t p_data_len,
5133 _In_ const int64_t* shape, size_t shape_len,
5135 _Outptr_ OrtValue** out);
5136
5153 ORT_API2_STATUS(SessionOptionsSetLoadCancellationFlag, _Inout_ OrtSessionOptions* options,
5154 _In_ bool cancel);
5155
5169 const OrtCompileApi*(ORT_API_CALL* GetCompileApi)();
5170
5171 //
5172 // OrtKeyValuePairs
5173 //
5174
5183 void(ORT_API_CALL* CreateKeyValuePairs)(_Outptr_ OrtKeyValuePairs** out);
5184
5198 void(ORT_API_CALL* AddKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key, _In_ const char* value);
5199
5209 const char*(ORT_API_CALL* GetKeyValue)(_In_ const OrtKeyValuePairs* kvps, _In_ const char* key);
5210
5220 void(ORT_API_CALL* GetKeyValuePairs)(_In_ const OrtKeyValuePairs* kvps,
5221 _Outptr_ const char* const** keys, _Outptr_ const char* const** values,
5222 _Out_ size_t* num_entries);
5223
5231 void(ORT_API_CALL* RemoveKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key);
5232
5239 ORT_CLASS_RELEASE(KeyValuePairs);
5240
5254 ORT_API2_STATUS(RegisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name,
5255 _In_ const ORTCHAR_T* path);
5256
5271 ORT_API2_STATUS(UnregisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name);
5272
5285 ORT_API2_STATUS(GetEpDevices, _In_ const OrtEnv* env,
5286 _Outptr_ const OrtEpDevice* const** ep_devices, _Out_ size_t* num_ep_devices);
5287
5307 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_V2, _In_ OrtSessionOptions* session_options,
5308 _In_ OrtEnv* env,
5309 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices, _In_ size_t num_ep_devices,
5310 _In_reads_(num_op_options) const char* const* ep_option_keys,
5311 _In_reads_(num_op_options) const char* const* ep_option_vals,
5312 size_t num_ep_options);
5313
5324 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicy, _In_ OrtSessionOptions* session_options,
5326
5337 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicyDelegate, _In_ OrtSessionOptions* session_options,
5338 _In_ EpSelectionDelegate delegate,
5339 _In_opt_ void* delegate_state);
5340
5349
5357 uint32_t(ORT_API_CALL* HardwareDevice_VendorId)(_In_ const OrtHardwareDevice* device);
5358
5366 const char*(ORT_API_CALL* HardwareDevice_Vendor)(_In_ const OrtHardwareDevice* device);
5367
5376 uint32_t(ORT_API_CALL* HardwareDevice_DeviceId)(_In_ const OrtHardwareDevice* device);
5377
5386 const OrtKeyValuePairs*(ORT_API_CALL* HardwareDevice_Metadata)(_In_ const OrtHardwareDevice* device);
5387
5395 const char*(ORT_API_CALL* EpDevice_EpName)(_In_ const OrtEpDevice* ep_device);
5396
5404 const char*(ORT_API_CALL* EpDevice_EpVendor)(_In_ const OrtEpDevice* ep_device);
5405
5413 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpMetadata)(_In_ const OrtEpDevice* ep_device);
5414
5422 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpOptions)(_In_ const OrtEpDevice* ep_device);
5423
5431 const OrtHardwareDevice*(ORT_API_CALL* EpDevice_Device)(_In_ const OrtEpDevice* ep_device);
5432
5437 const OrtEpApi*(ORT_API_CALL* GetEpApi)();
5438
5452 ORT_API2_STATUS(GetTensorSizeInBytes, _In_ const OrtValue* ort_value, _Out_ size_t* size);
5453
5468 ORT_API2_STATUS(AllocatorGetStats, _In_ const OrtAllocator* ort_allocator, _Outptr_ OrtKeyValuePairs** out);
5469
5490 ORT_API2_STATUS(CreateMemoryInfo_V2, _In_ const char* name, _In_ enum OrtMemoryInfoDeviceType device_type,
5491 _In_ uint32_t vendor_id, _In_ int32_t device_id, _In_ enum OrtDeviceMemoryType mem_type,
5492 _In_ size_t alignment, enum OrtAllocatorType allocator_type,
5493 _Outptr_ OrtMemoryInfo** out);
5494
5503
5511 ORT_API_T(uint32_t, MemoryInfoGetVendorId, _In_ const OrtMemoryInfo* ptr);
5512
5515
5526 ORT_API2_STATUS(ValueInfo_GetValueProducer, _In_ const OrtValueInfo* value_info,
5527 _Outptr_ const OrtNode** producer_node, _Out_opt_ size_t* producer_output_index);
5528
5544 ORT_API2_STATUS(ValueInfo_GetValueNumConsumers, _In_ const OrtValueInfo* value_info, _Out_ size_t* num_consumers);
5545
5572 ORT_API2_STATUS(ValueInfo_GetValueConsumers, _In_ const OrtValueInfo* value_info,
5573 _Out_writes_all_(num_consumers) const OrtNode** nodes,
5574 _Out_writes_all_(num_consumers) int64_t* input_indices,
5575 _In_ size_t num_consumers);
5576
5596 ORT_API2_STATUS(ValueInfo_GetInitializerValue, _In_ const OrtValueInfo* value_info,
5597 _Outptr_ const OrtValue** initializer_value);
5598
5614 ORT_API2_STATUS(ValueInfo_GetExternalInitializerInfo, _In_ const OrtValueInfo* value_info,
5615 _Outptr_result_maybenull_ OrtExternalInitializerInfo** info);
5616
5631 ORT_API2_STATUS(ValueInfo_IsRequiredGraphInput, _In_ const OrtValueInfo* value_info,
5632 _Out_ bool* is_required_graph_input);
5633
5647 ORT_API2_STATUS(ValueInfo_IsOptionalGraphInput, _In_ const OrtValueInfo* value_info,
5648 _Out_ bool* is_optional_graph_input);
5649
5659 ORT_API2_STATUS(ValueInfo_IsGraphOutput, _In_ const OrtValueInfo* value_info, _Out_ bool* is_graph_output);
5660
5675 ORT_API2_STATUS(ValueInfo_IsConstantInitializer, _In_ const OrtValueInfo* value_info,
5676 _Out_ bool* is_constant_initializer);
5677
5691 ORT_API2_STATUS(ValueInfo_IsFromOuterScope, _In_ const OrtValueInfo* value_info,
5692 _Out_ bool* is_from_outer_scope);
5693
5695
5698
5708 ORT_API2_STATUS(Graph_GetName, _In_ const OrtGraph* graph, _Outptr_ const char** graph_name);
5709
5723 ORT_API2_STATUS(Graph_GetModelPath, _In_ const OrtGraph* graph, _Outptr_ const ORTCHAR_T** model_path);
5724
5734 ORT_API2_STATUS(Graph_GetOnnxIRVersion, _In_ const OrtGraph* graph, _Out_ int64_t* onnx_ir_version);
5735
5749 ORT_API2_STATUS(Graph_GetNumOperatorSets, _In_ const OrtGraph* graph, _Out_ size_t* num_operator_sets);
5750
5771 ORT_API2_STATUS(Graph_GetOperatorSets, _In_ const OrtGraph* graph,
5772 _Out_writes_(num_operator_sets) const char** domains,
5773 _Out_writes_(num_operator_sets) int64_t* opset_versions, _In_ size_t num_operator_sets);
5774
5786 ORT_API2_STATUS(Graph_GetNumInputs, _In_ const OrtGraph* graph, _Out_ size_t* num_inputs);
5787
5802 ORT_API2_STATUS(Graph_GetInputs, _In_ const OrtGraph* graph,
5803 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
5804
5814 ORT_API2_STATUS(Graph_GetNumOutputs, _In_ const OrtGraph* graph, _Out_ size_t* num_outputs);
5815
5828 ORT_API2_STATUS(Graph_GetOutputs, _In_ const OrtGraph* graph,
5829 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
5830
5842 ORT_API2_STATUS(Graph_GetNumInitializers, _In_ const OrtGraph* graph, _Out_ size_t* num_initializers);
5843
5865 ORT_API2_STATUS(Graph_GetInitializers, _In_ const OrtGraph* graph,
5866 _Out_writes_(num_initializers) const OrtValueInfo** initializers,
5867 _In_ size_t num_initializers);
5868
5878 ORT_API2_STATUS(Graph_GetNumNodes, _In_ const OrtGraph* graph, _Out_ size_t* num_nodes);
5879
5895 ORT_API2_STATUS(Graph_GetNodes, _In_ const OrtGraph* graph,
5896 _Out_writes_(num_nodes) const OrtNode** nodes, _In_ size_t num_nodes);
5897
5911 ORT_API2_STATUS(Graph_GetParentNode, _In_ const OrtGraph* graph, _Outptr_result_maybenull_ const OrtNode** node);
5912
5927 ORT_API2_STATUS(Graph_GetGraphView, _In_ const OrtGraph* src_graph, _In_ const OrtNode** nodes,
5928 _In_ size_t num_nodes, _Outptr_ OrtGraph** dst_graph);
5929
5931
5934
5947 ORT_API2_STATUS(Node_GetId, _In_ const OrtNode* node, _Out_ size_t* node_id);
5948
5958 ORT_API2_STATUS(Node_GetName, _In_ const OrtNode* node, _Outptr_ const char** node_name);
5959
5969 ORT_API2_STATUS(Node_GetOperatorType, _In_ const OrtNode* node, _Outptr_ const char** operator_type);
5970
5980 ORT_API2_STATUS(Node_GetDomain, _In_ const OrtNode* node, _Outptr_ const char** domain_name);
5981
5991 ORT_API2_STATUS(Node_GetSinceVersion, _In_ const OrtNode* node, _Out_ int* since_version);
5992
6002 ORT_API2_STATUS(Node_GetNumInputs, _In_ const OrtNode* node, _Out_ size_t* num_inputs);
6003
6016 ORT_API2_STATUS(Node_GetInputs, _In_ const OrtNode* node,
6017 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6018
6028 ORT_API2_STATUS(Node_GetNumOutputs, _In_ const OrtNode* node, _Out_ size_t* num_outputs);
6029
6042 ORT_API2_STATUS(Node_GetOutputs, _In_ const OrtNode* node,
6043 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6044
6058 ORT_API2_STATUS(Node_GetNumImplicitInputs, _In_ const OrtNode* node, _Out_ size_t* num_implicit_inputs);
6059
6077 ORT_API2_STATUS(Node_GetImplicitInputs, _In_ const OrtNode* node,
6078 _Out_writes_(num_implicit_inputs) const OrtValueInfo** implicit_inputs,
6079 _In_ size_t num_implicit_inputs);
6080
6090 ORT_API2_STATUS(Node_GetNumAttributes, _In_ const OrtNode* node, _Out_ size_t* num_attributes);
6091
6109 ORT_API2_STATUS(Node_GetAttributes, _In_ const OrtNode* node,
6110 _Out_writes_(num_attributes) const OrtOpAttr** attributes, _In_ size_t num_attributes);
6111
6130 ORT_API2_STATUS(Node_GetAttributeByName, _In_ const OrtNode* node, _In_ const char* attribute_name,
6131 _Outptr_result_maybenull_ const OrtOpAttr** attribute);
6132
6143 ORT_API2_STATUS(OpAttr_GetTensorAttributeAsOrtValue, _In_ const OrtOpAttr* attribute,
6144 _Outptr_result_maybenull_ OrtValue** attr_tensor);
6145
6155 ORT_API2_STATUS(OpAttr_GetType, _In_ const OrtOpAttr* attribute, _Out_ OrtOpAttrType* type);
6156
6166 ORT_API2_STATUS(OpAttr_GetName, _In_ const OrtOpAttr* attribute, _Outptr_ const char** name);
6167
6179 ORT_API2_STATUS(Node_GetNumSubgraphs, _In_ const OrtNode* node, _Out_ size_t* num_subgraphs);
6180
6198 ORT_API2_STATUS(Node_GetSubgraphs, _In_ const OrtNode* node,
6199 _Out_writes_(num_subgraphs) const OrtGraph** subgraphs, _In_ size_t num_subgraphs,
6200 _Out_writes_opt_(num_subgraphs) const char** attribute_names);
6201
6214 ORT_API2_STATUS(Node_GetGraph, _In_ const OrtNode* node, _Outptr_result_maybenull_ const OrtGraph** graph);
6215
6227 ORT_API2_STATUS(Node_GetEpName, _In_ const OrtNode* node, _Outptr_result_maybenull_ const char** out);
6228
6230
6233
6240 ORT_CLASS_RELEASE(ExternalInitializerInfo);
6241
6253 ORT_API_T(const ORTCHAR_T*, ExternalInitializerInfo_GetFilePath, _In_ const OrtExternalInitializerInfo* info);
6254
6263
6272
6274
6277
6292 ORT_API_T(const char*, GetRunConfigEntry, _In_ const OrtRunOptions* options,
6293 _In_z_ const char* config_key);
6294
6296
6306 ORT_API_T(const OrtMemoryInfo*, EpDevice_MemoryInfo, _In_ const OrtEpDevice* ep_device,
6307 _In_ OrtDeviceMemoryType memory_type);
6308
6332 ORT_API2_STATUS(CreateSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6333 _In_ OrtDeviceMemoryType mem_type, _In_ OrtAllocatorType allocator_type,
6334 _In_opt_ const OrtKeyValuePairs* allocator_options,
6335 _Outptr_opt_ OrtAllocator** allocator);
6336
6355 ORT_API2_STATUS(GetSharedAllocator, _In_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
6356 _Outptr_result_maybenull_ OrtAllocator** allocator);
6357
6371 ORT_API2_STATUS(ReleaseSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6372 _In_ OrtDeviceMemoryType mem_type);
6373
6386 ORT_API2_STATUS(GetTensorData, _In_ const OrtValue* value, _Outptr_ const void** out);
6387
6398 ORT_API2_STATUS(GetSessionOptionsConfigEntries, _In_ const OrtSessionOptions* options, _Outptr_ OrtKeyValuePairs** out);
6399
6417 ORT_API2_STATUS(SessionGetMemoryInfoForInputs, _In_ const OrtSession* session,
6418 _Out_writes_(num_inputs) const OrtMemoryInfo** inputs_memory_info,
6419 _In_ size_t num_inputs);
6420
6440 ORT_API2_STATUS(SessionGetMemoryInfoForOutputs, _In_ const OrtSession* session,
6441 _Out_writes_(num_outputs) const OrtMemoryInfo** outputs_memory_info,
6442 _In_ size_t num_outputs);
6443
6468 ORT_API2_STATUS(SessionGetEpDeviceForInputs, _In_ const OrtSession* session,
6469 _Out_writes_(num_inputs) const OrtEpDevice** inputs_ep_devices,
6470 _In_ size_t num_inputs);
6471
6487 ORT_API2_STATUS(CreateSyncStreamForEpDevice, _In_ const OrtEpDevice* ep_device,
6488 _In_opt_ const OrtKeyValuePairs* stream_options,
6489 _Outptr_ OrtSyncStream** stream);
6490
6501 ORT_API_T(void*, SyncStream_GetHandle, _In_ OrtSyncStream* stream);
6502
6503 ORT_CLASS_RELEASE(SyncStream);
6504
6529 ORT_API2_STATUS(CopyTensors, _In_ const OrtEnv* env,
6530 _In_reads_(num_tensors) const OrtValue* const* src_tensors,
6531 _In_reads_(num_tensors) OrtValue* const* dst_tensors,
6532 _In_opt_ OrtSyncStream* stream,
6533 _In_ size_t num_tensors);
6534
6544 ORT_API2_STATUS(Graph_GetModelMetadata, _In_ const OrtGraph* graph, _Outptr_ OrtModelMetadata** out);
6545
6558 ORT_API2_STATUS(GetModelCompatibilityForEpDevices,
6559 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices,
6560 _In_ size_t num_ep_devices,
6561 _In_ const char* compatibility_info,
6563
6566
6579 ORT_API2_STATUS(CreateExternalInitializerInfo, _In_ const ORTCHAR_T* filepath, _In_ int64_t file_offset,
6580 _In_ size_t byte_size, _Outptr_ OrtExternalInitializerInfo** out);
6581
6583};
6584
6585/*
6586 * Steps to use a custom op:
6587 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
6588 * 2 Create an OrtCustomOp structure for each op and add them to the domain
6589 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
6590 */
6591
6592// Specifies some characteristics of inputs/outputs of custom ops:
6593// Specify if the inputs/outputs are one of:
6594// 1) Non-optional (input/output must be present in the node)
6595// 2) Optional (input/output may be absent in the node)
6596// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
6597// Only the last input or output of a custom op may be marked as variadic.
6598// The homogeneity of the variadic input or output determines whether all operands must be of the same
6599// tensor element type.
6605
6606/*
6607 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
6608 * the implementor of the custom op.
6609 */
6611 uint32_t version; // Must be initialized to ORT_API_VERSION
6612
6613 // This callback creates the kernel, which is a user defined
6614 // parameter that is passed to the Kernel* callbacks below. It is
6615 // recommended to use CreateKernelV2 which allows for a safe error
6616 // propagation by returning an OrtStatusPtr.
6617 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
6618 _In_ const OrtKernelInfo* info);
6619
6620 // Returns the name of the op
6621 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
6622
6623 // Returns the type of the execution provider, return nullptr to use CPU execution provider
6624 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
6625
6626 // Returns the count and types of the input & output tensors
6627 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
6628 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
6629 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
6630 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
6631
6632 // Perform a computation step. It is recommended to use
6633 // KernelComputeV2 which allows for a safe error propagation by
6634 // returning an OrtStatusPtr.
6635 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
6636 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
6637
6638 // Returns the characteristics of the input & output tensors
6639 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
6640 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
6641
6642 // Returns the memory type of the input tensors. This API allows the custom op
6643 // to place the inputs on specific devices. By default, it returns
6644 // OrtMemTypeDefault, which means the input is placed on the default device for
6645 // the execution provider. If the inputs need to be with different memory types,
6646 // this function can be overridden to return the specific memory types.
6647 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
6648
6649 // Returns the minimum number of input arguments expected for the variadic input.
6650 // Applicable only for custom ops that have a variadic input.
6651 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
6652
6653 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
6654 // and false (zero) otherwise.
6655 // Applicable only for custom ops that have a variadic input.
6656 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
6657
6658 // Returns the minimum number of output values expected for the variadic output.
6659 // Applicable only for custom ops that have a variadic output.
6660 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
6661
6662 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
6663 // and false (zero) otherwise.
6664 // Applicable only for custom ops that have a variadic output.
6665 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
6666
6667 // Create the kernel state which is passed to each compute call.
6668 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
6669 _In_ const OrtKernelInfo* info,
6670 _Out_ void** kernel);
6671
6672 // Perform the computation step.
6673 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
6674
6675 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
6676
6677 // Get start range
6678 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
6679 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
6680
6681 // Get the inplace_map that defines which output can reuse which input
6682 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
6683 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
6684 // The return value is the size of these 2 arrays.
6685 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
6686 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
6687
6688 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
6689 // If GetMayInplace() is defined, this function MUST be defined as well.
6690 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
6691
6692 // Same as GetMayInplace() and ReleaseMayInplace()
6693 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
6694 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
6695};
6696
6709 // Model building/editing requires a full build. We return nullptr from GetModelEditorApi if this is a minimal
6710 // build, so it doesn't matter if there are no function pointers in this struct as a user will never get an
6711 // OrtModelEditorApi instance. We do however need a dummy field to avoid empty struct warning.
6712#if defined(ORT_MINIMAL_BUILD)
6713 const bool not_defined_in_this_build;
6714#else
6728 ORT_API2_STATUS(CreateTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
6729 _Outptr_ OrtTypeInfo** type_info);
6730
6744 ORT_API2_STATUS(CreateSparseTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
6745 _Outptr_ OrtTypeInfo** type_info);
6746
6761 ORT_API2_STATUS(CreateMapTypeInfo, ONNXTensorElementDataType map_key_type, _In_ const OrtTypeInfo* map_value_type,
6762 _Outptr_ OrtTypeInfo** type_info);
6763
6777 ORT_API2_STATUS(CreateSequenceTypeInfo, _In_ const OrtTypeInfo* sequence_type, _Outptr_ OrtTypeInfo** type_info);
6778
6792 ORT_API2_STATUS(CreateOptionalTypeInfo, _In_ const OrtTypeInfo* contained_type, _Outptr_ OrtTypeInfo** type_info);
6793
6804 ORT_API2_STATUS(CreateValueInfo, _In_ const char* name, _In_ const OrtTypeInfo* type_info,
6805 _Outptr_ OrtValueInfo** value_info);
6806
6828 ORT_API2_STATUS(CreateNode, _In_ const char* operator_name, _In_ const char* domain_name, _In_ const char* node_name,
6829 _In_reads_(input_names_len) const char* const* input_names, size_t input_names_len,
6830 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
6831 _In_reads_(attribs_len) _In_opt_ OrtOpAttr** attributes, _In_ size_t attribs_len,
6832 _Outptr_ OrtNode** node);
6833
6838 ORT_API2_STATUS(CreateGraph, _Outptr_ OrtGraph** graph);
6839
6853 ORT_API2_STATUS(SetGraphInputs, _Inout_ OrtGraph* graph,
6854 _In_reads_(inputs_len) _In_ OrtValueInfo** inputs, _In_ size_t inputs_len);
6855
6869 ORT_API2_STATUS(SetGraphOutputs, _Inout_ OrtGraph* graph,
6870 _In_reads_(outputs_len) _In_ OrtValueInfo** outputs, _In_ size_t outputs_len);
6871
6910 ORT_API2_STATUS(AddInitializerToGraph, _Inout_ OrtGraph* graph, _In_ const char* name, _In_ OrtValue* tensor,
6911 bool data_is_external);
6912
6924 ORT_API2_STATUS(AddNodeToGraph, _Inout_ OrtGraph* graph, _In_ OrtNode* node);
6925
6944 ORT_API2_STATUS(CreateModel,
6945 _In_reads_(opset_entries_len) const char* const* domain_names,
6946 _In_reads_(opset_entries_len) const int* opset_versions,
6947 size_t opset_entries_len,
6948 _Outptr_ OrtModel** model);
6949
6963 ORT_API2_STATUS(AddGraphToModel, _Inout_ OrtModel* model, _In_ OrtGraph* graph);
6964
6983 ORT_API2_STATUS(CreateSessionFromModel, _In_ const OrtEnv* env, _In_ const OrtModel* model,
6984 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
6985
7008 ORT_API2_STATUS(CreateModelEditorSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
7009 _In_ const OrtSessionOptions* options,
7010 _Outptr_ OrtSession** out);
7011
7036 ORT_API2_STATUS(CreateModelEditorSessionFromArray, _In_ const OrtEnv* env,
7037 _In_ const void* model_data, size_t model_data_length,
7038 _In_ const OrtSessionOptions* options,
7039 _Outptr_ OrtSession** out);
7040
7055 ORT_API2_STATUS(SessionGetOpsetForDomain, _In_ const OrtSession* session, _In_ const char* domain, _Out_ int* opset);
7056
7075 ORT_API2_STATUS(ApplyModelToModelEditorSession, _Inout_ OrtSession* session, _In_ OrtModel* model);
7076
7090 ORT_API2_STATUS(FinalizeModelEditorSession, _Inout_ OrtSession* session, _In_ const OrtSessionOptions* options,
7091 _In_opt_ OrtPrepackedWeightsContainer* prepacked_weights_container);
7092#endif // !defined(ORT_MINIMAL_BUILD)
7093};
7094
7102 // Default. Do not enable any additional compilation options.
7104
7105 // Force compilation to return an error (ORT_FAIL) if no nodes were compiled.
7106 // Otherwise, a model with basic optimizations (ORT_ENABLE_BASIC) is still generated by default.
7108
7109 // Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists.
7110 // Otherwise, compilation will automatically overwrite the output file if it exists.
7113
7140 ORT_CLASS_RELEASE(ModelCompilationOptions);
7141
7160 ORT_API2_STATUS(CreateModelCompilationOptionsFromSessionOptions, _In_ const OrtEnv* env,
7161 _In_ const OrtSessionOptions* session_options, _Outptr_ OrtModelCompilationOptions** out);
7162
7175 ORT_API2_STATUS(ModelCompilationOptions_SetInputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
7176 _In_ const ORTCHAR_T* input_model_path);
7177
7192 _In_ OrtModelCompilationOptions* model_compile_options,
7193 _In_ const void* input_model_data,
7194 size_t input_model_data_size);
7195
7213 ORT_API2_STATUS(ModelCompilationOptions_SetOutputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
7214 _In_ const ORTCHAR_T* output_model_path);
7215
7232 _In_ OrtModelCompilationOptions* model_compile_options,
7233 _In_ const ORTCHAR_T* external_initializers_file_path,
7234 size_t external_initializers_size_threshold);
7235
7258 _In_ OrtModelCompilationOptions* model_compile_options,
7259 _Inout_ OrtAllocator* allocator,
7260 _Outptr_ void** output_model_buffer_ptr,
7261 _Out_ size_t* output_model_buffer_size_ptr);
7262
7285 ORT_API2_STATUS(ModelCompilationOptions_SetEpContextEmbedMode, _In_ OrtModelCompilationOptions* model_compile_options,
7286 bool embed_ep_context_in_model);
7287
7297 ORT_API2_STATUS(CompileModel, _In_ const OrtEnv* env, _In_ const OrtModelCompilationOptions* model_options);
7298
7308 ORT_API2_STATUS(ModelCompilationOptions_SetFlags, _In_ OrtModelCompilationOptions* model_compile_options,
7309 uint32_t flags);
7310
7325 _In_ OrtModelCompilationOptions* model_compile_options,
7326 _In_ const ORTCHAR_T* output_directory,
7327 _In_ const ORTCHAR_T* model_name);
7328
7339 _In_ OrtModelCompilationOptions* model_compile_options,
7340 _In_ GraphOptimizationLevel graph_optimization_level);
7341
7360 _In_ OrtModelCompilationOptions* model_compile_options,
7361 _In_ OrtWriteBufferFunc write_func, _In_ void* state);
7362
7376 _In_ OrtModelCompilationOptions* model_compile_options,
7377 _In_ OrtGetInitializerLocationFunc get_initializer_location_func, _In_ void* state);
7378};
7379
7380/*
7381 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
7382 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
7383 *
7384 * \param device_id CUDA device id, starts from zero.
7385 */
7386ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
7387
7388/*
7389 * This is the old way to add the ROCm provider to the session, please use
7390 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
7391 * This function always exists, but will only succeed if Onnxruntime was built with
7392 * HIP support and the ROCm provider shared library exists
7393 *
7394 * \param device_id HIP device id, starts from zero.
7395 */
7396ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
7397
7398/*
7399 * This is the old way to add the MIGraphX provider to the session, please use
7400 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
7401 * This function always exists, but will only succeed if Onnxruntime was built with
7402 * HIP support and the MIGraphX provider shared library exists
7403 *
7404 * \param device_id HIP device id, starts from zero.
7405 */
7406ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
7407
7408/*
7409 * This is the old way to add the oneDNN provider to the session, please use
7410 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
7411 * This function always exists, but will only succeed if Onnxruntime was built with
7412 * oneDNN support and the oneDNN provider shared library exists
7413 *
7414 * \param use_arena zero: false. non-zero: true.
7415 */
7416ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
7417
7418/*
7419 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
7420 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
7421 *
7422 * \param device_id CUDA device id, starts from zero.
7423 */
7424ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
7425
7426#ifdef __cplusplus
7427}
7428#endif
7430
7431#include "onnxruntime_ep_c_api.h"
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:296
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:322
struct OrtHardwareDevice OrtHardwareDevice
Definition onnxruntime_c_api.h:328
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:450
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:324
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Tensorrt(OrtSessionOptions *options, int device_id)
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:246
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:485
struct OrtModelCompilationOptions OrtModelCompilationOptions
Definition onnxruntime_c_api.h:327
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:321
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:414
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:938
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:940
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:6600
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:313
struct OrtEpApi OrtEpApi
Definition onnxruntime_c_api.h:882
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:319
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:310
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:304
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:439
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:323
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:317
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:235
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:312
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:298
OrtCompiledModelCompatibility
The C API.
Definition onnxruntime_c_api.h:961
OrtStatus *(* EpSelectionDelegate)(const OrtEpDevice **ep_devices, size_t num_devices, const OrtKeyValuePairs *model_metadata, const OrtKeyValuePairs *runtime_metadata, const OrtEpDevice **selected, size_t max_selected, size_t *num_selected, void *state)
Delegate to allow providing custom OrtEpDevice selection logic.
Definition onnxruntime_c_api.h:529
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:307
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:297
struct OrtExternalInitializerInfo OrtExternalInitializerInfo
Definition onnxruntime_c_api.h:332
OrtAllocatorType
Definition onnxruntime_c_api.h:456
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:318
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:308
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:301
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:302
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:315
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:452
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:591
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:316
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:329
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:949
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:300
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:492
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:326
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:325
struct OrtSyncStream OrtSyncStream
Definition onnxruntime_c_api.h:331
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:920
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:305
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:306
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:478
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:299
OrtStatus *(* OrtWriteBufferFunc)(void *state, const void *buffer, size_t buffer_num_bytes)
Function called by ORT to write a buffer to a custom destination (e.g., file, stream,...
Definition onnxruntime_c_api.h:548
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:423
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:330
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:337
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:466
OrtSparseFormat
Definition onnxruntime_c_api.h:227
ONNXType
Definition onnxruntime_c_api.h:215
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:294
OrtErrorCode
Definition onnxruntime_c_api.h:254
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:295
OrtStatus *(* OrtGetInitializerLocationFunc)(void *state, const char *initializer_name, const OrtValue *initializer_value, const OrtExternalInitializerInfo *external_info, OrtExternalInitializerInfo **new_external_info)
Function called by ORT to allow user to specify how an initializer should be saved,...
Definition onnxruntime_c_api.h:582
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:320
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:303
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:311
ExecutionMode
Definition onnxruntime_c_api.h:431
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:272
OrtCustomThreadHandle(* OrtCustomCreateThreadFn)(void *ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void *ort_worker_fn_param)
Ort custom thread creation function.
Definition onnxruntime_c_api.h:931
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:184
OrtCompileApiFlags
Flags representing options to enable when compiling a model.
Definition onnxruntime_c_api.h:7101
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:500
const OrtApiBase * OrtGetApiBase(void)
The Onnxruntime library's entry point to access the C API.
@ ORT_LOGGING_LEVEL_VERBOSE
Verbose informational messages (least severe).
Definition onnxruntime_c_api.h:247
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition onnxruntime_c_api.h:248
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition onnxruntime_c_api.h:250
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:249
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition onnxruntime_c_api.h:251
@ OrtMemoryInfoDeviceType_GPU
Definition onnxruntime_c_api.h:487
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:488
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:486
@ OrtMemoryInfoDeviceType_NPU
Definition onnxruntime_c_api.h:489
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:6603
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:6601
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:6602
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:440
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:443
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:441
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:445
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:442
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:444
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:446
@ ORT_SPARSE_COO_INDICES
Definition onnxruntime_c_api.h:236
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition onnxruntime_c_api.h:239
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition onnxruntime_c_api.h:238
@ ORT_SPARSE_CSR_INNER_INDICES
Definition onnxruntime_c_api.h:237
@ OrtCompiledModelCompatibility_EP_SUPPORTED_PREFER_RECOMPILATION
Definition onnxruntime_c_api.h:964
@ OrtCompiledModelCompatibility_EP_NOT_APPLICABLE
Definition onnxruntime_c_api.h:962
@ OrtCompiledModelCompatibility_EP_SUPPORTED_OPTIMAL
Definition onnxruntime_c_api.h:963
@ OrtCompiledModelCompatibility_EP_UNSUPPORTED
Definition onnxruntime_c_api.h:965
@ OrtDeviceAllocator
Definition onnxruntime_c_api.h:458
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:459
@ OrtReadOnlyAllocator
Definition onnxruntime_c_api.h:460
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:457
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:594
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:592
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:593
@ OrtHardwareDeviceType_CPU
Definition onnxruntime_c_api.h:493
@ OrtHardwareDeviceType_NPU
Definition onnxruntime_c_api.h:495
@ OrtHardwareDeviceType_GPU
Definition onnxruntime_c_api.h:494
@ OrtDeviceMemoryType_HOST_ACCESSIBLE
Shared/pinned memory for transferring between CPU and the device.
Definition onnxruntime_c_api.h:480
@ OrtDeviceMemoryType_DEFAULT
Device memory.
Definition onnxruntime_c_api.h:479
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:425
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:428
@ ORT_ENABLE_LAYOUT
Definition onnxruntime_c_api.h:427
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:424
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:426
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:468
@ OrtMemTypeCPU
CPU accessible memory allocated by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:472
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:474
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:470
@ ORT_SPARSE_CSRC
Definition onnxruntime_c_api.h:230
@ ORT_SPARSE_COO
Definition onnxruntime_c_api.h:229
@ ORT_SPARSE_BLOCK_SPARSE
Definition onnxruntime_c_api.h:231
@ ORT_SPARSE_UNDEFINED
Definition onnxruntime_c_api.h:228
@ ONNX_TYPE_SEQUENCE
Definition onnxruntime_c_api.h:218
@ ONNX_TYPE_MAP
Definition onnxruntime_c_api.h:219
@ ONNX_TYPE_OPAQUE
Definition onnxruntime_c_api.h:220
@ ONNX_TYPE_UNKNOWN
Definition onnxruntime_c_api.h:216
@ ONNX_TYPE_TENSOR
Definition onnxruntime_c_api.h:217
@ ONNX_TYPE_SPARSETENSOR
Definition onnxruntime_c_api.h:221
@ ONNX_TYPE_OPTIONAL
Definition onnxruntime_c_api.h:222
@ ORT_MODEL_LOAD_CANCELED
Definition onnxruntime_c_api.h:267
@ ORT_NO_SUCHFILE
Definition onnxruntime_c_api.h:258
@ ORT_OK
Definition onnxruntime_c_api.h:255
@ ORT_INVALID_ARGUMENT
Definition onnxruntime_c_api.h:257
@ ORT_EP_FAIL
Definition onnxruntime_c_api.h:266
@ ORT_NOT_IMPLEMENTED
Definition onnxruntime_c_api.h:264
@ ORT_RUNTIME_EXCEPTION
Definition onnxruntime_c_api.h:261
@ ORT_ENGINE_ERROR
Definition onnxruntime_c_api.h:260
@ ORT_FAIL
Definition onnxruntime_c_api.h:256
@ ORT_NOT_FOUND
Definition onnxruntime_c_api.h:269
@ ORT_MODEL_REQUIRES_COMPILATION
Definition onnxruntime_c_api.h:268
@ ORT_INVALID_PROTOBUF
Definition onnxruntime_c_api.h:262
@ ORT_NO_MODEL
Definition onnxruntime_c_api.h:259
@ ORT_INVALID_GRAPH
Definition onnxruntime_c_api.h:265
@ ORT_MODEL_LOADED
Definition onnxruntime_c_api.h:263
@ ORT_PARALLEL
Definition onnxruntime_c_api.h:433
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:432
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:274
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:277
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:279
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:273
@ ORT_OP_ATTR_GRAPH
Definition onnxruntime_c_api.h:280
@ ORT_OP_ATTR_TENSOR
Definition onnxruntime_c_api.h:281
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:275
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:278
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:276
@ 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_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
@ OrtCompileApiFlags_NONE
Definition onnxruntime_c_api.h:7103
@ OrtCompileApiFlags_ERROR_IF_NO_NODES_COMPILED
Definition onnxruntime_c_api.h:7107
@ OrtCompileApiFlags_ERROR_IF_OUTPUT_FILE_EXISTS
Definition onnxruntime_c_api.h:7111
@ OrtExecutionProviderDevicePolicy_DEFAULT
Definition onnxruntime_c_api.h:501
@ OrtExecutionProviderDevicePolicy_PREFER_CPU
Definition onnxruntime_c_api.h:502
@ OrtExecutionProviderDevicePolicy_MAX_PERFORMANCE
Definition onnxruntime_c_api.h:505
@ OrtExecutionProviderDevicePolicy_PREFER_NPU
Definition onnxruntime_c_api.h:503
@ OrtExecutionProviderDevicePolicy_MAX_EFFICIENCY
Definition onnxruntime_c_api.h:506
@ OrtExecutionProviderDevicePolicy_PREFER_GPU
Definition onnxruntime_c_api.h:504
@ OrtExecutionProviderDevicePolicy_MIN_OVERALL_POWER
Definition onnxruntime_c_api.h:507
Memory allocation interface.
Definition onnxruntime_c_api.h:346
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:353
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:356
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:347
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition onnxruntime_c_api.h:350
void *(* AllocOnStream)(struct OrtAllocator *this_, size_t size, OrtSyncStream *stream)
Allocate using a stream.
Definition onnxruntime_c_api.h:411
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:367
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:888
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:904
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:898
Definition onnxruntime_c_api.h:968
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:5348
void(* ReleaseDnnlProviderOptions)(OrtDnnlProviderOptions *input)
Release an OrtDnnlProviderOptions.
Definition onnxruntime_c_api.h:4416
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:4606
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.
const OrtCompileApi *(* GetCompileApi)()
Get the Compile API instance.
Definition onnxruntime_c_api.h:5169
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.
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:5366
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:4014
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:2663
const char *(* GetRunConfigEntry)(const OrtRunOptions *options, const char *config_key)
Get a run configuration entry.
Definition onnxruntime_c_api.h:6293
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:5220
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:5431
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.
uint32_t(* MemoryInfoGetVendorId)(const OrtMemoryInfo *ptr)
Get the vendor id from OrtMemoryInfo.
Definition onnxruntime_c_api.h:5511
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:4086
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 * 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:6307
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...
const OrtModelEditorApi *(* GetModelEditorApi)()
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:5111
OrtStatus * KernelContext_GetOutputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the output count of a kernel.
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 * 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:6262
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.
void(* ReleaseROCMProviderOptions)(OrtROCMProviderOptions *input)
Release an OrtROCMProviderOptions.
Definition onnxruntime_c_api.h:4665
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 * 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)
void(* ReleaseCANNProviderOptions)(OrtCANNProviderOptions *input)
Release an OrtCANNProviderOptions.
Definition onnxruntime_c_api.h:4080
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 * 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.
const OrtEpApi *(* GetEpApi)()
Get the OrtEpApi instance for implementing an execution provider.
Definition onnxruntime_c_api.h:5437
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 * 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 * 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:5357
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 * 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 * 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:5198
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:6271
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:993
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:5209
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:5395
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:5376
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:5413
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:5502
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2667
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:5183
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:979
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 * 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.
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.
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 * 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:5422
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 * 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 * 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:3224
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:6253
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:5404
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:5386
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 * ModelMetadataGetProducerName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get producer name from an OrtModelMetadata.
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:5231
void *(* SyncStream_GetHandle)(OrtSyncStream *stream)
Get the native handle of the sync stream.
Definition onnxruntime_c_api.h:6501
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:3727
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:986
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:601
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:680
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:654
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:649
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:659
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:669
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:632
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:640
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:603
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:663
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:675
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:626
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:620
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:7137
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_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:922
char __place_holder
Definition onnxruntime_c_api.h:923
Definition onnxruntime_c_api.h:6610
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6656
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6640
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6628
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6660
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:6693
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6678
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:6690
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6621
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6630
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:6636
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6665
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6647
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:6617
uint32_t version
Definition onnxruntime_c_api.h:6611
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6627
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:6694
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6639
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6624
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:6629
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6651
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:6675
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6679
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:6668
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:6686
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:6673
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:6635
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:805
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:816
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:812
int migraphx_fp8_enable
Definition onnxruntime_c_api.h:808
int migraphx_int8_enable
Definition onnxruntime_c_api.h:809
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:814
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:807
int device_id
Definition onnxruntime_c_api.h:806
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:810
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:822
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:815
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:813
int migraphx_arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:830
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:811
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:6708
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:844
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:865
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:862
void * context
Definition onnxruntime_c_api.h:864
const char * cache_dir
Definition onnxruntime_c_api.h:863
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:859
const char * device_id
Definition onnxruntime_c_api.h:861
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:860
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:846
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:866
ROCM Provider Options.
Definition onnxruntime_c_api.h:688
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:708
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:769
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:736
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:750
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:719
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:690
int enable_hip_graph
Definition onnxruntime_c_api.h:752
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:758
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:746
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:727
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:764
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:741
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exhaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:713
TensorRT Provider Options.
Definition onnxruntime_c_api.h:777
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:791
void * user_compute_stream
Definition onnxruntime_c_api.h:780
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:778
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:792
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:793
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:781
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:783
int trt_dla_enable
Definition onnxruntime_c_api.h:788
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:786
int has_user_compute_stream
Definition onnxruntime_c_api.h:779
int trt_dla_core
Definition onnxruntime_c_api.h:789
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:787
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:782
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:795
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:790
int trt_fp16_enable
Definition onnxruntime_c_api.h:784
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:794
int trt_int8_enable
Definition onnxruntime_c_api.h:785
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122