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 _Outptr_
56#define _Out_opt_
57#define _Inout_
58#define _Inout_opt_
59#define _Frees_ptr_opt_
60#define _Ret_maybenull_
61#define _Ret_notnull_
62#define _Check_return_
63#define _Outptr_result_maybenull_
64#define _In_reads_(X)
65#define _Inout_updates_(X)
66#define _Out_writes_(X)
67#define _Inout_updates_all_(X)
68#define _Out_writes_bytes_all_(X)
69#define _Out_writes_all_(X)
70#define _Success_(X)
71#define _Outptr_result_buffer_maybenull_(X)
72#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
73#else
74#include <specstrings.h>
75#define ORT_ALL_ARGS_NONNULL
76#endif
77
78#ifdef _WIN32
79// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
80// dllexport is not used, we use a .def file.
81#ifdef ORT_DLL_IMPORT
82#define ORT_EXPORT __declspec(dllimport)
83#else
84#define ORT_EXPORT
85#endif
86#define ORT_API_CALL _stdcall
87#define ORT_MUST_USE_RESULT
88#define ORTCHAR_T wchar_t
89#else
90// To make symbols visible on macOS/iOS
91#ifdef __APPLE__
92#define ORT_EXPORT __attribute__((visibility("default")))
93#else
94#define ORT_EXPORT
95#endif
96#define ORT_API_CALL
97#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
98#define ORTCHAR_T char
99#endif
100
103#ifndef ORT_TSTR
104#ifdef _WIN32
105#define ORT_TSTR(X) L##X
106// When X is a macro, L##X is not defined. In this case, we need to use ORT_TSTR_ON_MACRO.
107#define ORT_TSTR_ON_MACRO(X) L"" X
108#else
109#define ORT_TSTR(X) X
110#define ORT_TSTR_ON_MACRO(X) X
111#endif
112#endif
113
114// On Windows, ORT_FILE is a wchar_t version of the __FILE__ macro.
115// Otherwise, ORT_FILE is equivalent to __FILE__.
116#ifndef ORT_FILE
117#define ORT_FILE_INTERNAL(x) ORT_TSTR(x)
118#define ORT_FILE ORT_FILE_INTERNAL(__FILE__)
119#endif
120
121// Any pointer marked with _In_ or _Out_, cannot be NULL.
122
123// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
124// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
125// for ReleaseXXX(...) functions, they can accept NULL pointer.
126
127#ifdef __cplusplus
128// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
129// Such complex condition is needed because compilers set __cplusplus value differently.
130#ifndef __has_feature
131#define __has_feature(x) 0
132#endif
133#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
134#define NO_EXCEPTION noexcept
135#else
136#define NO_EXCEPTION throw()
137#endif
138#else
139#define NO_EXCEPTION
140#endif
141
142// __VA_ARGS__ on Windows and Linux are different
143#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
144
145#define ORT_API_T(RETURN_TYPE, NAME, ...) \
146 RETURN_TYPE(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION
147
148#define ORT_API_STATUS(NAME, ...) \
149 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
150 NO_EXCEPTION ORT_MUST_USE_RESULT
151
152// XXX: Unfortunately, SAL annotations are known to not work with function pointers
153#define ORT_API2_STATUS(NAME, ...) \
154 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
155
156// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
157#define ORT_API_STATUS_IMPL(NAME, ...) \
158 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
159
160#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
161
162#ifdef __DOXYGEN__
163#undef ORT_API_STATUS
164#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
165#undef ORT_API2_STATUS
166#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
167#undef ORT_CLASS_RELEASE
168#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
169#undef NO_EXCEPTION
170#define NO_EXCEPTION
171#endif
182 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
183 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
184 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
185 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
186 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
187 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
188 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
189 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
192 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
193 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
194 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
195 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
196 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
197 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16, // Non-IEEE floating-point format based on IEEE754 single-precision
198 // float 8 types were introduced in onnx 1.14, see https://onnx.ai/onnx/technical/float8.html
199 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN, // Non-IEEE floating-point format based on IEEE754 single-precision
200 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
201 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2, // Non-IEEE floating-point format based on IEEE754 single-precision
202 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
203 // Int4 types were introduced in ONNX 1.16. See https://onnx.ai/onnx/technical/int4.html
204 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4, // maps to a pair of packed uint4 values (size == 1 byte)
205 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4 // maps to a pair of packed int4 values (size == 1 byte)
207
208// Synced with onnx TypeProto oneof
218
219// These types are synced with internal
220// SparseFormatFlags
227
228// Enum allows to query sparse tensor indices
235
247
264
274
276#define ORT_RUNTIME_CLASS(X) \
277 struct Ort##X; \
278 typedef struct Ort##X Ort##X
279
284// The actual types defined have an Ort prefix
285ORT_RUNTIME_CLASS(Env);
286ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
287ORT_RUNTIME_CLASS(MemoryInfo);
288ORT_RUNTIME_CLASS(IoBinding);
289ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
290ORT_RUNTIME_CLASS(Value);
291ORT_RUNTIME_CLASS(RunOptions);
292ORT_RUNTIME_CLASS(TypeInfo);
293ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
294ORT_RUNTIME_CLASS(MapTypeInfo);
295ORT_RUNTIME_CLASS(SequenceTypeInfo);
296ORT_RUNTIME_CLASS(OptionalTypeInfo);
297ORT_RUNTIME_CLASS(SessionOptions);
298ORT_RUNTIME_CLASS(CustomOpDomain);
299ORT_RUNTIME_CLASS(ModelMetadata);
300ORT_RUNTIME_CLASS(ThreadPoolParams);
301ORT_RUNTIME_CLASS(ThreadingOptions);
302ORT_RUNTIME_CLASS(ArenaCfg);
303ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
304ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
305ORT_RUNTIME_CLASS(NvTensorRtRtxProviderOptions);
306ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
307ORT_RUNTIME_CLASS(CANNProviderOptions);
308ORT_RUNTIME_CLASS(DnnlProviderOptions);
309ORT_RUNTIME_CLASS(Op);
310ORT_RUNTIME_CLASS(OpAttr);
311ORT_RUNTIME_CLASS(Logger);
312ORT_RUNTIME_CLASS(ShapeInferContext);
313ORT_RUNTIME_CLASS(LoraAdapter);
314ORT_RUNTIME_CLASS(ValueInfo);
315ORT_RUNTIME_CLASS(Node);
316ORT_RUNTIME_CLASS(Graph);
317ORT_RUNTIME_CLASS(Model);
318ORT_RUNTIME_CLASS(ModelCompilationOptions);
319ORT_RUNTIME_CLASS(HardwareDevice);
320ORT_RUNTIME_CLASS(EpDevice);
321ORT_RUNTIME_CLASS(KeyValuePairs);
322ORT_RUNTIME_CLASS(ArrayOfConstObjects);
323
324#ifdef _MSC_VER
325typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
326#else
328#endif
329
336typedef struct OrtAllocator {
337 uint32_t version;
338
340 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
341
343 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
344
346 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
352 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
353
372 ORT_API2_STATUS(GetStats, _In_ const struct OrtAllocator* this_, _Outptr_ OrtKeyValuePairs** out);
374
375typedef void(ORT_API_CALL* OrtLoggingFunction)(
376 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
377 const char* message);
378
391
396
409
410struct OrtKernelInfo;
412struct OrtKernelContext;
414struct OrtCustomOp;
416
422
425// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
432
438
447
453
465
485typedef OrtStatus*(ORT_API_CALL* EpSelectionDelegate)(_In_ const OrtEpDevice** ep_devices,
486 _In_ size_t num_devices,
487 _In_ const OrtKeyValuePairs* model_metadata,
488 _In_opt_ const OrtKeyValuePairs* runtime_metadata,
489 _Inout_ const OrtEpDevice** selected,
490 _In_ size_t max_selected,
491 _Out_ size_t* num_selected,
492 _In_ void* state);
493
503
507 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
508 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
509 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
511
598
687
694 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
695 void* user_compute_stream; // user specified CUDA compute stream.
696 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
697 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
698 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
699 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
700 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
701 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
702 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
703 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
704 int trt_dla_core; // DLA core number. Default 0
705 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
706 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
707 const char* trt_engine_cache_path; // specify engine cache path
708 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
709 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
710 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
711 // This is the legacy struct and don't add new fields here.
712 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
713 // For non-string field, need to create a new separate api to handle it.
715
721 int device_id; // hip device id.
722 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
723 int migraphx_fp8_enable; // MIGraphX FP8 precision. Default 0 = false, nonzero = true
724 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
725 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, noznero = true
726 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
727 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, noznero = true
728 const char* migraphx_save_model_path; // migraphx model path name
729 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, noznero = true
730 const char* migraphx_load_model_path; // migraphx model path name
731 bool migraphx_exhaustive_tune; // migraphx tuned compile Default = false
732
738
746
748
759#ifdef __cplusplus
768#endif
773 const char* device_type;
775 const char* device_id;
777 const char* cache_dir; // path is set to empty by default
778 void* context;
780 unsigned char enable_dynamic_shapes;
782
783struct OrtApi;
784typedef struct OrtApi OrtApi;
785
786struct OrtTrainingApi;
788
789struct OrtModelEditorApi;
791
792struct OrtCompileApi;
794
795struct OrtEpApi;
796typedef struct OrtEpApi OrtEpApi;
797
798struct OrtNodeComputeInfo;
800
815 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
816
821 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
822};
823
824typedef struct OrtApiBase OrtApiBase;
825
830ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
831
837typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
838
842
848typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
849
855typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
856
857typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
858
866typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
867
875struct OrtApi {
878
886 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
887
893 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
894
900 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
901
905
916 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
917
932 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
933 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
934
942 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
950 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
951
955
965 // TODO: document the path separator convention? '/' vs '\'
966 // TODO: should specify the access characteristics of model_path. Is this read only during the
967 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
968 // and continue to access throughout the OrtSession lifetime?
969 // What sort of access is needed to model_path : read or read/write?
970 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
971 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
972
983 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env,
984 _In_ const void* model_data, size_t model_data_length,
985 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
986
1005 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
1006 _In_reads_(input_len) const char* const* input_names,
1007 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
1008 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
1009 _Inout_updates_all_(output_names_len) OrtValue** outputs);
1010
1014
1030 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
1031
1039 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
1040 _In_ const ORTCHAR_T* optimized_model_filepath);
1041
1049 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
1050 _Outptr_ OrtSessionOptions** out_options);
1051
1063 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
1064
1072 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
1073
1080 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
1081
1095 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
1096
1105 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
1106
1115 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
1116
1123 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
1124
1132 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
1133
1143 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1144
1152 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1153
1162 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1163 GraphOptimizationLevel graph_optimization_level);
1164
1178 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1179
1192 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1193
1197
1205 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1206
1216 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1217
1221
1231 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1232
1249 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1250
1254
1266 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1267
1279 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1280
1290 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1291
1300 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1301
1310 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1311
1320 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1321
1331 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1332
1342 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1343
1353 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1354 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1355
1359
1366 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1367
1377 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1378
1386 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1387
1397 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1398
1408 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1409 _Out_ int* log_verbosity_level);
1410
1418 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1419
1431 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1432
1441 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1442
1451 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1452
1456
1469 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1471
1489 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1490 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1491 _Outptr_ OrtValue** out);
1492
1500 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1501
1512 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1513
1522 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1523
1533 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1534
1554 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1555 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1556
1560
1569 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1570 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1571
1579 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1580
1584
1592
1601
1610 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1611
1621 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1623
1633 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1634
1643 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1644 size_t dim_values_length);
1645
1654 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1655 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1656
1673 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1674
1678
1686 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
1687
1695 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
1696
1704 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
1705
1709
1720 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
1721 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
1722
1733 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
1734 _Outptr_ OrtMemoryInfo** out);
1735
1746 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
1747
1755 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
1756
1759 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
1760
1763 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
1764
1767 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
1768
1772
1774 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
1776 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
1778 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
1779
1788 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
1789
1793
1805 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
1806 _In_ int64_t dim_value);
1807
1811
1812 /* Internal information (not seen in Doxygen)
1813 *
1814 * APIs to support non-tensor types - map and sequence.
1815 * Currently only the following types are supported
1816 * Note: the following types should be kept in sync with data_types.h
1817 * Map types
1818 * =========
1819 * std::map<std::string, std::string>
1820 * std::map<std::string, int64_t>
1821 * std::map<std::string, float>
1822 * std::map<std::string, double>
1823 * std::map<int64_t, std::string>
1824 * std::map<int64_t, int64_t>
1825 * std::map<int64_t, float>
1826 * std::map<int64_t, double>
1827 *
1828 * Sequence types
1829 * ==============
1830 * std::vector<std::string>
1831 * std::vector<int64_t>
1832 * std::vector<float>
1833 * std::vector<double>
1834 * std::vector<std::map<std::string, float>>
1835 * std::vector<std::map<int64_t, float>
1836 */
1837
1852 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
1853 _Outptr_ OrtValue** out);
1854
1865 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
1866
1882 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
1883 enum ONNXType value_type, _Outptr_ OrtValue** out);
1884
1907 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
1908 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
1909
1924 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
1925 _Out_ void* data_container, size_t data_container_size);
1926
1931
1940 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
1941 _Out_ float* out);
1942
1951 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
1952 _Out_ int64_t* out);
1953
1974 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
1975 _Inout_ size_t* size);
1976
1981
1986 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1987
1992 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1993
2005 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
2006 _Out_ const OrtValue** out);
2007
2021 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
2022 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
2023
2027 ORT_CLASS_RELEASE(Env);
2031 ORT_CLASS_RELEASE(Status);
2035 ORT_CLASS_RELEASE(MemoryInfo);
2039 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
2043 ORT_CLASS_RELEASE(Value);
2047 ORT_CLASS_RELEASE(RunOptions);
2051 ORT_CLASS_RELEASE(TypeInfo);
2055 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
2059 ORT_CLASS_RELEASE(SessionOptions);
2063 ORT_CLASS_RELEASE(CustomOpDomain);
2064
2068
2081 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
2082 _Out_ size_t* len);
2083
2097 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
2098 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
2099
2113 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
2114 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
2115
2119
2131 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
2132
2141 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2142
2146
2157 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2158 _Outptr_ OrtTypeInfo** type_info);
2159
2163 ORT_CLASS_RELEASE(MapTypeInfo);
2167 ORT_CLASS_RELEASE(SequenceTypeInfo);
2168
2172
2183 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2184
2192 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2193
2197
2206 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2207 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2208
2217 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2218 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2219
2228 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2229 _Outptr_ char** value);
2230
2239 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2240 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2241
2252 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2253 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2254
2262 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2263
2264 ORT_CLASS_RELEASE(ModelMetadata);
2265
2269
2283 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2284 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2285
2289
2299 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2300
2304
2310 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2311
2312 ORT_CLASS_RELEASE(ThreadingOptions);
2313
2317
2329 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2330 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2331
2335
2343 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2344 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2345 _In_ int64_t dim_value);
2346
2350
2362 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2363
2372 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2373 _In_ int providers_length);
2374
2378
2387 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2388
2398 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2399
2408 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2409
2413
2426 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2427 _In_z_ const char* config_key, _In_z_ const char* config_value);
2428
2432
2443 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2444 _Outptr_ OrtAllocator** out);
2445
2448 ORT_CLASS_RELEASE(Allocator);
2449
2453
2464 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2465
2477 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2478
2482
2485 ORT_CLASS_RELEASE(IoBinding);
2486
2497 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2498
2509 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2510
2526 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2527
2545 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2546 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2547
2565 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2566 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2567
2570 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2571
2574 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2575
2579
2594 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2595
2599
2614 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2615 _In_ const OrtArenaCfg* arena_cfg);
2616
2628 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2629
2633
2643 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2644
2648
2660 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2661
2673 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
2674
2688 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
2689
2693
2708 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
2709 _In_ const OrtValue* val);
2710
2714
2730 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
2731 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2732
2736
2747 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
2748
2759 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
2760
2771 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
2772
2776
2787 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
2788
2792
2805 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
2806 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
2807
2808 ORT_CLASS_RELEASE(ArenaCfg);
2809
2813
2825 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
2826 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2827
2831
2842 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
2843
2847
2858 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
2859
2870 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
2871
2876
2899 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2900 _Out_ float* out, _Inout_ size_t* size);
2901
2923 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2924 _Out_ int64_t* out, _Inout_ size_t* size);
2925
2929
2961 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
2962 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
2963 _Outptr_ OrtArenaCfg** out);
2964
2968
2981 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
2982 _In_z_ const char* config_key, _In_z_ const char* config_value);
2983
2987
3001
3006 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
3007
3011
3029 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
3030 _In_ const OrtSessionOptions* options,
3031 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3032 _Outptr_ OrtSession** out);
3033
3052 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
3053 _In_ const void* model_data, size_t model_data_length,
3054 _In_ const OrtSessionOptions* options,
3055 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3056 _Outptr_ OrtSession** out);
3057
3061
3080 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
3081
3085
3093
3109 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
3110 _In_reads_(num_keys) const char* const* provider_options_keys,
3111 _In_reads_(num_keys) const char* const* provider_options_values,
3112 _In_ size_t num_keys);
3113
3125 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3126
3131 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
3132
3136
3143 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
3144
3148
3164 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3165
3176 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3177 _In_ const OrtMemoryInfo* mem_info);
3178
3182
3191 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3192
3209 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3210 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3211
3229 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3230 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3231 _In_ const int64_t* indices_data, size_t indices_num);
3232
3252 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3253 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3254 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3255 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3256
3275 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3276 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3277 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3278 _In_ const int32_t* indices_data);
3279
3304 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3305 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3306 _In_ const int64_t* values_shape, size_t values_shape_len,
3308
3323 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3324
3341 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3342 _Inout_ int64_t* outer_data, size_t outer_num);
3343
3357 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3358
3366 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3367
3375 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3376
3384 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3385
3395 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3396
3406 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3410
3423 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3424
3429
3441 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3442
3446
3452 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3453
3457
3467 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3468
3470
3473
3480 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3481
3489 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3490
3498 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3500
3503
3510 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3511
3519 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3520
3528 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3530
3539 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3540
3549 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3550
3553
3574 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3575
3579
3588 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3589
3607 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3608 _In_reads_(num_keys) const char* const* provider_options_keys,
3609 _In_reads_(num_keys) const char* const* provider_options_values,
3610 _In_ size_t num_keys);
3611
3626 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3627
3634 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3635
3637
3650 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3651
3673 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
3674 _In_reads_(num_initializers) const char* const* initializer_names,
3675 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
3676
3687 ORT_API2_STATUS(CreateOpAttr,
3688 _In_ const char* name,
3689 _In_ const void* data,
3690 _In_ int len,
3691 _In_ OrtOpAttrType type,
3692 _Outptr_ OrtOpAttr** op_attr);
3693
3694 /* \brief: Release op attribute
3695 *
3696 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
3697 *
3698 * \since Version 1.12.
3699 */
3700 ORT_CLASS_RELEASE(OpAttr);
3701
3719 ORT_API2_STATUS(CreateOp,
3720 _In_ const OrtKernelInfo* info,
3721 _In_z_ const char* op_name,
3722 _In_z_ const char* domain,
3723 int version,
3724 _In_reads_(type_constraint_count) const char** type_constraint_names,
3725 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
3726 int type_constraint_count,
3727 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
3728 int attr_count,
3729 int input_count,
3730 int output_count,
3731 _Outptr_ OrtOp** ort_op);
3732
3745 ORT_API2_STATUS(InvokeOp,
3746 _In_ const OrtKernelContext* context,
3747 _In_ const OrtOp* ort_op,
3748 _In_ const OrtValue* const* input_values,
3749 _In_ int input_count,
3750 _Inout_ OrtValue* const* output_values,
3751 _In_ int output_count);
3752
3753 /* \brief: Release an onnxruntime operator
3754 *
3755 * \param[in] Op Operator created by OrtApi::CreateOp
3756 *
3757 * \since Version 1.12.
3758 */
3759 ORT_CLASS_RELEASE(Op);
3760
3874 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
3875 _In_ const char* provider_name,
3876 _In_reads_(num_keys) const char* const* provider_options_keys,
3877 _In_reads_(num_keys) const char* const* provider_options_values,
3878 _In_ size_t num_keys);
3879
3880 /* \brief: Get a copy of kernel info
3881 *
3882 * \param[in] info Kernel info
3883 * \param[out] info_copy Copy of kernel info
3884 *
3885 * \since Version 1.12.
3886 */
3887 ORT_API2_STATUS(CopyKernelInfo,
3888 _In_ const OrtKernelInfo* info,
3889 _Outptr_ OrtKernelInfo** info_copy);
3890
3891 /* \brief: Release kernel info
3892 *
3893 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
3894 *
3895 * \since Version 1.12.
3896 */
3897 ORT_CLASS_RELEASE(KernelInfo);
3898
3901
3915 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
3916
3918
3931 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
3932
3941 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
3942
3954 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
3955 _In_reads_(num_keys) const char* const* provider_options_keys,
3956 _In_reads_(num_keys) const char* const* provider_options_values,
3957 _In_ size_t num_keys);
3958
3972 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
3973 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3974
3981 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
3982
3983 /* \brief Get OrtDevice type from MemoryInfo
3984 *
3985 * \since Version 1.14
3986 */
3987 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
3988
3989 /* \brief Update the OrtEnv instance with custom log severity level
3990 *
3991 * \param[in] ort_env The OrtEnv instance being used
3992 * \param[in] log_severity_level The log severity level.
3993 *
3994 * \since Version 1.14.
3995 */
3996 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
3997
3998 /* \brief Set affinities for intra op threads
3999 *
4000 * Affinity string follows format:
4001 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
4002 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
4003 * e.g. 1,2,3;4,5
4004 * 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.
4005 * To ease the configuration, an "interval" is also allowed:
4006 * e.g. 1-8;8-16;17-24
4007 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
4008 * Note:
4009 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
4010 * ort does not set affinity on the main thread which is started and managed by the calling app;
4011 * 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,
4012 * 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.
4013 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
4014 *
4015 * \since Version 1.14
4016 */
4017 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
4018
4037 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
4038
4063 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
4064 _In_ const char* registration_func_name);
4065
4069
4081 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4082
4094 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4095
4120 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
4121 _Inout_ size_t* size);
4122
4148 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
4149 _Inout_ size_t* size);
4150
4163 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4164 _Outptr_ OrtTypeInfo** type_info);
4165
4178 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4179 _Outptr_ OrtTypeInfo** type_info);
4180
4193 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4194 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4195
4200
4216 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4217 _In_z_ const char* config_key, _Out_ int* out);
4218
4247 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4248 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4249
4251
4264 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4265
4274 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4275
4292 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4293 _In_reads_(num_keys) const char* const* provider_options_keys,
4294 _In_reads_(num_keys) const char* const* provider_options_values,
4295 _In_ size_t num_keys);
4296
4311 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4312
4317 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4318
4322
4345 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_ char* out, _Inout_ size_t* size);
4346
4358 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4359
4364
4376 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4377
4382
4401 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4402 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4403 _In_z_ const char* func_name);
4404
4416 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4417
4419
4433 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4434
4455 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4456 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4457
4474 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4475 _Outptr_ OrtTypeInfo** out);
4476
4487 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4488
4499 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4500
4507 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4508
4511
4520 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4521
4539 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4540 _In_reads_(num_keys) const char* const* provider_options_keys,
4541 _In_reads_(num_keys) const char* const* provider_options_values,
4542 _In_ size_t num_keys);
4543
4558 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4559
4566 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
4567
4581 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type, _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
4582 _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);
4583
4602 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
4603 _In_reads_(input_len) const char* const* input_names,
4604 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
4605 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
4606 _Inout_updates_all_(output_names_len) OrtValue** output,
4607 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
4608
4621 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
4622
4633 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
4634
4647 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
4648
4659 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
4660
4672 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
4673 _In_ int resource_id, _Outptr_ void** resource);
4674
4692 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
4693 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
4694
4703 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
4704
4714 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
4715
4725 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
4726
4736 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
4737
4747 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
4748
4760 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
4761
4772 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
4773
4785 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);
4786
4801 _In_ OrtSessionOptions* options,
4802 _In_reads_(num_keys) const char* const* provider_options_keys,
4803 _In_reads_(num_keys) const char* const* provider_options_values,
4804 _In_ size_t num_keys);
4805
4820 _In_ OrtSessionOptions* options,
4821 _In_reads_(num_keys) const char* const* provider_options_keys,
4822 _In_reads_(num_keys) const char* const* provider_options_values,
4823 _In_ size_t num_keys);
4824
4836 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
4837
4848 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
4849
4871 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
4872 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
4873 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
4874 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
4875 size_t num_external_initializer_files);
4876
4895 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
4896 _Outptr_ OrtLoraAdapter** out);
4897
4915 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
4916 _Outptr_ OrtLoraAdapter** out);
4917
4920 ORT_CLASS_RELEASE(LoraAdapter);
4921
4938 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
4939
4943
4958 ORT_API2_STATUS(SetEpDynamicOptions, _Inout_ OrtSession* sess, _In_reads_(kv_len) const char* const* keys,
4959 _In_reads_(kv_len) const char* const* values, _In_ size_t kv_len);
4960
4964 ORT_CLASS_RELEASE(ValueInfo);
4965
4969 ORT_CLASS_RELEASE(Node);
4970
4975 ORT_CLASS_RELEASE(Graph);
4976
4981 ORT_CLASS_RELEASE(Model);
4982
4989 ORT_API2_STATUS(GetValueInfoName, _In_ const OrtValueInfo* value_info, _Out_ const char** name);
4990
4997 ORT_API2_STATUS(GetValueInfoTypeInfo, _In_ const OrtValueInfo* value_info, _Outptr_ const OrtTypeInfo** type_info);
4998
5007 const OrtModelEditorApi*(ORT_API_CALL* GetModelEditorApi)();
5008
5027 ORT_API2_STATUS(CreateTensorWithDataAndDeleterAsOrtValue, _In_ OrtAllocator* deleter,
5028 _In_ void* p_data, size_t p_data_len,
5029 _In_ const int64_t* shape, size_t shape_len,
5031 _Outptr_ OrtValue** out);
5032
5049 ORT_API2_STATUS(SessionOptionsSetLoadCancellationFlag, _Inout_ OrtSessionOptions* options,
5050 _In_ bool cancel);
5051
5065 const OrtCompileApi*(ORT_API_CALL* GetCompileApi)();
5066
5067 //
5068 // OrtKeyValuePairs
5069 //
5070
5079 void(ORT_API_CALL* CreateKeyValuePairs)(_Outptr_ OrtKeyValuePairs** out);
5080
5092 void(ORT_API_CALL* AddKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key, _In_ const char* value);
5093
5103 const char*(ORT_API_CALL* GetKeyValue)(_In_ const OrtKeyValuePairs* kvps, _In_ const char* key);
5104
5114 void(ORT_API_CALL* GetKeyValuePairs)(_In_ const OrtKeyValuePairs* kvps,
5115 _Outptr_ const char* const** keys, _Outptr_ const char* const** values,
5116 _Out_ size_t* num_entries);
5117
5125 void(ORT_API_CALL* RemoveKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key);
5126
5133 ORT_CLASS_RELEASE(KeyValuePairs);
5134
5148 ORT_API2_STATUS(RegisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name,
5149 _In_ const ORTCHAR_T* path);
5150
5165 ORT_API2_STATUS(UnregisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name);
5166
5179 ORT_API2_STATUS(GetEpDevices, _In_ const OrtEnv* env,
5180 _Outptr_ const OrtEpDevice* const** ep_devices, _Out_ size_t* num_ep_devices);
5181
5201 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_V2, _In_ OrtSessionOptions* session_options,
5202 _In_ OrtEnv* env,
5203 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices, _In_ size_t num_ep_devices,
5204 _In_reads_(num_op_options) const char* const* ep_option_keys,
5205 _In_reads_(num_op_options) const char* const* ep_option_vals,
5206 size_t num_ep_options);
5207
5218 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicy, _In_ OrtSessionOptions* session_options,
5220
5231 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicyDelegate, _In_ OrtSessionOptions* session_options,
5232 _In_ EpSelectionDelegate delegate,
5233 _In_opt_ void* delegate_state);
5234
5243
5251 uint32_t(ORT_API_CALL* HardwareDevice_VendorId)(_In_ const OrtHardwareDevice* device);
5252
5260 const char*(ORT_API_CALL* HardwareDevice_Vendor)(_In_ const OrtHardwareDevice* device);
5261
5270 uint32_t(ORT_API_CALL* HardwareDevice_DeviceId)(_In_ const OrtHardwareDevice* device);
5271
5280 const OrtKeyValuePairs*(ORT_API_CALL* HardwareDevice_Metadata)(_In_ const OrtHardwareDevice* device);
5281
5289 const char*(ORT_API_CALL* EpDevice_EpName)(_In_ const OrtEpDevice* ep_device);
5290
5298 const char*(ORT_API_CALL* EpDevice_EpVendor)(_In_ const OrtEpDevice* ep_device);
5299
5307 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpMetadata)(_In_ const OrtEpDevice* ep_device);
5308
5316 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpOptions)(_In_ const OrtEpDevice* ep_device);
5317
5325 const OrtHardwareDevice*(ORT_API_CALL* EpDevice_Device)(_In_ const OrtEpDevice* ep_device);
5326
5331 const OrtEpApi*(ORT_API_CALL* GetEpApi)();
5332
5346 ORT_API2_STATUS(GetTensorSizeInBytes, _In_ const OrtValue* ort_value, _Out_ size_t* size);
5347
5362 ORT_API2_STATUS(AllocatorGetStats, _In_ const OrtAllocator* ort_allocator, _Outptr_ OrtKeyValuePairs** out);
5363
5383 ORT_API2_STATUS(CreateMemoryInfo_V2, _In_ const char* name, _In_ enum OrtMemoryInfoDeviceType device_type,
5384 _In_ uint32_t vendor_id, _In_ int16_t device_id, _In_ enum OrtDeviceMemoryType mem_type,
5385 _In_ size_t alignment, enum OrtAllocatorType allocator_type,
5386 _Outptr_ OrtMemoryInfo** out);
5387
5388 //
5389 // OrtArrayOfConstObjects
5390 //
5391
5413 ORT_API2_STATUS(CreateArrayOfConstObjects, _In_ OrtTypeTag object_type, _In_ size_t initial_size,
5414 _In_ const void* initial_value, _Outptr_ OrtArrayOfConstObjects** out);
5415
5416 ORT_CLASS_RELEASE(ArrayOfConstObjects);
5417
5429 ORT_API2_STATUS(ArrayOfConstObjects_GetObjectType, _In_ const OrtArrayOfConstObjects* array,
5430 _Out_ OrtTypeTag* type_tag);
5431
5444 ORT_API2_STATUS(ArrayOfConstObjects_GetData, _In_ const OrtArrayOfConstObjects* array,
5445 _Outptr_ const void* const** data);
5446
5459 ORT_API2_STATUS(ArrayOfConstObjects_GetMutableData, _In_ OrtArrayOfConstObjects* array, _Outptr_ const void*** data);
5460
5470 ORT_API2_STATUS(ArrayOfConstObjects_GetSize, _In_ const OrtArrayOfConstObjects* array, _Out_ size_t* size);
5471
5488 ORT_API2_STATUS(ArrayOfConstObjects_GetElementAt, _In_ const OrtArrayOfConstObjects* array, _In_ size_t index,
5489 _Outptr_ const void** out);
5490
5501 ORT_API2_STATUS(ArrayOfConstObjects_SetElementAt, _In_ OrtArrayOfConstObjects* array, _In_ size_t index,
5502 _In_ const void* element);
5503
5513 ORT_API2_STATUS(ArrayOfConstObjects_AppendElement, _In_ OrtArrayOfConstObjects* array, _In_ const void* element);
5514
5515 //
5516 // OrtValueInfo
5517 //
5518
5529 ORT_API2_STATUS(ValueInfo_GetValueProducer, _In_ const OrtValueInfo* value_info,
5530 _Outptr_ const OrtNode** producer_node, _Out_opt_ size_t* producer_output_index);
5531
5547 ORT_API2_STATUS(ValueInfo_GetValueNumConsumers, _In_ const OrtValueInfo* value_info, _Out_ size_t* num_consumers);
5548
5573 ORT_API2_STATUS(ValueInfo_GetValueConsumers, _In_ const OrtValueInfo* value_info,
5574 _Out_writes_all_(max_num_consumers) const OrtNode** nodes,
5575 _Out_writes_all_(max_num_consumers) int64_t* input_indices,
5576 _In_ size_t max_num_consumers);
5577
5591 ORT_API2_STATUS(ValueInfo_GetInitializerValue, _In_ const OrtValueInfo* value_info,
5592 _Outptr_ const OrtValue** initializer_value);
5593
5608 ORT_API2_STATUS(ValueInfo_IsRequiredGraphInput, _In_ const OrtValueInfo* value_info,
5609 _Out_ bool* is_required_graph_input);
5610
5624 ORT_API2_STATUS(ValueInfo_IsOptionalGraphInput, _In_ const OrtValueInfo* value_info,
5625 _Out_ bool* is_optional_graph_input);
5626
5636 ORT_API2_STATUS(ValueInfo_IsGraphOutput, _In_ const OrtValueInfo* value_info, _Out_ bool* is_graph_output);
5637
5652 ORT_API2_STATUS(ValueInfo_IsConstantInitializer, _In_ const OrtValueInfo* value_info,
5653 _Out_ bool* is_constant_initializer);
5654
5668 ORT_API2_STATUS(ValueInfo_IsFromOuterScope, _In_ const OrtValueInfo* value_info,
5669 _Out_ bool* is_from_outer_scope);
5670
5671 //
5672 // OrtGraph
5673 //
5674
5684 ORT_API2_STATUS(Graph_GetName, _In_ const OrtGraph* graph, _Outptr_ const char** graph_name);
5685
5695 ORT_API2_STATUS(Graph_GetOnnxIRVersion, _In_ const OrtGraph* graph, _Out_ int64_t* onnx_ir_version);
5696
5709 ORT_API2_STATUS(Graph_GetInputs, _In_ const OrtGraph* graph, _Outptr_ OrtArrayOfConstObjects** inputs);
5710
5721 ORT_API2_STATUS(Graph_GetOutputs, _In_ const OrtGraph* graph, _Outptr_ OrtArrayOfConstObjects** outputs);
5722
5742 ORT_API2_STATUS(Graph_GetInitializers, _In_ const OrtGraph* graph, _Outptr_ OrtArrayOfConstObjects** initializers);
5743
5757 ORT_API2_STATUS(Graph_GetNodes, const OrtGraph* graph, _Outptr_ OrtArrayOfConstObjects** nodes);
5758
5772 ORT_API2_STATUS(Graph_GetParentNode, _In_ const OrtGraph* graph, _Outptr_result_maybenull_ const OrtNode** node);
5773
5774 //
5775 // OrtNode
5776 //
5777
5790 ORT_API2_STATUS(Node_GetId, _In_ const OrtNode* node, _Out_ size_t* node_id);
5791
5801 ORT_API2_STATUS(Node_GetName, _In_ const OrtNode* node, _Outptr_ const char** node_name);
5802
5812 ORT_API2_STATUS(Node_GetOperatorType, _In_ const OrtNode* node, _Outptr_ const char** operator_type);
5813
5823 ORT_API2_STATUS(Node_GetDomain, _In_ const OrtNode* node, _Outptr_ const char** domain_name);
5824
5834 ORT_API2_STATUS(Node_GetSinceVersion, _In_ const OrtNode* node, _Out_ int* since_version);
5835
5846 ORT_API2_STATUS(Node_GetInputs, _In_ const OrtNode* node, _Outptr_ OrtArrayOfConstObjects** inputs);
5847
5858 ORT_API2_STATUS(Node_GetOutputs, _In_ const OrtNode* node, _Outptr_ OrtArrayOfConstObjects** outputs);
5859
5875 ORT_API2_STATUS(Node_GetImplicitInputs, _In_ const OrtNode* node, _Outptr_ OrtArrayOfConstObjects** implicit_inputs);
5876
5889 ORT_API2_STATUS(Node_GetSubgraphs, _In_ const OrtNode* node, _Outptr_ OrtArrayOfConstObjects** subgraphs);
5890
5903 ORT_API2_STATUS(Node_GetParentGraph, _In_ const OrtNode* node,
5904 _Outptr_result_maybenull_ const OrtGraph** parent_graph);
5905};
5906
5907/*
5908 * Steps to use a custom op:
5909 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
5910 * 2 Create an OrtCustomOp structure for each op and add them to the domain
5911 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
5912 */
5913
5914// Specifies some characteristics of inputs/outputs of custom ops:
5915// Specify if the inputs/outputs are one of:
5916// 1) Non-optional (input/output must be present in the node)
5917// 2) Optional (input/output may be absent in the node)
5918// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
5919// Only the last input or output of a custom op may be marked as variadic.
5920// The homogeneity of the variadic input or output determines whether all operands must be of the same
5921// tensor element type.
5927
5928/*
5929 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
5930 * the implementor of the custom op.
5931 */
5933 uint32_t version; // Must be initialized to ORT_API_VERSION
5934
5935 // This callback creates the kernel, which is a user defined
5936 // parameter that is passed to the Kernel* callbacks below. It is
5937 // recommended to use CreateKernelV2 which allows for a safe error
5938 // propagation by returning an OrtStatusPtr.
5939 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
5940 _In_ const OrtKernelInfo* info);
5941
5942 // Returns the name of the op
5943 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
5944
5945 // Returns the type of the execution provider, return nullptr to use CPU execution provider
5946 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
5947
5948 // Returns the count and types of the input & output tensors
5949 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5950 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
5951 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5952 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
5953
5954 // Perform a computation step. It is recommended to use
5955 // KernelComputeV2 which allows for a safe error propagation by
5956 // returning an OrtStatusPtr.
5957 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
5958 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
5959
5960 // Returns the characteristics of the input & output tensors
5961 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5962 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5963
5964 // Returns the memory type of the input tensors. This API allows the custom op
5965 // to place the inputs on specific devices. By default, it returns
5966 // OrtMemTypeDefault, which means the input is placed on the default device for
5967 // the execution provider. If the inputs need to be with different memory types,
5968 // this function can be overridden to return the specific memory types.
5969 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5970
5971 // Returns the minimum number of input arguments expected for the variadic input.
5972 // Applicable only for custom ops that have a variadic input.
5973 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
5974
5975 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
5976 // and false (zero) otherwise.
5977 // Applicable only for custom ops that have a variadic input.
5978 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
5979
5980 // Returns the minimum number of output values expected for the variadic output.
5981 // Applicable only for custom ops that have a variadic output.
5982 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
5983
5984 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
5985 // and false (zero) otherwise.
5986 // Applicable only for custom ops that have a variadic output.
5987 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
5988
5989 // Create the kernel state which is passed to each compute call.
5990 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
5991 _In_ const OrtKernelInfo* info,
5992 _Out_ void** kernel);
5993
5994 // Perform the computation step.
5995 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
5996
5997 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
5998
5999 // Get start range
6000 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
6001 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
6002
6003 // Get the inplace_map that defines which output can reuse which input
6004 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
6005 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
6006 // The return value is the size of these 2 arrays.
6007 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
6008 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
6009
6010 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
6011 // If GetMayInplace() is defined, this function MUST be defined as well.
6012 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
6013
6014 // Same as GetMayInplace() and ReleaseMayInplace()
6015 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
6016 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
6017};
6018
6031 // Model building/editing requires a full build. We return nullptr from GetModelEditorApi if this is a minimal
6032 // build, so it doesn't matter if there are no function pointers in this struct as a user will never get an
6033 // OrtModelEditorApi instance. We do however need a dummy field to avoid empty struct warning.
6034#if defined(ORT_MINIMAL_BUILD)
6035 const bool not_defined_in_this_build;
6036#else
6050 ORT_API2_STATUS(CreateTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
6051 _Outptr_ OrtTypeInfo** type_info);
6052
6066 ORT_API2_STATUS(CreateSparseTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
6067 _Outptr_ OrtTypeInfo** type_info);
6068
6083 ORT_API2_STATUS(CreateMapTypeInfo, ONNXTensorElementDataType map_key_type, _In_ const OrtTypeInfo* map_value_type,
6084 _Outptr_ OrtTypeInfo** type_info);
6085
6099 ORT_API2_STATUS(CreateSequenceTypeInfo, _In_ const OrtTypeInfo* sequence_type, _Outptr_ OrtTypeInfo** type_info);
6100
6114 ORT_API2_STATUS(CreateOptionalTypeInfo, _In_ const OrtTypeInfo* contained_type, _Outptr_ OrtTypeInfo** type_info);
6115
6126 ORT_API2_STATUS(CreateValueInfo, _In_ const char* name, _In_ const OrtTypeInfo* type_info,
6127 _Outptr_ OrtValueInfo** value_info);
6128
6150 ORT_API2_STATUS(CreateNode, _In_ const char* operator_name, _In_ const char* domain_name, _In_ const char* node_name,
6151 _In_reads_(input_names_len) const char* const* input_names, size_t input_names_len,
6152 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
6153 _In_reads_(attribs_len) _In_opt_ OrtOpAttr** attributes, _In_ size_t attribs_len,
6154 _Outptr_ OrtNode** node);
6155
6160 ORT_API2_STATUS(CreateGraph, _Outptr_ OrtGraph** graph);
6161
6175 ORT_API2_STATUS(SetGraphInputs, _Inout_ OrtGraph* graph,
6176 _In_reads_(inputs_len) _In_ OrtValueInfo** inputs, _In_ size_t inputs_len);
6177
6191 ORT_API2_STATUS(SetGraphOutputs, _Inout_ OrtGraph* graph,
6192 _In_reads_(outputs_len) _In_ OrtValueInfo** outputs, _In_ size_t outputs_len);
6193
6232 ORT_API2_STATUS(AddInitializerToGraph, _Inout_ OrtGraph* graph, _In_ const char* name, _In_ OrtValue* tensor,
6233 bool data_is_external);
6234
6246 ORT_API2_STATUS(AddNodeToGraph, _Inout_ OrtGraph* graph, _In_ OrtNode* node);
6247
6266 ORT_API2_STATUS(CreateModel,
6267 _In_reads_(opset_entries_len) const char* const* domain_names,
6268 _In_reads_(opset_entries_len) const int* opset_versions,
6269 size_t opset_entries_len,
6270 _Outptr_ OrtModel** model);
6271
6285 ORT_API2_STATUS(AddGraphToModel, _Inout_ OrtModel* model, _In_ OrtGraph* graph);
6286
6305 ORT_API2_STATUS(CreateSessionFromModel, _In_ const OrtEnv* env, _In_ const OrtModel* model,
6306 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
6307
6330 ORT_API2_STATUS(CreateModelEditorSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
6331 _In_ const OrtSessionOptions* options,
6332 _Outptr_ OrtSession** out);
6333
6358 ORT_API2_STATUS(CreateModelEditorSessionFromArray, _In_ const OrtEnv* env,
6359 _In_ const void* model_data, size_t model_data_length,
6360 _In_ const OrtSessionOptions* options,
6361 _Outptr_ OrtSession** out);
6362
6377 ORT_API2_STATUS(SessionGetOpsetForDomain, _In_ const OrtSession* session, _In_ const char* domain, _Out_ int* opset);
6378
6397 ORT_API2_STATUS(ApplyModelToModelEditorSession, _Inout_ OrtSession* session, _In_ OrtModel* model);
6398
6412 ORT_API2_STATUS(FinalizeModelEditorSession, _Inout_ OrtSession* session, _In_ const OrtSessionOptions* options,
6413 _In_opt_ OrtPrepackedWeightsContainer* prepacked_weights_container);
6414#endif // !defined(ORT_MINIMAL_BUILD)
6415};
6416
6424 // Default. Do not enable any additional compilation options.
6426
6427 // Force compilation to return an error (ORT_FAIL) if no nodes were compiled.
6428 // Otherwise, a model with basic optimizations (ORT_ENABLE_BASIC) is still generated by default.
6430
6431 // Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists.
6432 // Otherwise, compilation will automatically overwrite the output file if it exists.
6435
6463 ORT_CLASS_RELEASE(ModelCompilationOptions);
6464
6480 ORT_API2_STATUS(CreateModelCompilationOptionsFromSessionOptions, _In_ const OrtEnv* env,
6481 _In_ const OrtSessionOptions* session_options, _Outptr_ OrtModelCompilationOptions** out);
6482
6495 ORT_API2_STATUS(ModelCompilationOptions_SetInputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
6496 _In_ const ORTCHAR_T* input_model_path);
6497
6512 _In_ OrtModelCompilationOptions* model_compile_options,
6513 _In_ const void* input_model_data,
6514 size_t input_model_data_size);
6515
6533 ORT_API2_STATUS(ModelCompilationOptions_SetOutputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
6534 _In_ const ORTCHAR_T* output_model_path);
6535
6552 _In_ OrtModelCompilationOptions* model_compile_options,
6553 _In_ const ORTCHAR_T* external_initializers_file_path,
6554 size_t external_initializers_size_threshold);
6555
6578 _In_ OrtModelCompilationOptions* model_compile_options,
6579 _Inout_ OrtAllocator* allocator,
6580 _Outptr_ void** output_model_buffer_ptr,
6581 _Out_ size_t* output_model_buffer_size_ptr);
6582
6605 ORT_API2_STATUS(ModelCompilationOptions_SetEpContextEmbedMode, _In_ OrtModelCompilationOptions* model_compile_options,
6606 bool embed_ep_context_in_model);
6607
6617 ORT_API2_STATUS(CompileModel, _In_ const OrtEnv* env, _In_ const OrtModelCompilationOptions* model_options);
6618
6628 ORT_API2_STATUS(ModelCompilationOptions_SetFlags, _In_ OrtModelCompilationOptions* model_compile_options,
6629 size_t flags);
6630};
6631
6632/*
6633 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
6634 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
6635 *
6636 * \param device_id CUDA device id, starts from zero.
6637 */
6638ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
6639
6640/*
6641 * This is the old way to add the ROCm provider to the session, please use
6642 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
6643 * This function always exists, but will only succeed if Onnxruntime was built with
6644 * HIP support and the ROCm provider shared library exists
6645 *
6646 * \param device_id HIP device id, starts from zero.
6647 */
6648ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
6649
6650/*
6651 * This is the old way to add the MIGraphX provider to the session, please use
6652 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
6653 * This function always exists, but will only succeed if Onnxruntime was built with
6654 * HIP support and the MIGraphX provider shared library exists
6655 *
6656 * \param device_id HIP device id, starts from zero.
6657 */
6658ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
6659
6660/*
6661 * This is the old way to add the oneDNN provider to the session, please use
6662 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
6663 * This function always exists, but will only succeed if Onnxruntime was built with
6664 * oneDNN support and the oneDNN provider shared library exists
6665 *
6666 * \param use_arena zero: false. non-zero: true.
6667 */
6668ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
6669
6670/*
6671 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
6672 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
6673 *
6674 * \param device_id CUDA device id, starts from zero.
6675 */
6676ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
6677
6678#ifdef __cplusplus
6679}
6680#endif
6682
6683#include "onnxruntime_ep_c_api.h"
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:287
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:313
struct OrtHardwareDevice OrtHardwareDevice
Definition onnxruntime_c_api.h:319
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:411
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:315
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Tensorrt(OrtSessionOptions *options, int device_id)
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:240
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:441
struct OrtModelCompilationOptions OrtModelCompilationOptions
Definition onnxruntime_c_api.h:318
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:312
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:375
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:855
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:857
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:5922
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:304
struct OrtEpApi OrtEpApi
Definition onnxruntime_c_api.h:796
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:310
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:301
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:295
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:400
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:314
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:308
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:229
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:303
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:289
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:485
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:298
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:288
OrtAllocatorType
Definition onnxruntime_c_api.h:417
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:309
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:299
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:292
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:293
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:306
struct OrtArrayOfConstObjects OrtArrayOfConstObjects
Definition onnxruntime_c_api.h:322
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:413
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:506
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:307
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:320
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:866
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:291
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:448
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:317
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:316
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:837
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:296
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:297
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:434
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:290
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:384
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:321
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:327
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:426
OrtSparseFormat
Definition onnxruntime_c_api.h:221
ONNXType
Definition onnxruntime_c_api.h:209
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:285
OrtErrorCode
Definition onnxruntime_c_api.h:248
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:286
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:311
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:294
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:302
ExecutionMode
Definition onnxruntime_c_api.h:392
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:265
struct OrtNodeComputeInfo OrtNodeComputeInfo
Definition onnxruntime_c_api.h:799
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:848
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:180
OrtCompileApiFlags
Flags representing options to enable when compiling a model.
Definition onnxruntime_c_api.h:6423
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:456
OrtTypeTag
Enum tags for ORT runtime types used to identify the type of elements in containers,...
Definition onnxruntime_c_api.h:497
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:241
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition onnxruntime_c_api.h:242
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition onnxruntime_c_api.h:244
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:243
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition onnxruntime_c_api.h:245
@ OrtMemoryInfoDeviceType_GPU
Definition onnxruntime_c_api.h:443
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:444
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:442
@ OrtMemoryInfoDeviceType_NPU
Definition onnxruntime_c_api.h:445
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:5925
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:5923
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:5924
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:401
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:404
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:402
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:406
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:403
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:405
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:407
@ ORT_SPARSE_COO_INDICES
Definition onnxruntime_c_api.h:230
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition onnxruntime_c_api.h:233
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition onnxruntime_c_api.h:232
@ ORT_SPARSE_CSR_INNER_INDICES
Definition onnxruntime_c_api.h:231
@ OrtDeviceAllocator
Definition onnxruntime_c_api.h:419
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:420
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:418
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:509
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:507
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:508
@ OrtHardwareDeviceType_CPU
Definition onnxruntime_c_api.h:449
@ OrtHardwareDeviceType_NPU
Definition onnxruntime_c_api.h:451
@ OrtHardwareDeviceType_GPU
Definition onnxruntime_c_api.h:450
@ OrtDeviceMemoryType_HOST_ACCESSIBLE
Shared/pinned memory for transferring between CPU and the device.
Definition onnxruntime_c_api.h:436
@ OrtDeviceMemoryType_DEFAULT
Device memory.
Definition onnxruntime_c_api.h:435
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:386
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:389
@ ORT_ENABLE_LAYOUT
Definition onnxruntime_c_api.h:388
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:385
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:387
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:427
@ OrtMemTypeCPU
Temporary CPU accessible memory allocated by non-CPU execution provider, i.e. CUDA_PINNED.
Definition onnxruntime_c_api.h:429
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:430
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. CUDA_PINNED.
Definition onnxruntime_c_api.h:428
@ ORT_SPARSE_CSRC
Definition onnxruntime_c_api.h:224
@ ORT_SPARSE_COO
Definition onnxruntime_c_api.h:223
@ ORT_SPARSE_BLOCK_SPARSE
Definition onnxruntime_c_api.h:225
@ ORT_SPARSE_UNDEFINED
Definition onnxruntime_c_api.h:222
@ ONNX_TYPE_SEQUENCE
Definition onnxruntime_c_api.h:212
@ ONNX_TYPE_MAP
Definition onnxruntime_c_api.h:213
@ ONNX_TYPE_OPAQUE
Definition onnxruntime_c_api.h:214
@ ONNX_TYPE_UNKNOWN
Definition onnxruntime_c_api.h:210
@ ONNX_TYPE_TENSOR
Definition onnxruntime_c_api.h:211
@ ONNX_TYPE_SPARSETENSOR
Definition onnxruntime_c_api.h:215
@ ONNX_TYPE_OPTIONAL
Definition onnxruntime_c_api.h:216
@ ORT_MODEL_LOAD_CANCELED
Definition onnxruntime_c_api.h:261
@ ORT_NO_SUCHFILE
Definition onnxruntime_c_api.h:252
@ ORT_OK
Definition onnxruntime_c_api.h:249
@ ORT_INVALID_ARGUMENT
Definition onnxruntime_c_api.h:251
@ ORT_EP_FAIL
Definition onnxruntime_c_api.h:260
@ ORT_NOT_IMPLEMENTED
Definition onnxruntime_c_api.h:258
@ ORT_RUNTIME_EXCEPTION
Definition onnxruntime_c_api.h:255
@ ORT_ENGINE_ERROR
Definition onnxruntime_c_api.h:254
@ ORT_FAIL
Definition onnxruntime_c_api.h:250
@ ORT_MODEL_REQUIRES_COMPILATION
Definition onnxruntime_c_api.h:262
@ ORT_INVALID_PROTOBUF
Definition onnxruntime_c_api.h:256
@ ORT_NO_MODEL
Definition onnxruntime_c_api.h:253
@ ORT_INVALID_GRAPH
Definition onnxruntime_c_api.h:259
@ ORT_MODEL_LOADED
Definition onnxruntime_c_api.h:257
@ ORT_PARALLEL
Definition onnxruntime_c_api.h:394
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:393
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:267
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:270
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:272
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:266
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:268
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:271
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:269
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition onnxruntime_c_api.h:189
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition onnxruntime_c_api.h:187
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition onnxruntime_c_api.h:193
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition onnxruntime_c_api.h:185
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition onnxruntime_c_api.h:181
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition onnxruntime_c_api.h:196
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ
Definition onnxruntime_c_api.h:202
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition onnxruntime_c_api.h:194
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4
Definition onnxruntime_c_api.h:204
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition onnxruntime_c_api.h:188
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2
Definition onnxruntime_c_api.h:201
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition onnxruntime_c_api.h:190
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition onnxruntime_c_api.h:191
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition onnxruntime_c_api.h:183
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition onnxruntime_c_api.h:186
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition onnxruntime_c_api.h:192
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition onnxruntime_c_api.h:184
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:182
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN
Definition onnxruntime_c_api.h:199
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition onnxruntime_c_api.h:197
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4
Definition onnxruntime_c_api.h:205
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition onnxruntime_c_api.h:195
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ
Definition onnxruntime_c_api.h:200
@ OrtCompileApiFlags_NONE
Definition onnxruntime_c_api.h:6425
@ OrtCompileApiFlags_ERROR_IF_NO_NODES_COMPILED
Definition onnxruntime_c_api.h:6429
@ OrtCompileApiFlags_ERROR_IF_OUTPUT_FILE_EXISTS
Definition onnxruntime_c_api.h:6433
@ OrtExecutionProviderDevicePolicy_DEFAULT
Definition onnxruntime_c_api.h:457
@ OrtExecutionProviderDevicePolicy_PREFER_CPU
Definition onnxruntime_c_api.h:458
@ OrtExecutionProviderDevicePolicy_MAX_PERFORMANCE
Definition onnxruntime_c_api.h:461
@ OrtExecutionProviderDevicePolicy_PREFER_NPU
Definition onnxruntime_c_api.h:459
@ OrtExecutionProviderDevicePolicy_MAX_EFFICIENCY
Definition onnxruntime_c_api.h:462
@ OrtExecutionProviderDevicePolicy_PREFER_GPU
Definition onnxruntime_c_api.h:460
@ OrtExecutionProviderDevicePolicy_MIN_OVERALL_POWER
Definition onnxruntime_c_api.h:463
@ ORT_TYPE_TAG_OrtValueInfo
Definition onnxruntime_c_api.h:499
@ ORT_TYPE_TAG_Void
Definition onnxruntime_c_api.h:498
@ ORT_TYPE_TAG_OrtNode
Definition onnxruntime_c_api.h:500
@ ORT_TYPE_TAG_OrtGraph
Definition onnxruntime_c_api.h:501
Memory allocation interface.
Definition onnxruntime_c_api.h:336
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:343
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:346
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:337
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition onnxruntime_c_api.h:340
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:352
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:805
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:821
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:815
The C API.
Definition onnxruntime_c_api.h:875
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 * 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:5242
void(* ReleaseDnnlProviderOptions)(OrtDnnlProviderOptions *input)
Release an OrtDnnlProviderOptions.
Definition onnxruntime_c_api.h:4317
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:4507
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 * ArrayOfConstObjects_GetElementAt(const OrtArrayOfConstObjects *array, size_t index, const void **out)
Get the element at the given index. Returns an error status if the index is outside the array bounds.
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 * Graph_GetOutputs(const OrtGraph *graph, OrtArrayOfConstObjects **outputs)
Returns the graph's outputs as OrtValueInfo instances.
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:5065
OrtStatus * AddFreeDimensionOverrideByName(OrtSessionOptions *options, const char *dim_name, int64_t dim_value)
OrtStatus * KernelInfo_GetInputCount(const OrtKernelInfo *info, size_t *out)
Get the number of inputs from OrtKernelInfo.
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:5260
const OrtTrainingApi *(* GetTrainingApi)(uint32_t version)
Gets the Training C Api struct.
Definition onnxruntime_c_api.h:3915
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 * ArrayOfConstObjects_GetMutableData(OrtArrayOfConstObjects *array, const void ***data)
Get a pointer to a data buffer of contiguous elements, where each element is a pointer to a constant ...
OrtStatus * AddSessionConfigEntry(OrtSessionOptions *options, const char *config_key, const char *config_value)
Set a session configuration entry as a pair of strings.
OrtStatus * Node_GetParentGraph(const OrtNode *node, const OrtGraph **parent_graph)
Get the node's parent OrtGraph instance.
OrtStatus * CreateMemoryInfo_V2(const char *name, enum OrtMemoryInfoDeviceType device_type, uint32_t vendor_id, int16_t device_id, enum OrtDeviceMemoryType mem_type, size_t alignment, enum OrtAllocatorType allocator_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo.
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:2570
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 * 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:5114
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.
OrtStatus * Graph_GetInitializers(const OrtGraph *graph, OrtArrayOfConstObjects **initializers)
Returns the graph's initializers as OrtValueInfo instances. Includes constant and non-constant initia...
const OrtHardwareDevice *(* EpDevice_Device)(const OrtEpDevice *ep_device)
Get the OrtHardwareDevice instance for the OrtEpDevice.
Definition onnxruntime_c_api.h:5325
OrtStatus * ModelMetadataGetGraphDescription(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
OrtStatus * UpdateDnnlProviderOptions(OrtDnnlProviderOptions *dnnl_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a oneDNN Execution Provider.
OrtStatus * GetStringTensorElementLength(const OrtValue *value, size_t index, size_t *out)
Get the length of a single string in a string tensor.
OrtStatus * ArrayOfConstObjects_AppendElement(OrtArrayOfConstObjects *array, const void *element)
Appends an element to the end of the array, which increases the size of the array by one.
void(* MemoryInfoGetDeviceType)(const OrtMemoryInfo *ptr, OrtMemoryInfoDeviceType *out)
Definition onnxruntime_c_api.h:3987
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 * FillStringTensor(OrtValue *value, const char *const *s, size_t s_len)
Set all strings at once in a string tensor.
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 * 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 id from OrtMemoryInfo.
OrtStatus * ValueInfo_GetValueConsumers(const OrtValueInfo *value_info, const OrtNode **nodes, int64_t *input_indices, size_t max_num_consumers)
Returns information (OrtNode and input index) for all consumer nodes that use the value as an input.
OrtStatus * ArrayOfConstObjects_GetSize(const OrtArrayOfConstObjects *array, size_t *size)
Get the number of elements contained by the given OrtArrayOfConstObjects instance.
OrtStatus * KernelInfo_GetOutputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's output.
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 * 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:5007
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 * CastTypeInfoToTensorInfo(const OrtTypeInfo *type_info, const OrtTensorTypeAndShapeInfo **out)
Get OrtTensorTypeAndShapeInfo from an OrtTypeInfo.
OrtStatus * ArrayOfConstObjects_SetElementAt(OrtArrayOfConstObjects *array, size_t index, const void *element)
Set the element at the given index. Returns an error status if the index is outside the array bounds.
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 * Node_GetInputs(const OrtNode *node, OrtArrayOfConstObjects **inputs)
Returns a node's inputs as OrtValueInfo instances.
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 * GetTensorRTProviderOptionsAsString(const OrtTensorRTProviderOptionsV2 *tensorrt_options, OrtAllocator *allocator, char **ptr)
Get serialized TensorRT provider options string.
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:4566
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 * SetCurrentGpuDeviceId(int device_id)
Set current GPU device ID.
OrtStatus * GetOnnxTypeFromTypeInfo(const OrtTypeInfo *type_info, enum ONNXType *out)
Get ONNXType from OrtTypeInfo.
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:3981
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 * 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:5331
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 * 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 * AddCustomOpDomain(OrtSessionOptions *options, OrtCustomOpDomain *custom_op_domain)
Add custom op domain to a session options.
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:5251
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 * 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 * 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 * 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)
OrtStatus * CreateArrayOfConstObjects(OrtTypeTag object_type, size_t initial_size, const void *initial_value, OrtArrayOfConstObjects **out)
Create an OrtArrayOfConstObjects instance, which represents an array of pointers to constant opaque o...
void(* AddKeyValuePair)(OrtKeyValuePairs *kvps, const char *key, const char *value)
Add a key-value pair to the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5092
OrtStatus * CreateRunOptions(OrtRunOptions **out)
Create an OrtRunOptions.
OrtStatus * RunOptionsGetRunTag(const OrtRunOptions *options, const char **run_tag)
Get per-run tag.
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:900
OrtStatus * IsTensor(const OrtValue *value, int *out)
Return if an OrtValue is a tensor type.
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 * 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 * ArrayOfConstObjects_GetObjectType(const OrtArrayOfConstObjects *array, OrtTypeTag *type_tag)
Get a tag that represents the type of the opaque objects stored in a OrtArrayOfConstObjects instance.
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:5103
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:5289
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:5270
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 * GetTensorTypeAndShape(const OrtValue *value, OrtTensorTypeAndShapeInfo **out)
Get type and shape information from a tensor OrtValue.
OrtStatus * Node_GetImplicitInputs(const OrtNode *node, OrtArrayOfConstObjects **implicit_inputs)
Get the implicit inputs, as OrtValueInfo instances, that are used within the given node's subgraphs.
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:5307
OrtStatus * ArrayOfConstObjects_GetData(const OrtArrayOfConstObjects *array, const void *const **data)
Get a pointer to a data buffer of contiguous elements, where each element is a constant pointer to a ...
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.
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2574
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 * 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)
OrtStatus * Graph_GetInputs(const OrtGraph *graph, OrtArrayOfConstObjects **inputs)
Returns the graph's inputs as OrtValueInfo instances.
void(* CreateKeyValuePairs)(OrtKeyValuePairs **out)
Create an OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5079
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:886
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 * Node_GetSubgraphs(const OrtNode *node, OrtArrayOfConstObjects **subgraphs)
Get the subgraphs, as OrtGraph instances, contained by the given node.
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 * 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 * EnableOrtCustomOps(OrtSessionOptions *options)
Enable custom operators.
OrtStatus * UpdateEnvWithCustomLogLevel(OrtEnv *ort_env, OrtLoggingLevel log_severity_level)
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 * 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:5316
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 * ShapeInferContext_GetInputTypeShape(const OrtShapeInferContext *context, size_t index, OrtTensorTypeAndShapeInfo **info)
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:3131
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 ...
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:5298
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:5280
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 * 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 * 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 * Graph_GetNodes(const OrtGraph *graph, OrtArrayOfConstObjects **nodes)
Returns the graph's nodes as OrtNode instances.
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_GetOutputs(const OrtNode *node, OrtArrayOfConstObjects **outputs)
Returns a node's outputs as OrtValueInfo instances.
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:5125
void(* ReleaseCUDAProviderOptions)(OrtCUDAProviderOptionsV2 *input)
Release an OrtCUDAProviderOptionsV2.
Definition onnxruntime_c_api.h:3634
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:893
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:516
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:595
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:569
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:564
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:574
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:584
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:547
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:555
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:518
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:578
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:590
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:541
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:535
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:6459
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 * CreateModelCompilationOptionsFromSessionOptions(const OrtEnv *env, const OrtSessionOptions *session_options, OrtModelCompilationOptions **out)
Creates an OrtModelCompilationOptions object from an existing OrtSessionOptions object.
OrtStatus * ModelCompilationOptions_SetFlags(OrtModelCompilationOptions *model_compile_options, size_t flags)
Sets flags from OrtCompileApiFlags that represent one or more boolean options to enable.
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 * CompileModel(const OrtEnv *env, const OrtModelCompilationOptions *model_options)
Compiles an input ONNX model with the given compilation options.
Definition onnxruntime_c_api.h:839
char __place_holder
Definition onnxruntime_c_api.h:840
Definition onnxruntime_c_api.h:5932
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5978
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5962
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5950
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5982
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:6015
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6000
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:6012
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5943
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5952
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:5958
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5987
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5969
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:5939
uint32_t version
Definition onnxruntime_c_api.h:5933
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5949
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:6016
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5961
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5946
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5951
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5973
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:5997
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:6001
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:5990
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:6008
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:5995
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:5957
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:720
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:731
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:727
int migraphx_fp8_enable
Definition onnxruntime_c_api.h:723
int migraphx_int8_enable
Definition onnxruntime_c_api.h:724
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:729
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:722
int device_id
Definition onnxruntime_c_api.h:721
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:725
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:737
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:730
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:728
int migraphx_arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:745
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:726
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:6030
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:758
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:779
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:776
void * context
Definition onnxruntime_c_api.h:778
const char * cache_dir
Definition onnxruntime_c_api.h:777
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:773
const char * device_id
Definition onnxruntime_c_api.h:775
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:774
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:760
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:780
ROCM Provider Options.
Definition onnxruntime_c_api.h:603
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:623
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:684
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:651
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:665
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:634
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:605
int enable_hip_graph
Definition onnxruntime_c_api.h:667
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:673
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:661
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:642
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:679
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:656
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exhaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:628
TensorRT Provider Options.
Definition onnxruntime_c_api.h:692
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:706
void * user_compute_stream
Definition onnxruntime_c_api.h:695
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:693
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:707
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:708
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:696
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:698
int trt_dla_enable
Definition onnxruntime_c_api.h:703
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:701
int has_user_compute_stream
Definition onnxruntime_c_api.h:694
int trt_dla_core
Definition onnxruntime_c_api.h:704
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:702
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:697
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:710
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:705
int trt_fp16_enable
Definition onnxruntime_c_api.h:699
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:709
int trt_int8_enable
Definition onnxruntime_c_api.h:700
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122