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 27
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
48// SAL2 Definitions
49#ifndef _MSC_VER
50#define _In_
51#define _In_z_
52#define _In_opt_
53#define _In_opt_z_
54#define _Out_
55#define _Out_opt_
56#define _Outptr_
57#define _Outptr_opt_
58#define _Inout_
59#define _Inout_opt_
60#define _Frees_ptr_opt_
61#define _Ret_maybenull_
62#define _Ret_notnull_
63#define _Check_return_
64#define _Outptr_result_maybenull_
65#define _Outptr_result_maybenull_z_
66#define _In_reads_(X)
67#define _In_reads_opt_
68#define _Inout_updates_(X)
69#define _Out_writes_(X)
70#define _Out_writes_opt_(X)
71#define _Inout_updates_all_(X)
72#define _Out_writes_bytes_all_(X)
73#define _Out_writes_all_(X)
74#define _Success_(X)
75#define _Outptr_result_buffer_maybenull_(X)
76#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
77#else
78#include <specstrings.h>
79#define ORT_ALL_ARGS_NONNULL
80#endif
81
82#ifdef _WIN32
83// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
84// dllexport is not used, we use a .def file.
85#ifdef ORT_DLL_IMPORT
86#define ORT_EXPORT __declspec(dllimport)
87#else
88#define ORT_EXPORT
89#endif
90#define ORT_API_CALL __stdcall
91#define ORT_MUST_USE_RESULT
92#define ORTCHAR_T wchar_t
93#else
94// Make symbols visible on non-Windows platforms. The visibility attribute is
95// needed when ORT is built as a shared library without a version script
96// (e.g. when compiled within another project's build system). On non-Apple
97// platforms, the default ORT build uses a generated version script
98// (tools/ci_build/gen_def.py) that exports the needed symbols, so this was
99// previously only enabled for __APPLE__. Expanding to __GNUC__ (GCC/Clang)
100// covers additional embedding scenarios while remaining harmless when a
101// version script is also in use.
102#if defined(__GNUC__)
103#define ORT_EXPORT __attribute__((visibility("default")))
104#else
105#define ORT_EXPORT
106#endif
107#define ORT_API_CALL
108#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
109#define ORTCHAR_T char
110#endif
111
114#ifndef ORT_TSTR
115#ifdef _WIN32
116#define ORT_TSTR(X) L##X
117// When X is a macro, L##X is not defined. In this case, we need to use ORT_TSTR_ON_MACRO.
118#define ORT_TSTR_ON_MACRO(X) L"" X
119#else
120#define ORT_TSTR(X) X
121#define ORT_TSTR_ON_MACRO(X) X
122#endif
123#endif
124
125// On Windows, ORT_FILE is a wchar_t version of the __FILE__ macro.
126// Otherwise, ORT_FILE is equivalent to __FILE__.
127#ifndef ORT_FILE
128#define ORT_FILE_INTERNAL(x) ORT_TSTR(x)
129#define ORT_FILE ORT_FILE_INTERNAL(__FILE__)
130#endif
131
132// Any pointer marked with _In_ or _Out_, cannot be NULL.
133
134// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
135// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
136// for ReleaseXXX(...) functions, they can accept NULL pointer.
137
138#ifdef __cplusplus
139// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
140// Such complex condition is needed because compilers set __cplusplus value differently.
141#ifndef __has_feature
142#define __has_feature(x) 0
143#endif
144#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
145#define NO_EXCEPTION noexcept
146#else
147#define NO_EXCEPTION throw()
148#endif
149#else
150#define NO_EXCEPTION
151#endif
152
153// __VA_ARGS__ on Windows and Linux are different
154#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
155
156#define ORT_API_T(RETURN_TYPE, NAME, ...) \
157 RETURN_TYPE(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION
158
159#define ORT_API_STATUS(NAME, ...) \
160 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
161 NO_EXCEPTION ORT_MUST_USE_RESULT
162
163// XXX: Unfortunately, SAL annotations are known to not work with function pointers
164#define ORT_API2_STATUS(NAME, ...) \
165 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
166
167// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
168#define ORT_API_STATUS_IMPL(NAME, ...) \
169 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
170
171#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
172
173#ifdef __DOXYGEN__
174#undef ORT_API_STATUS
175#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
176#undef ORT_API2_STATUS
177#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
178#undef ORT_CLASS_RELEASE
179#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
180#undef NO_EXCEPTION
181#define NO_EXCEPTION
182#endif
193 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
194 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
195 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
196 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
197 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
198 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
199 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
200 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
203 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
204 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
205 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
206 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
207 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
208 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16, // Non-IEEE floating-point format based on IEEE754 single-precision
209 // float 8 types were introduced in onnx 1.14, see https://onnx.ai/onnx/technical/float8.html
210 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN, // Non-IEEE floating-point format based on IEEE754 single-precision
211 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
212 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2, // Non-IEEE floating-point format based on IEEE754 single-precision
213 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
214 // Int4 types were introduced in ONNX 1.16. See https://onnx.ai/onnx/technical/int4.html
215 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4, // maps to a pair of packed uint4 values (size == 1 byte)
216 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4, // maps to a pair of packed int4 values (size == 1 byte)
217 // Float4 types were introduced in ONNX 1.18. See https://onnx.ai/onnx/technical/float4.html
218 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT4E2M1, // maps to a pair of packed float4 values (size == 1 byte)
219 // Int2 types were introduced in ONNX 1.20. See https://onnx.ai/onnx/technical/int2.html
220 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT2, // maps to 4 packed uint2 values (size == 1 byte)
221 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT2, // maps to 4 packed int2 values (size == 1 byte)
222 // Float8E8M0 type introduced in ONNX 1.21. 8-bit float with 8 exponent bits, 0 mantissa bits, no sign bit.
223 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E8M0, // Non-IEEE floating-point format, all values are powers of two
225
226// Synced with onnx TypeProto oneof
236
237// These types are synced with internal
238// SparseFormatFlags
245
246// Enum allows to query sparse tensor indices
253
265
283
295
297#define ORT_RUNTIME_CLASS(X) \
298 struct Ort##X; \
299 typedef struct Ort##X Ort##X
300
305// The actual types defined have an Ort prefix
306ORT_RUNTIME_CLASS(Env);
307ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
308ORT_RUNTIME_CLASS(MemoryInfo);
309ORT_RUNTIME_CLASS(IoBinding);
310ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
311ORT_RUNTIME_CLASS(Value);
312ORT_RUNTIME_CLASS(RunOptions);
313ORT_RUNTIME_CLASS(TypeInfo);
314ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
315ORT_RUNTIME_CLASS(MapTypeInfo);
316ORT_RUNTIME_CLASS(SequenceTypeInfo);
317ORT_RUNTIME_CLASS(OptionalTypeInfo);
318ORT_RUNTIME_CLASS(SessionOptions);
319ORT_RUNTIME_CLASS(CustomOpDomain);
320ORT_RUNTIME_CLASS(ModelMetadata);
321ORT_RUNTIME_CLASS(ThreadPoolParams);
322ORT_RUNTIME_CLASS(ThreadingOptions);
323ORT_RUNTIME_CLASS(ArenaCfg);
324ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
325ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
326ORT_RUNTIME_CLASS(NvTensorRtRtxProviderOptions);
327ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
328ORT_RUNTIME_CLASS(CANNProviderOptions);
329ORT_RUNTIME_CLASS(DnnlProviderOptions);
330ORT_RUNTIME_CLASS(Op);
331ORT_RUNTIME_CLASS(OpAttr);
332ORT_RUNTIME_CLASS(Logger);
333ORT_RUNTIME_CLASS(ShapeInferContext);
334ORT_RUNTIME_CLASS(LoraAdapter);
335ORT_RUNTIME_CLASS(ValueInfo);
336ORT_RUNTIME_CLASS(Node);
337ORT_RUNTIME_CLASS(Graph);
338ORT_RUNTIME_CLASS(Model);
339ORT_RUNTIME_CLASS(ModelCompilationOptions);
340ORT_RUNTIME_CLASS(HardwareDevice);
341ORT_RUNTIME_CLASS(EpDevice);
342ORT_RUNTIME_CLASS(KeyValuePairs);
343ORT_RUNTIME_CLASS(SyncStream); // Opaque class to create an onnxruntime::Stream.
344ORT_RUNTIME_CLASS(ExternalInitializerInfo);
345ORT_RUNTIME_CLASS(ExternalResourceImporter); // Capability object for external resource import
346ORT_RUNTIME_CLASS(ExternalMemoryHandle); // EP-imported view of shared external allocation
347ORT_RUNTIME_CLASS(ExternalSemaphoreHandle); // EP-imported view of shared external semaphore
348ORT_RUNTIME_CLASS(DeviceEpIncompatibilityDetails);
349ORT_RUNTIME_CLASS(EpAssignedSubgraph);
350ORT_RUNTIME_CLASS(EpAssignedNode);
351
352#ifdef _MSC_VER
353typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
354#else
356#endif
357
364typedef struct OrtAllocator {
365 uint32_t version;
366
368 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
369
371 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
372
374 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
385 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
386
412 ORT_API2_STATUS(GetStats, _In_ const struct OrtAllocator* this_, _Outptr_ OrtKeyValuePairs** out);
413
429 void*(ORT_API_CALL* AllocOnStream)(struct OrtAllocator* this_, size_t size, OrtSyncStream* stream);
430
445 ORT_API2_STATUS(Shrink, _In_ struct OrtAllocator* this_);
447
448typedef void(ORT_API_CALL* OrtLoggingFunction)(
449 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
450 const char* message);
451
464
469
482
483struct OrtKernelInfo;
485struct OrtKernelContext;
487struct OrtCustomOp;
489
496
499// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
510
516
525
531
543
553
573typedef OrtStatus*(ORT_API_CALL* EpSelectionDelegate)(_In_ const OrtEpDevice** ep_devices,
574 _In_ size_t num_devices,
575 _In_ const OrtKeyValuePairs* model_metadata,
576 _In_opt_ const OrtKeyValuePairs* runtime_metadata,
577 _Inout_ const OrtEpDevice** selected,
578 _In_ size_t max_selected,
579 _Out_ size_t* num_selected,
580 _In_ void* state);
581
592typedef OrtStatus*(ORT_API_CALL* OrtWriteBufferFunc)(_In_ void* state,
593 _In_ const void* buffer,
594 _In_ size_t buffer_num_bytes);
595
627 _In_ void* state,
628 _In_ const char* initializer_name,
629 _In_ const OrtValue* initializer_value,
630 _In_opt_ const OrtExternalInitializerInfo* external_info,
631 _Outptr_result_maybenull_ OrtExternalInitializerInfo** new_external_info);
632
636 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
637 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
638 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
640
727
816
823 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
824 void* user_compute_stream; // user specified CUDA compute stream.
825 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
826 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
827 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
828 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
829 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
830 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
831 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
832 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
833 int trt_dla_core; // DLA core number. Default 0
834 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
835 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
836 const char* trt_engine_cache_path; // specify engine cache path
837 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
838 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
839 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
840 // This is the legacy struct and don't add new fields here.
841 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
842 // For non-string field, need to create a new separate api to handle it.
844
850 int device_id; // hip device id.
851 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
852 int migraphx_fp8_enable; // MIGraphX FP8 precision. Default 0 = false, nonzero = true
853 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
854 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, nonzero = true
855 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
856 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, nonzero = true
857 const char* migraphx_save_model_path; // migraphx model path name
858 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, nonzero = true
859 const char* migraphx_load_model_path; // migraphx model path name
860 bool migraphx_exhaustive_tune; // MIGraphX tuned compile. Default = false, nonzero = true
861
867
875
876 // This is the legacy struct and don't add new fields here.
878
889#ifdef __cplusplus
898#endif
903 const char* device_type;
905 const char* device_id;
907 const char* cache_dir; // path is set to empty by default
908 void* context;
910 unsigned char enable_dynamic_shapes;
912
913struct OrtApi;
914typedef struct OrtApi OrtApi;
915
916struct OrtTrainingApi;
918
919struct OrtModelEditorApi;
921
922struct OrtCompileApi;
924
925struct OrtInteropApi;
927
928struct OrtEpApi;
929typedef struct OrtEpApi OrtEpApi;
930
945 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
946
951 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
952};
953
954typedef struct OrtApiBase OrtApiBase;
955
960ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
961
967typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
968
972
978typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
979
985typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
986
996typedef _Ret_maybenull_ void* (*OrtThreadPoolWorkEnqueueFn)(_In_opt_ void* user_context)NO_EXCEPTION;
997
1006typedef void (*OrtThreadPoolWorkStartFn)(_In_opt_ void* user_context, _In_opt_ void* enqueue_data) NO_EXCEPTION;
1007
1017typedef void (*OrtThreadPoolWorkStopFn)(_In_opt_ void* user_context, _In_opt_ void* enqueue_data) NO_EXCEPTION;
1018
1026typedef void (*OrtThreadPoolWorkAbandonFn)(_In_opt_ void* user_context, _In_opt_ void* enqueue_data) NO_EXCEPTION;
1027
1049
1050typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
1051
1059typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
1060
1073
1089
1099
1112
1126
1177
1194
1195/*
1196 * Public enum for compiled model compatibility across EPs.
1197 */
1204
1213 uint32_t version;
1214
1226
1233 const char* log_id;
1234
1245
1252
1266
1286
1287 //
1288 // End of fields available in ORT 1.24
1289 //
1290
1292
1300struct OrtApi {
1303
1311 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1312
1318 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1319
1325 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1326
1330
1341 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1342
1357 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
1358 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1359
1367 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
1375 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
1376
1380
1390 // TODO: document the path separator convention? '/' vs '\'
1391 // TODO: should specify the access characteristics of model_path. Is this read only during the
1392 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
1393 // and continue to access throughout the OrtSession lifetime?
1394 // What sort of access is needed to model_path : read or read/write?
1395 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
1396 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1397
1408 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env,
1409 _In_ const void* model_data, size_t model_data_length,
1410 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1411
1430 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
1431 _In_reads_(input_len) const char* const* input_names,
1432 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
1433 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
1434 _Inout_updates_all_(output_names_len) OrtValue** outputs);
1435
1439
1455 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
1456
1464 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
1465 _In_ const ORTCHAR_T* optimized_model_filepath);
1466
1474 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
1475 _Outptr_ OrtSessionOptions** out_options);
1476
1488 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
1489
1497 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
1498
1505 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
1506
1520 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
1521
1530 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
1531
1540 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
1541
1548 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
1549
1557 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
1558
1568 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1569
1577 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1578
1587 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1588 GraphOptimizationLevel graph_optimization_level);
1589
1603 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1604
1617 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1618
1622
1630 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1631
1641 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1642
1646
1656 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1657
1674 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1675
1679
1691 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1692
1704 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1705
1715 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1716
1725 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1726
1735 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1736
1745 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1746
1756 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1757
1767 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1768
1778 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1779 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1780
1784
1791 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1792
1802 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1803
1811 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1812
1822 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1823
1833 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1834 _Out_ int* log_verbosity_level);
1835
1843 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1844
1856 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1857
1866 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1867
1876 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1877
1881
1894 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1896
1914 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1915 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1916 _Outptr_ OrtValue** out);
1917
1925 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1926
1937 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1938
1947 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1948
1958 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1959
1979 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1980 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1981
1985
1994 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1995 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1996
2004 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
2005
2009
2017
2026
2035 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
2036
2046 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
2048
2058 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
2059
2068 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
2069 size_t dim_values_length);
2070
2079 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
2080 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
2081
2098 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
2099
2103
2111 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
2112
2120 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
2121
2129 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
2130
2134
2145 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
2146 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
2147
2158 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
2159 _Outptr_ OrtMemoryInfo** out);
2160
2171 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
2172
2180 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
2181
2184 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
2185
2188 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
2189
2192 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
2193
2197
2199 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
2201 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
2203 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
2204
2213 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
2214
2218
2230 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
2231 _In_ int64_t dim_value);
2232
2236
2237 /* Internal information (not seen in Doxygen)
2238 *
2239 * APIs to support non-tensor types - map and sequence.
2240 * Currently only the following types are supported
2241 * Note: the following types should be kept in sync with data_types.h
2242 * Map types
2243 * =========
2244 * std::map<std::string, std::string>
2245 * std::map<std::string, int64_t>
2246 * std::map<std::string, float>
2247 * std::map<std::string, double>
2248 * std::map<int64_t, std::string>
2249 * std::map<int64_t, int64_t>
2250 * std::map<int64_t, float>
2251 * std::map<int64_t, double>
2252 *
2253 * Sequence types
2254 * ==============
2255 * std::vector<std::string>
2256 * std::vector<int64_t>
2257 * std::vector<float>
2258 * std::vector<double>
2259 * std::vector<std::map<std::string, float>>
2260 * std::vector<std::map<int64_t, float>
2261 */
2262
2277 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
2278 _Outptr_ OrtValue** out);
2279
2290 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
2291
2307 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
2308 enum ONNXType value_type, _Outptr_ OrtValue** out);
2309
2332 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
2333 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
2334
2349 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
2350 _Out_ void* data_container, size_t data_container_size);
2351
2356
2365 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2366 _Out_ float* out);
2367
2376 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2377 _Out_ int64_t* out);
2378
2399 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
2400 _Inout_ size_t* size);
2401
2406
2411 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2412
2417 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2418
2430 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
2431 _Out_ const OrtValue** out);
2432
2446 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
2447 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
2448
2452 ORT_CLASS_RELEASE(Env);
2456 ORT_CLASS_RELEASE(Status);
2460 ORT_CLASS_RELEASE(MemoryInfo);
2464 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
2468 ORT_CLASS_RELEASE(Value);
2472 ORT_CLASS_RELEASE(RunOptions);
2476 ORT_CLASS_RELEASE(TypeInfo);
2480 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
2484 ORT_CLASS_RELEASE(SessionOptions);
2488 ORT_CLASS_RELEASE(CustomOpDomain);
2489
2493
2506 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
2507 _Out_ size_t* len);
2508
2522 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
2523 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
2524
2538 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
2539 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
2540
2544
2556 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
2557
2566 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2567
2571
2582 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2583 _Outptr_ OrtTypeInfo** type_info);
2584
2588 ORT_CLASS_RELEASE(MapTypeInfo);
2592 ORT_CLASS_RELEASE(SequenceTypeInfo);
2593
2597
2608 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2609
2617 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2618
2622
2631 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2632 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2633
2642 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2643 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2644
2653 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2654 _Outptr_ char** value);
2655
2664 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2665 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2666
2677 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2678 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2679
2687 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2688
2689 ORT_CLASS_RELEASE(ModelMetadata);
2690
2694
2708 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2709 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2710
2714
2724 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2725
2729
2735 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2736
2737 ORT_CLASS_RELEASE(ThreadingOptions);
2738
2742
2754 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2755 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2756
2760
2768 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2769 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2770 _In_ int64_t dim_value);
2771
2775
2787 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2788
2797 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2798 _In_ int providers_length);
2799
2803
2812 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2813
2823 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2824
2833 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2834
2838
2851 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2852 _In_z_ const char* config_key, _In_z_ const char* config_value);
2853
2857
2868 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2869 _Outptr_ OrtAllocator** out);
2870
2873 ORT_CLASS_RELEASE(Allocator);
2874
2878
2889 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2890
2902 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2903
2907
2910 ORT_CLASS_RELEASE(IoBinding);
2911
2922 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2923
2934 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2935
2951 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2952
2970 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2971 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2972
2990 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2991 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2992
2995 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2996
2999 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
3000
3004
3019 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
3020
3024
3039 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
3040 _In_ const OrtArenaCfg* arena_cfg);
3041
3053 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
3054
3058
3068 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
3069
3073
3085 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
3086
3098 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
3099
3113 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
3114
3118
3133 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
3134 _In_ const OrtValue* val);
3135
3139
3155 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
3156 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
3157
3161
3172 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
3173
3184 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
3185
3196 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
3197
3201
3212 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
3213
3217
3230 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
3231 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
3232
3233 ORT_CLASS_RELEASE(ArenaCfg);
3234
3238
3250 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
3251 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
3252
3256
3267 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
3268
3272
3283 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
3284
3295 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
3296
3301
3324 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
3325 _Out_ float* out, _Inout_ size_t* size);
3326
3348 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
3349 _Out_ int64_t* out, _Inout_ size_t* size);
3350
3354
3386 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
3387 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
3388 _Outptr_ OrtArenaCfg** out);
3389
3393
3406 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
3407 _In_z_ const char* config_key, _In_z_ const char* config_value);
3408
3412
3426
3431 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
3432
3436
3454 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
3455 _In_ const OrtSessionOptions* options,
3456 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3457 _Outptr_ OrtSession** out);
3458
3477 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
3478 _In_ const void* model_data, size_t model_data_length,
3479 _In_ const OrtSessionOptions* options,
3480 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3481 _Outptr_ OrtSession** out);
3482
3486
3505 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
3506
3510
3518
3534 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
3535 _In_reads_(num_keys) const char* const* provider_options_keys,
3536 _In_reads_(num_keys) const char* const* provider_options_values,
3537 _In_ size_t num_keys);
3538
3550 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3551
3556 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
3557
3561
3568 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
3569
3573
3589 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3590
3601 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3602 _In_ const OrtMemoryInfo* mem_info);
3603
3607
3616 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3617
3634 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3635 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3636
3654 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3655 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3656 _In_ const int64_t* indices_data, size_t indices_num);
3657
3677 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3678 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3679 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3680 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3681
3700 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3701 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3702 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3703 _In_ const int32_t* indices_data);
3704
3729 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3730 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3731 _In_ const int64_t* values_shape, size_t values_shape_len,
3733
3748 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3749
3766 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3767 _Inout_ int64_t* outer_data, size_t outer_num);
3768
3782 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3783
3791 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3792
3800 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3801
3809 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3810
3820 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3821
3831 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3835
3848 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3849
3854
3866 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3867
3871
3877 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3878
3882
3892 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3893
3895
3898
3905 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3906
3914 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3915
3923 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3925
3928
3935 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3936
3944 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3945
3953 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3955
3964 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3965
3974 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3975
3978
3999 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
4000
4004
4013 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
4014
4032 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
4033 _In_reads_(num_keys) const char* const* provider_options_keys,
4034 _In_reads_(num_keys) const char* const* provider_options_values,
4035 _In_ size_t num_keys);
4036
4051 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4052
4059 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
4060
4062
4075 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
4076
4098 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
4099 _In_reads_(num_initializers) const char* const* initializer_names,
4100 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
4101
4113 ORT_API2_STATUS(CreateOpAttr,
4114 _In_ const char* name,
4115 _In_ const void* data,
4116 _In_ int len,
4117 _In_ OrtOpAttrType type,
4118 _Outptr_ OrtOpAttr** op_attr);
4119
4120 /* \brief: Release op attribute
4121 *
4122 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
4123 *
4124 * \since Version 1.12.
4125 */
4126 ORT_CLASS_RELEASE(OpAttr);
4127
4145 ORT_API2_STATUS(CreateOp,
4146 _In_ const OrtKernelInfo* info,
4147 _In_z_ const char* op_name,
4148 _In_z_ const char* domain,
4149 int version,
4150 _In_reads_(type_constraint_count) const char** type_constraint_names,
4151 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
4152 int type_constraint_count,
4153 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
4154 int attr_count,
4155 int input_count,
4156 int output_count,
4157 _Outptr_ OrtOp** ort_op);
4158
4171 ORT_API2_STATUS(InvokeOp,
4172 _In_ const OrtKernelContext* context,
4173 _In_ const OrtOp* ort_op,
4174 _In_ const OrtValue* const* input_values,
4175 _In_ int input_count,
4176 _Inout_ OrtValue* const* output_values,
4177 _In_ int output_count);
4178
4179 /* \brief: Release an onnxruntime operator
4180 *
4181 * \param[in] Op Operator created by OrtApi::CreateOp
4182 *
4183 * \since Version 1.12.
4184 */
4185 ORT_CLASS_RELEASE(Op);
4186
4309 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
4310 _In_ const char* provider_name,
4311 _In_reads_(num_keys) const char* const* provider_options_keys,
4312 _In_reads_(num_keys) const char* const* provider_options_values,
4313 _In_ size_t num_keys);
4314
4315 /* \brief: Get a copy of kernel info
4316 *
4317 * \param[in] info Kernel info
4318 * \param[out] info_copy Copy of kernel info
4319 *
4320 * \since Version 1.12.
4321 */
4322 ORT_API2_STATUS(CopyKernelInfo,
4323 _In_ const OrtKernelInfo* info,
4324 _Outptr_ OrtKernelInfo** info_copy);
4325
4326 /* \brief: Release kernel info
4327 *
4328 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
4329 *
4330 * \since Version 1.12.
4331 */
4332 ORT_CLASS_RELEASE(KernelInfo);
4333
4336
4350 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
4351
4353
4366 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
4367
4376 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
4377
4389 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
4390 _In_reads_(num_keys) const char* const* provider_options_keys,
4391 _In_reads_(num_keys) const char* const* provider_options_values,
4392 _In_ size_t num_keys);
4393
4407 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
4408 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4409
4416 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
4417
4418 /* \brief Get OrtDevice type from MemoryInfo
4419 *
4420 * \since Version 1.14
4421 */
4422 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
4423
4424 /* \brief Update the OrtEnv instance with custom log severity level
4425 *
4426 * \param[in] ort_env The OrtEnv instance being used
4427 * \param[in] log_severity_level The log severity level.
4428 *
4429 * \since Version 1.14.
4430 */
4431 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
4432
4433 /* \brief Set affinities for intra op threads
4434 *
4435 * Affinity string follows format:
4436 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
4437 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
4438 * e.g. 1,2,3;4,5
4439 * 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.
4440 * To ease the configuration, an "interval" is also allowed:
4441 * e.g. 1-8;8-16;17-24
4442 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
4443 * Note:
4444 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
4445 * ort does not set affinity on the main thread which is started and managed by the calling app;
4446 * 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,
4447 * 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.
4448 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
4449 *
4450 * \since Version 1.14
4451 */
4452 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
4453
4472 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
4473
4498 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
4499 _In_ const char* registration_func_name);
4500
4504
4516 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4517
4529 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4530
4555 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_opt_ char* out,
4556 _Inout_ size_t* size);
4557
4583 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_opt_ char* out,
4584 _Inout_ size_t* size);
4585
4598 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4599 _Outptr_ OrtTypeInfo** type_info);
4600
4613 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4614 _Outptr_ OrtTypeInfo** type_info);
4615
4628 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4629 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4630
4635
4651 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4652 _In_z_ const char* config_key, _Out_ int* out);
4653
4682 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4683 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4684
4686
4699 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4700
4709 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4710
4727 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4728 _In_reads_(num_keys) const char* const* provider_options_keys,
4729 _In_reads_(num_keys) const char* const* provider_options_values,
4730 _In_ size_t num_keys);
4731
4746 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4747
4752 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4753
4757
4780 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_opt_ char* out, _Inout_ size_t* size);
4781
4793 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4794
4799
4811 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4812
4817
4836 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4837 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4838 _In_z_ const char* func_name);
4839
4851 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4852
4854
4868 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4869
4890 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4891 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4892
4909 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4910 _Outptr_ OrtTypeInfo** out);
4911
4922 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4923
4934 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4935
4942 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4943
4946
4955 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4956
4974 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4975 _In_reads_(num_keys) const char* const* provider_options_keys,
4976 _In_reads_(num_keys) const char* const* provider_options_values,
4977 _In_ size_t num_keys);
4978
4993 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4994
5001 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
5002
5016 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type,
5017 _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
5018 _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);
5019
5038 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
5039 _In_reads_(input_len) const char* const* input_names,
5040 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
5041 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
5042 _Inout_updates_all_(output_names_len) OrtValue** output,
5043 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
5044
5057 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
5058
5069 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
5070
5083 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
5084
5095 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
5096
5108 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
5109 _In_ int resource_id, _Outptr_ void** resource);
5110
5128 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
5129 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
5130
5139 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
5140
5150 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
5151
5161 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
5162
5172 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
5173
5183 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
5184
5198 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
5199
5210 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
5211
5223 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);
5224
5239 _In_ OrtSessionOptions* options,
5240 _In_reads_(num_keys) const char* const* provider_options_keys,
5241 _In_reads_(num_keys) const char* const* provider_options_values,
5242 _In_ size_t num_keys);
5243
5258 _In_ OrtSessionOptions* options,
5259 _In_reads_(num_keys) const char* const* provider_options_keys,
5260 _In_reads_(num_keys) const char* const* provider_options_values,
5261 _In_ size_t num_keys);
5262
5274 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
5275
5286 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
5287
5309 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
5310 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
5311 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
5312 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
5313 size_t num_external_initializer_files);
5314
5333 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
5334 _Outptr_ OrtLoraAdapter** out);
5335
5353 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
5354 _Outptr_ OrtLoraAdapter** out);
5355
5358 ORT_CLASS_RELEASE(LoraAdapter);
5359
5376 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
5377
5381
5396 ORT_API2_STATUS(SetEpDynamicOptions, _Inout_ OrtSession* sess, _In_reads_(kv_len) const char* const* keys,
5397 _In_reads_(kv_len) const char* const* values, _In_ size_t kv_len);
5398
5400
5404 ORT_CLASS_RELEASE(ValueInfo);
5405
5409 ORT_CLASS_RELEASE(Node);
5410
5415 ORT_CLASS_RELEASE(Graph);
5416
5421 ORT_CLASS_RELEASE(Model);
5422
5429 ORT_API2_STATUS(GetValueInfoName, _In_ const OrtValueInfo* value_info, _Out_ const char** name);
5430
5437 ORT_API2_STATUS(GetValueInfoTypeInfo, _In_ const OrtValueInfo* value_info, _Outptr_ const OrtTypeInfo** type_info);
5438
5447 const OrtModelEditorApi*(ORT_API_CALL* GetModelEditorApi)(void);
5448
5467 ORT_API2_STATUS(CreateTensorWithDataAndDeleterAsOrtValue, _In_ OrtAllocator* deleter,
5468 _In_ void* p_data, size_t p_data_len,
5469 _In_ const int64_t* shape, size_t shape_len,
5471 _Outptr_ OrtValue** out);
5472
5489 ORT_API2_STATUS(SessionOptionsSetLoadCancellationFlag, _Inout_ OrtSessionOptions* options,
5490 _In_ bool cancel);
5491
5505 const OrtCompileApi*(ORT_API_CALL* GetCompileApi)(void);
5506
5507 //
5508 // OrtKeyValuePairs
5509 //
5510
5519 void(ORT_API_CALL* CreateKeyValuePairs)(_Outptr_ OrtKeyValuePairs** out);
5520
5534 void(ORT_API_CALL* AddKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key, _In_ const char* value);
5535
5545 const char*(ORT_API_CALL* GetKeyValue)(_In_ const OrtKeyValuePairs* kvps, _In_ const char* key);
5546
5556 void(ORT_API_CALL* GetKeyValuePairs)(_In_ const OrtKeyValuePairs* kvps,
5557 _Outptr_ const char* const** keys, _Outptr_ const char* const** values,
5558 _Out_ size_t* num_entries);
5559
5567 void(ORT_API_CALL* RemoveKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key);
5568
5575 ORT_CLASS_RELEASE(KeyValuePairs);
5576
5590 ORT_API2_STATUS(RegisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name,
5591 _In_ const ORTCHAR_T* path);
5592
5607 ORT_API2_STATUS(UnregisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name);
5608
5621 ORT_API2_STATUS(GetEpDevices, _In_ const OrtEnv* env,
5622 _Outptr_ const OrtEpDevice* const** ep_devices, _Out_ size_t* num_ep_devices);
5623
5643 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_V2, _In_ OrtSessionOptions* session_options,
5644 _In_ OrtEnv* env,
5645 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices, _In_ size_t num_ep_devices,
5646 _In_reads_(num_op_options) const char* const* ep_option_keys,
5647 _In_reads_(num_op_options) const char* const* ep_option_vals,
5648 size_t num_ep_options);
5649
5660 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicy, _In_ OrtSessionOptions* session_options,
5662
5673 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicyDelegate, _In_ OrtSessionOptions* session_options,
5674 _In_ EpSelectionDelegate delegate,
5675 _In_opt_ void* delegate_state);
5676
5685
5693 uint32_t(ORT_API_CALL* HardwareDevice_VendorId)(_In_ const OrtHardwareDevice* device);
5694
5702 const char*(ORT_API_CALL* HardwareDevice_Vendor)(_In_ const OrtHardwareDevice* device);
5703
5712 uint32_t(ORT_API_CALL* HardwareDevice_DeviceId)(_In_ const OrtHardwareDevice* device);
5713
5722 const OrtKeyValuePairs*(ORT_API_CALL* HardwareDevice_Metadata)(_In_ const OrtHardwareDevice* device);
5723
5731 const char*(ORT_API_CALL* EpDevice_EpName)(_In_ const OrtEpDevice* ep_device);
5732
5740 const char*(ORT_API_CALL* EpDevice_EpVendor)(_In_ const OrtEpDevice* ep_device);
5741
5749 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpMetadata)(_In_ const OrtEpDevice* ep_device);
5750
5758 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpOptions)(_In_ const OrtEpDevice* ep_device);
5759
5767 const OrtHardwareDevice*(ORT_API_CALL* EpDevice_Device)(_In_ const OrtEpDevice* ep_device);
5768
5773 const OrtEpApi*(ORT_API_CALL* GetEpApi)(void);
5774
5788 ORT_API2_STATUS(GetTensorSizeInBytes, _In_ const OrtValue* ort_value, _Out_ size_t* size);
5789
5804 ORT_API2_STATUS(AllocatorGetStats, _In_ const OrtAllocator* ort_allocator, _Outptr_ OrtKeyValuePairs** out);
5805
5826 ORT_API2_STATUS(CreateMemoryInfo_V2, _In_ const char* name, _In_ enum OrtMemoryInfoDeviceType device_type,
5827 _In_ uint32_t vendor_id, _In_ int32_t device_id, _In_ enum OrtDeviceMemoryType mem_type,
5828 _In_ size_t alignment, enum OrtAllocatorType allocator_type,
5829 _Outptr_ OrtMemoryInfo** out);
5830
5839
5847 ORT_API_T(uint32_t, MemoryInfoGetVendorId, _In_ const OrtMemoryInfo* ptr);
5848
5851
5862 ORT_API2_STATUS(ValueInfo_GetValueProducer, _In_ const OrtValueInfo* value_info,
5863 _Outptr_ const OrtNode** producer_node, _Out_opt_ size_t* producer_output_index);
5864
5880 ORT_API2_STATUS(ValueInfo_GetValueNumConsumers, _In_ const OrtValueInfo* value_info, _Out_ size_t* num_consumers);
5881
5908 ORT_API2_STATUS(ValueInfo_GetValueConsumers, _In_ const OrtValueInfo* value_info,
5909 _Out_writes_all_(num_consumers) const OrtNode** nodes,
5910 _Out_writes_all_(num_consumers) int64_t* input_indices,
5911 _In_ size_t num_consumers);
5912
5932 ORT_API2_STATUS(ValueInfo_GetInitializerValue, _In_ const OrtValueInfo* value_info,
5933 _Outptr_ const OrtValue** initializer_value);
5934
5950 ORT_API2_STATUS(ValueInfo_GetExternalInitializerInfo, _In_ const OrtValueInfo* value_info,
5951 _Outptr_result_maybenull_ OrtExternalInitializerInfo** info);
5952
5967 ORT_API2_STATUS(ValueInfo_IsRequiredGraphInput, _In_ const OrtValueInfo* value_info,
5968 _Out_ bool* is_required_graph_input);
5969
5983 ORT_API2_STATUS(ValueInfo_IsOptionalGraphInput, _In_ const OrtValueInfo* value_info,
5984 _Out_ bool* is_optional_graph_input);
5985
5995 ORT_API2_STATUS(ValueInfo_IsGraphOutput, _In_ const OrtValueInfo* value_info, _Out_ bool* is_graph_output);
5996
6011 ORT_API2_STATUS(ValueInfo_IsConstantInitializer, _In_ const OrtValueInfo* value_info,
6012 _Out_ bool* is_constant_initializer);
6013
6027 ORT_API2_STATUS(ValueInfo_IsFromOuterScope, _In_ const OrtValueInfo* value_info,
6028 _Out_ bool* is_from_outer_scope);
6029
6031
6034
6044 ORT_API2_STATUS(Graph_GetName, _In_ const OrtGraph* graph, _Outptr_ const char** graph_name);
6045
6059 ORT_API2_STATUS(Graph_GetModelPath, _In_ const OrtGraph* graph, _Outptr_ const ORTCHAR_T** model_path);
6060
6070 ORT_API2_STATUS(Graph_GetOnnxIRVersion, _In_ const OrtGraph* graph, _Out_ int64_t* onnx_ir_version);
6071
6085 ORT_API2_STATUS(Graph_GetNumOperatorSets, _In_ const OrtGraph* graph, _Out_ size_t* num_operator_sets);
6086
6107 ORT_API2_STATUS(Graph_GetOperatorSets, _In_ const OrtGraph* graph,
6108 _Out_writes_(num_operator_sets) const char** domains,
6109 _Out_writes_(num_operator_sets) int64_t* opset_versions, _In_ size_t num_operator_sets);
6110
6122 ORT_API2_STATUS(Graph_GetNumInputs, _In_ const OrtGraph* graph, _Out_ size_t* num_inputs);
6123
6138 ORT_API2_STATUS(Graph_GetInputs, _In_ const OrtGraph* graph,
6139 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6140
6150 ORT_API2_STATUS(Graph_GetNumOutputs, _In_ const OrtGraph* graph, _Out_ size_t* num_outputs);
6151
6164 ORT_API2_STATUS(Graph_GetOutputs, _In_ const OrtGraph* graph,
6165 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6166
6178 ORT_API2_STATUS(Graph_GetNumInitializers, _In_ const OrtGraph* graph, _Out_ size_t* num_initializers);
6179
6201 ORT_API2_STATUS(Graph_GetInitializers, _In_ const OrtGraph* graph,
6202 _Out_writes_(num_initializers) const OrtValueInfo** initializers,
6203 _In_ size_t num_initializers);
6204
6214 ORT_API2_STATUS(Graph_GetNumNodes, _In_ const OrtGraph* graph, _Out_ size_t* num_nodes);
6215
6231 ORT_API2_STATUS(Graph_GetNodes, _In_ const OrtGraph* graph,
6232 _Out_writes_(num_nodes) const OrtNode** nodes, _In_ size_t num_nodes);
6233
6247 ORT_API2_STATUS(Graph_GetParentNode, _In_ const OrtGraph* graph, _Outptr_result_maybenull_ const OrtNode** node);
6248
6264 ORT_API2_STATUS(Graph_GetGraphView, _In_ const OrtGraph* src_graph, _In_ const OrtNode** nodes,
6265 _In_ size_t num_nodes, _Outptr_ OrtGraph** dst_graph);
6266
6268
6271
6284 ORT_API2_STATUS(Node_GetId, _In_ const OrtNode* node, _Out_ size_t* node_id);
6285
6295 ORT_API2_STATUS(Node_GetName, _In_ const OrtNode* node, _Outptr_ const char** node_name);
6296
6306 ORT_API2_STATUS(Node_GetOperatorType, _In_ const OrtNode* node, _Outptr_ const char** operator_type);
6307
6317 ORT_API2_STATUS(Node_GetDomain, _In_ const OrtNode* node, _Outptr_ const char** domain_name);
6318
6328 ORT_API2_STATUS(Node_GetSinceVersion, _In_ const OrtNode* node, _Out_ int* since_version);
6329
6339 ORT_API2_STATUS(Node_GetNumInputs, _In_ const OrtNode* node, _Out_ size_t* num_inputs);
6340
6353 ORT_API2_STATUS(Node_GetInputs, _In_ const OrtNode* node,
6354 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6355
6365 ORT_API2_STATUS(Node_GetNumOutputs, _In_ const OrtNode* node, _Out_ size_t* num_outputs);
6366
6379 ORT_API2_STATUS(Node_GetOutputs, _In_ const OrtNode* node,
6380 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6381
6395 ORT_API2_STATUS(Node_GetNumImplicitInputs, _In_ const OrtNode* node, _Out_ size_t* num_implicit_inputs);
6396
6414 ORT_API2_STATUS(Node_GetImplicitInputs, _In_ const OrtNode* node,
6415 _Out_writes_(num_implicit_inputs) const OrtValueInfo** implicit_inputs,
6416 _In_ size_t num_implicit_inputs);
6417
6427 ORT_API2_STATUS(Node_GetNumAttributes, _In_ const OrtNode* node, _Out_ size_t* num_attributes);
6428
6446 ORT_API2_STATUS(Node_GetAttributes, _In_ const OrtNode* node,
6447 _Out_writes_(num_attributes) const OrtOpAttr** attributes, _In_ size_t num_attributes);
6448
6467 ORT_API2_STATUS(Node_GetAttributeByName, _In_ const OrtNode* node, _In_ const char* attribute_name,
6468 _Outptr_result_maybenull_ const OrtOpAttr** attribute);
6469
6480 ORT_API2_STATUS(OpAttr_GetTensorAttributeAsOrtValue, _In_ const OrtOpAttr* attribute,
6481 _Outptr_result_maybenull_ OrtValue** attr_tensor);
6482
6492 ORT_API2_STATUS(OpAttr_GetType, _In_ const OrtOpAttr* attribute, _Out_ OrtOpAttrType* type);
6493
6503 ORT_API2_STATUS(OpAttr_GetName, _In_ const OrtOpAttr* attribute, _Outptr_ const char** name);
6504
6516 ORT_API2_STATUS(Node_GetNumSubgraphs, _In_ const OrtNode* node, _Out_ size_t* num_subgraphs);
6517
6535 ORT_API2_STATUS(Node_GetSubgraphs, _In_ const OrtNode* node,
6536 _Out_writes_(num_subgraphs) const OrtGraph** subgraphs, _In_ size_t num_subgraphs,
6537 _Out_writes_opt_(num_subgraphs) const char** attribute_names);
6538
6554 ORT_API2_STATUS(Node_GetGraph, _In_ const OrtNode* node, _Outptr_result_maybenull_ const OrtGraph** graph);
6555
6567 ORT_API2_STATUS(Node_GetEpName, _In_ const OrtNode* node, _Outptr_result_maybenull_ const char** out);
6568
6570
6573
6580 ORT_CLASS_RELEASE(ExternalInitializerInfo);
6581
6593 ORT_API_T(const ORTCHAR_T*, ExternalInitializerInfo_GetFilePath, _In_ const OrtExternalInitializerInfo* info);
6594
6603
6612
6614
6617
6632 ORT_API_T(const char*, GetRunConfigEntry, _In_ const OrtRunOptions* options,
6633 _In_z_ const char* config_key);
6634
6636
6646 ORT_API_T(const OrtMemoryInfo*, EpDevice_MemoryInfo, _In_ const OrtEpDevice* ep_device,
6647 _In_ OrtDeviceMemoryType memory_type);
6648
6672 ORT_API2_STATUS(CreateSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6673 _In_ OrtDeviceMemoryType mem_type, _In_ OrtAllocatorType allocator_type,
6674 _In_opt_ const OrtKeyValuePairs* allocator_options,
6675 _Outptr_opt_ OrtAllocator** allocator);
6676
6695 ORT_API2_STATUS(GetSharedAllocator, _In_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
6696 _Outptr_result_maybenull_ OrtAllocator** allocator);
6697
6711 ORT_API2_STATUS(ReleaseSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6712 _In_ OrtDeviceMemoryType mem_type);
6713
6726 ORT_API2_STATUS(GetTensorData, _In_ const OrtValue* value, _Outptr_ const void** out);
6727
6738 ORT_API2_STATUS(GetSessionOptionsConfigEntries, _In_ const OrtSessionOptions* options, _Outptr_ OrtKeyValuePairs** out);
6739
6757 ORT_API2_STATUS(SessionGetMemoryInfoForInputs, _In_ const OrtSession* session,
6758 _Out_writes_(num_inputs) const OrtMemoryInfo** inputs_memory_info,
6759 _In_ size_t num_inputs);
6760
6780 ORT_API2_STATUS(SessionGetMemoryInfoForOutputs, _In_ const OrtSession* session,
6781 _Out_writes_(num_outputs) const OrtMemoryInfo** outputs_memory_info,
6782 _In_ size_t num_outputs);
6783
6808 ORT_API2_STATUS(SessionGetEpDeviceForInputs, _In_ const OrtSession* session,
6809 _Out_writes_(num_inputs) const OrtEpDevice** inputs_ep_devices,
6810 _In_ size_t num_inputs);
6811
6827 ORT_API2_STATUS(CreateSyncStreamForEpDevice, _In_ const OrtEpDevice* ep_device,
6828 _In_opt_ const OrtKeyValuePairs* stream_options,
6829 _Outptr_ OrtSyncStream** stream);
6830
6841 ORT_API_T(void*, SyncStream_GetHandle, _In_ OrtSyncStream* stream);
6842
6843 ORT_CLASS_RELEASE(SyncStream);
6844
6869 ORT_API2_STATUS(CopyTensors, _In_ const OrtEnv* env,
6870 _In_reads_(num_tensors) const OrtValue* const* src_tensors,
6871 _In_reads_(num_tensors) OrtValue* const* dst_tensors,
6872 _In_opt_ OrtSyncStream* stream,
6873 _In_ size_t num_tensors);
6874
6884 ORT_API2_STATUS(Graph_GetModelMetadata, _In_ const OrtGraph* graph, _Outptr_ OrtModelMetadata** out);
6885
6898 ORT_API2_STATUS(GetModelCompatibilityForEpDevices,
6899 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices,
6900 _In_ size_t num_ep_devices,
6901 _In_ const char* compatibility_info,
6903
6906
6919 ORT_API2_STATUS(CreateExternalInitializerInfo, _In_ const ORTCHAR_T* filepath, _In_ int64_t file_offset,
6920 _In_ size_t byte_size, _Outptr_ OrtExternalInitializerInfo** out);
6921
6923
6929 ORT_API_T(bool, TensorTypeAndShape_HasShape, _In_ const OrtTensorTypeAndShapeInfo* info);
6930
6946 ORT_API2_STATUS(KernelInfo_GetConfigEntries, _In_ const OrtKernelInfo* info, _Outptr_ OrtKeyValuePairs** out);
6947
6969 ORT_API2_STATUS(KernelInfo_GetOperatorDomain, _In_ const OrtKernelInfo* info, _Out_opt_ char* out,
6970 _Inout_ size_t* size);
6971
6993 ORT_API2_STATUS(KernelInfo_GetOperatorType, _In_ const OrtKernelInfo* info, _Out_opt_ char* out,
6994 _Inout_ size_t* size);
6995
7004 ORT_API2_STATUS(KernelInfo_GetOperatorSinceVersion, _In_ const OrtKernelInfo* info,
7005 _Out_ int* since_version);
7006
7017 const OrtInteropApi*(ORT_API_CALL* GetInteropApi)(void);
7018
7040 ORT_API2_STATUS(SessionGetEpDeviceForOutputs, _In_ const OrtSession* session,
7041 _Out_writes_(num_outputs) const OrtEpDevice** outputs_ep_devices,
7042 _In_ size_t num_outputs);
7055 ORT_API2_STATUS(GetNumHardwareDevices, _In_ const OrtEnv* env, _Out_ size_t* num_devices);
7056
7076 ORT_API2_STATUS(GetHardwareDevices, _In_ const OrtEnv* env,
7077 _Out_writes_(num_devices) const OrtHardwareDevice** devices,
7078 _In_ size_t num_devices);
7079
7101 ORT_API2_STATUS(GetHardwareDeviceEpIncompatibilityDetails, _In_ const OrtEnv* env,
7102 _In_ const char* ep_name,
7103 _In_ const OrtHardwareDevice* hw,
7105
7109
7120 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7121 _Out_ uint32_t* reasons_bitmask);
7122
7134 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7135 _Outptr_result_maybenull_ const char** notes);
7136
7150 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7151 _Out_ int32_t* error_code);
7152
7157 ORT_CLASS_RELEASE(DeviceEpIncompatibilityDetails);
7158
7160
7163
7195 ORT_API2_STATUS(GetCompatibilityInfoFromModel,
7196 _In_ const ORTCHAR_T* model_path,
7197 _In_ const char* ep_type,
7198 _Inout_ OrtAllocator* allocator,
7199 _Outptr_result_maybenull_ char** compatibility_info);
7200
7223 ORT_API2_STATUS(GetCompatibilityInfoFromModelBytes,
7224 _In_reads_(model_data_length) const void* model_data,
7225 _In_ size_t model_data_length,
7226 _In_ const char* ep_type,
7227 _Inout_ OrtAllocator* allocator,
7228 _Outptr_result_maybenull_ char** compatibility_info);
7229
7231
7244 ORT_API2_STATUS(CreateEnvWithOptions, _In_ const OrtEnvCreationOptions* options, _Outptr_ OrtEnv** out);
7245
7275 ORT_API2_STATUS(Session_GetEpGraphAssignmentInfo, _In_ const OrtSession* session,
7276 _Outptr_ const OrtEpAssignedSubgraph* const** ep_subgraphs,
7277 _Out_ size_t* num_ep_subgraphs);
7278
7289 ORT_API2_STATUS(EpAssignedSubgraph_GetEpName, _In_ const OrtEpAssignedSubgraph* ep_subgraph,
7290 _Outptr_ const char** out);
7291
7302 ORT_API2_STATUS(EpAssignedSubgraph_GetNodes, _In_ const OrtEpAssignedSubgraph* ep_subgraph,
7303 _Outptr_ const OrtEpAssignedNode* const** ep_nodes, _Out_ size_t* num_ep_nodes);
7304
7315 ORT_API2_STATUS(EpAssignedNode_GetName, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7316
7327 ORT_API2_STATUS(EpAssignedNode_GetDomain, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7328
7339 ORT_API2_STATUS(EpAssignedNode_GetOperatorType, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7340
7352 ORT_API_T(void, RunOptionsSetSyncStream, _Inout_ OrtRunOptions* options, _In_ OrtSyncStream* sync_stream);
7353
7374 ORT_API2_STATUS(GetTensorElementTypeAndShapeDataReference, _In_ const OrtValue* value,
7375 _Out_ ONNXTensorElementDataType* elem_type,
7376 _Outptr_result_maybenull_ const int64_t** shape_data,
7377 _Out_ size_t* shape_data_count);
7378
7389 ORT_API2_STATUS(RunOptionsEnableProfiling, _Inout_ OrtRunOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
7390
7399 ORT_API2_STATUS(RunOptionsDisableProfiling, _Inout_ OrtRunOptions* options);
7400
7420 ORT_API2_STATUS(KernelInfoGetAttributeArray_string, _In_ const OrtKernelInfo* info, _In_ const char* name,
7421 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*size) char*** out, _Out_ size_t* size);
7422
7425
7444 ORT_API2_STATUS(SetPerSessionThreadPoolCallbacks, _Inout_ OrtEnv* env,
7445 _In_ const OrtThreadPoolCallbacksConfig* config);
7446
7448
7460 ORT_API2_STATUS(GetMemPatternEnabled, _In_ const OrtSessionOptions* options, _Out_ int* out);
7461
7473 ORT_API2_STATUS(GetSessionExecutionMode, _In_ const OrtSessionOptions* options, _Out_ ExecutionMode* out);
7474
7488 ORT_API2_STATUS(SessionReleaseCapturedGraph, _In_ OrtSession* session, _In_ int graph_annotation_id);
7489};
7490
7491/*
7492 * Steps to use a custom op:
7493 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
7494 * 2 Create an OrtCustomOp structure for each op and add them to the domain
7495 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
7496 */
7497
7498// Specifies some characteristics of inputs/outputs of custom ops:
7499// Specify if the inputs/outputs are one of:
7500// 1) Non-optional (input/output must be present in the node)
7501// 2) Optional (input/output may be absent in the node)
7502// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
7503// Only the last input or output of a custom op may be marked as variadic.
7504// The homogeneity of the variadic input or output determines whether all operands must be of the same
7505// tensor element type.
7511
7512/*
7513 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
7514 * the implementor of the custom op.
7515 */
7517 uint32_t version; // Must be initialized to ORT_API_VERSION
7518
7519 // This callback creates the kernel, which is a user defined
7520 // parameter that is passed to the Kernel* callbacks below. It is
7521 // recommended to use CreateKernelV2 which allows for a safe error
7522 // propagation by returning an OrtStatusPtr.
7523 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
7524 _In_ const OrtKernelInfo* info);
7525
7526 // Returns the name of the op
7527 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
7528
7529 // Returns the type of the execution provider, return nullptr to use CPU execution provider
7530 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
7531
7532 // Returns the count and types of the input & output tensors
7533 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7534 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
7535 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7536 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
7537
7538 // Perform a computation step. It is recommended to use
7539 // KernelComputeV2 which allows for a safe error propagation by
7540 // returning an OrtStatusPtr.
7541 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
7542 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
7543
7544 // Returns the characteristics of the input & output tensors
7545 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7546 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7547
7548 // Returns the memory type of the input tensors. This API allows the custom op
7549 // to place the inputs on specific devices. By default, it returns
7550 // OrtMemTypeDefault, which means the input is placed on the default device for
7551 // the execution provider. If the inputs need to be with different memory types,
7552 // this function can be overridden to return the specific memory types.
7553 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7554
7555 // Returns the minimum number of input arguments expected for the variadic input.
7556 // Applicable only for custom ops that have a variadic input.
7557 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
7558
7559 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
7560 // and false (zero) otherwise.
7561 // Applicable only for custom ops that have a variadic input.
7562 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
7563
7564 // Returns the minimum number of output values expected for the variadic output.
7565 // Applicable only for custom ops that have a variadic output.
7566 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
7567
7568 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
7569 // and false (zero) otherwise.
7570 // Applicable only for custom ops that have a variadic output.
7571 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
7572
7573 // Create the kernel state which is passed to each compute call.
7574 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
7575 _In_ const OrtKernelInfo* info,
7576 _Out_ void** kernel);
7577
7578 // Perform the computation step.
7579 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
7580
7581 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
7582
7583 // Get start range
7584 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
7585 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
7586
7587 // Get the inplace_map that defines which output can reuse which input
7588 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
7589 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
7590 // The return value is the size of these 2 arrays.
7591 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
7592 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
7593
7594 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
7595 // If GetMayInplace() is defined, this function MUST be defined as well.
7596 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
7597
7598 // Same as GetMayInplace() and ReleaseMayInplace()
7599 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
7600 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
7601};
7602
7615 // Model building/editing requires a full build. We return nullptr from GetModelEditorApi if this is a minimal
7616 // build, so it doesn't matter if there are no function pointers in this struct as a user will never get an
7617 // OrtModelEditorApi instance. We do however need a dummy field to avoid empty struct warning.
7618#if defined(ORT_MINIMAL_BUILD)
7619 const bool not_defined_in_this_build;
7620#else
7634 ORT_API2_STATUS(CreateTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
7635 _Outptr_ OrtTypeInfo** type_info);
7636
7650 ORT_API2_STATUS(CreateSparseTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
7651 _Outptr_ OrtTypeInfo** type_info);
7652
7667 ORT_API2_STATUS(CreateMapTypeInfo, ONNXTensorElementDataType map_key_type, _In_ const OrtTypeInfo* map_value_type,
7668 _Outptr_ OrtTypeInfo** type_info);
7669
7683 ORT_API2_STATUS(CreateSequenceTypeInfo, _In_ const OrtTypeInfo* sequence_type, _Outptr_ OrtTypeInfo** type_info);
7684
7698 ORT_API2_STATUS(CreateOptionalTypeInfo, _In_ const OrtTypeInfo* contained_type, _Outptr_ OrtTypeInfo** type_info);
7699
7710 ORT_API2_STATUS(CreateValueInfo, _In_ const char* name, _In_ const OrtTypeInfo* type_info,
7711 _Outptr_ OrtValueInfo** value_info);
7712
7734 ORT_API2_STATUS(CreateNode, _In_ const char* operator_name, _In_ const char* domain_name, _In_ const char* node_name,
7735 _In_reads_(input_names_len) const char* const* input_names, size_t input_names_len,
7736 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
7737 _In_reads_(attribs_len) _In_opt_ OrtOpAttr** attributes, _In_ size_t attribs_len,
7738 _Outptr_ OrtNode** node);
7739
7744 ORT_API2_STATUS(CreateGraph, _Outptr_ OrtGraph** graph);
7745
7759 ORT_API2_STATUS(SetGraphInputs, _Inout_ OrtGraph* graph,
7760 _In_reads_(inputs_len) _In_ OrtValueInfo** inputs, _In_ size_t inputs_len);
7761
7775 ORT_API2_STATUS(SetGraphOutputs, _Inout_ OrtGraph* graph,
7776 _In_reads_(outputs_len) _In_ OrtValueInfo** outputs, _In_ size_t outputs_len);
7777
7819 ORT_API2_STATUS(AddInitializerToGraph, _Inout_ OrtGraph* graph, _In_ const char* name,
7820 _In_ const OrtValue* ort_value, bool data_is_external);
7821
7833 ORT_API2_STATUS(AddNodeToGraph, _Inout_ OrtGraph* graph, _In_ OrtNode* node);
7834
7853 ORT_API2_STATUS(CreateModel,
7854 _In_reads_(opset_entries_len) const char* const* domain_names,
7855 _In_reads_(opset_entries_len) const int* opset_versions,
7856 size_t opset_entries_len,
7857 _Outptr_ OrtModel** model);
7858
7872 ORT_API2_STATUS(AddGraphToModel, _Inout_ OrtModel* model, _In_ OrtGraph* graph);
7873
7892 ORT_API2_STATUS(CreateSessionFromModel, _In_ const OrtEnv* env, _In_ const OrtModel* model,
7893 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
7894
7917 ORT_API2_STATUS(CreateModelEditorSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
7918 _In_ const OrtSessionOptions* options,
7919 _Outptr_ OrtSession** out);
7920
7945 ORT_API2_STATUS(CreateModelEditorSessionFromArray, _In_ const OrtEnv* env,
7946 _In_ const void* model_data, size_t model_data_length,
7947 _In_ const OrtSessionOptions* options,
7948 _Outptr_ OrtSession** out);
7949
7964 ORT_API2_STATUS(SessionGetOpsetForDomain, _In_ const OrtSession* session, _In_ const char* domain, _Out_ int* opset);
7965
7984 ORT_API2_STATUS(ApplyModelToModelEditorSession, _Inout_ OrtSession* session, _In_ OrtModel* model);
7985
7999 ORT_API2_STATUS(FinalizeModelEditorSession, _Inout_ OrtSession* session, _In_ const OrtSessionOptions* options,
8000 _In_opt_ OrtPrepackedWeightsContainer* prepacked_weights_container);
8001#endif // !defined(ORT_MINIMAL_BUILD)
8002};
8003
8011 // Default. Do not enable any additional compilation options.
8013
8014 // Force compilation to return an error (ORT_FAIL) if no nodes were compiled.
8015 // Otherwise, a model with basic optimizations (ORT_ENABLE_BASIC) is still generated by default.
8017
8018 // Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists.
8019 // Otherwise, compilation will automatically overwrite the output file if it exists.
8022
8049 ORT_CLASS_RELEASE(ModelCompilationOptions);
8050
8069 ORT_API2_STATUS(CreateModelCompilationOptionsFromSessionOptions, _In_ const OrtEnv* env,
8070 _In_ const OrtSessionOptions* session_options, _Outptr_ OrtModelCompilationOptions** out);
8071
8084 ORT_API2_STATUS(ModelCompilationOptions_SetInputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
8085 _In_ const ORTCHAR_T* input_model_path);
8086
8101 _In_ OrtModelCompilationOptions* model_compile_options,
8102 _In_ const void* input_model_data,
8103 size_t input_model_data_size);
8104
8122 ORT_API2_STATUS(ModelCompilationOptions_SetOutputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
8123 _In_ const ORTCHAR_T* output_model_path);
8124
8141 _In_ OrtModelCompilationOptions* model_compile_options,
8142 _In_ const ORTCHAR_T* external_initializers_file_path,
8143 size_t external_initializers_size_threshold);
8144
8167 _In_ OrtModelCompilationOptions* model_compile_options,
8168 _Inout_ OrtAllocator* allocator,
8169 _Outptr_ void** output_model_buffer_ptr,
8170 _Out_ size_t* output_model_buffer_size_ptr);
8171
8194 ORT_API2_STATUS(ModelCompilationOptions_SetEpContextEmbedMode, _In_ OrtModelCompilationOptions* model_compile_options,
8195 bool embed_ep_context_in_model);
8196
8206 ORT_API2_STATUS(CompileModel, _In_ const OrtEnv* env, _In_ const OrtModelCompilationOptions* model_options);
8207
8217 ORT_API2_STATUS(ModelCompilationOptions_SetFlags, _In_ OrtModelCompilationOptions* model_compile_options,
8218 uint32_t flags);
8219
8234 _In_ OrtModelCompilationOptions* model_compile_options,
8235 _In_ const ORTCHAR_T* output_directory,
8236 _In_ const ORTCHAR_T* model_name);
8237
8248 _In_ OrtModelCompilationOptions* model_compile_options,
8249 _In_ GraphOptimizationLevel graph_optimization_level);
8250
8269 _In_ OrtModelCompilationOptions* model_compile_options,
8270 _In_ OrtWriteBufferFunc write_func, _In_ void* state);
8271
8285 _In_ OrtModelCompilationOptions* model_compile_options,
8286 _In_ OrtGetInitializerLocationFunc get_initializer_location_func, _In_ void* state);
8287
8308 _In_ OrtModelCompilationOptions* model_compile_options,
8309 _In_ const OrtModel* model);
8310};
8311
8345
8365 _In_ const OrtEpDevice* ep_device,
8366 _Outptr_result_maybenull_ OrtExternalResourceImporter** out_importer);
8367
8374 ORT_CLASS_RELEASE(ExternalResourceImporter);
8375
8379
8390 ORT_API2_STATUS(CanImportMemory,
8391 _In_ const OrtExternalResourceImporter* importer,
8392 _In_ OrtExternalMemoryHandleType handle_type,
8393 _Out_ bool* out_supported);
8394
8406 ORT_API2_STATUS(ImportMemory,
8407 _In_ OrtExternalResourceImporter* importer,
8408 _In_ const OrtExternalMemoryDescriptor* desc,
8409 _Outptr_ OrtExternalMemoryHandle** out_handle);
8410
8417 ORT_CLASS_RELEASE(ExternalMemoryHandle);
8418
8434 ORT_API2_STATUS(CreateTensorFromMemory,
8435 _In_ OrtExternalResourceImporter* importer,
8436 _In_ const OrtExternalMemoryHandle* mem_handle,
8437 _In_ const OrtExternalTensorDescriptor* tensor_desc,
8438 _Outptr_ OrtValue** out_tensor);
8439
8443
8454 ORT_API2_STATUS(CanImportSemaphore,
8455 _In_ const OrtExternalResourceImporter* importer,
8456 _In_ OrtExternalSemaphoreType type,
8457 _Out_ bool* out_supported);
8458
8472 ORT_API2_STATUS(ImportSemaphore,
8473 _In_ OrtExternalResourceImporter* importer,
8474 _In_ const OrtExternalSemaphoreDescriptor* desc,
8475 _Outptr_ OrtExternalSemaphoreHandle** out_handle);
8476
8483 ORT_CLASS_RELEASE(ExternalSemaphoreHandle);
8484
8500 ORT_API2_STATUS(WaitSemaphore,
8501 _In_ OrtExternalResourceImporter* importer,
8502 _In_ OrtExternalSemaphoreHandle* semaphore_handle,
8503 _In_ OrtSyncStream* stream,
8504 _In_ uint64_t value);
8505
8521 ORT_API2_STATUS(SignalSemaphore,
8522 _In_ OrtExternalResourceImporter* importer,
8523 _In_ OrtExternalSemaphoreHandle* semaphore_handle,
8524 _In_ OrtSyncStream* stream,
8525 _In_ uint64_t value);
8526
8530
8552 ORT_API2_STATUS(InitGraphicsInteropForEpDevice, _In_ const OrtEpDevice* ep_device,
8553 _In_ const OrtGraphicsInteropConfig* config);
8554
8571 ORT_API2_STATUS(DeinitGraphicsInteropForEpDevice, _In_ const OrtEpDevice* ep_device);
8572
8574};
8575
8576/*
8577 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
8578 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
8579 *
8580 * \param device_id CUDA device id, starts from zero.
8581 */
8582ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
8583
8584/*
8585 * This is the old way to add the ROCm provider to the session, please use
8586 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
8587 * This function always exists, but will only succeed if Onnxruntime was built with
8588 * HIP support and the ROCm provider shared library exists
8589 *
8590 * \param device_id HIP device id, starts from zero.
8591 */
8592ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
8593
8594/*
8595 * This is the old way to add the MIGraphX provider to the session, please use
8596 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
8597 * This function always exists, but will only succeed if Onnxruntime was built with
8598 * HIP support and the MIGraphX provider shared library exists
8599 *
8600 * \param device_id HIP device id, starts from zero.
8601 */
8602ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
8603
8604/*
8605 * This is the old way to add the oneDNN provider to the session, please use
8606 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
8607 * This function always exists, but will only succeed if Onnxruntime was built with
8608 * oneDNN support and the oneDNN provider shared library exists
8609 *
8610 * \param use_arena zero: false. non-zero: true.
8611 */
8612ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
8613
8614/*
8615 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
8616 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
8617 *
8618 * \param device_id CUDA device id, starts from zero.
8619 */
8620ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
8621
8622#ifdef __cplusplus
8623}
8624#endif
8626
8627#include "onnxruntime_ep_c_api.h"
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:308
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:334
struct OrtHardwareDevice OrtHardwareDevice
Definition onnxruntime_c_api.h:340
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:484
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:336
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Tensorrt(OrtSessionOptions *options, int device_id)
struct OrtEpAssignedNode OrtEpAssignedNode
Definition onnxruntime_c_api.h:350
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:258
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:519
struct OrtModelCompilationOptions OrtModelCompilationOptions
Definition onnxruntime_c_api.h:339
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:333
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:448
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:985
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:1050
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:7506
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:325
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:331
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:322
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:316
OrtGraphicsApi
Graphics API type for interop configuration.
Definition onnxruntime_c_api.h:1121
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:473
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:335
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:329
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:247
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:324
OrtExternalMemoryHandleType
External memory handle type for importing GPU resources.
Definition onnxruntime_c_api.h:1067
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:310
OrtCompiledModelCompatibility
Definition onnxruntime_c_api.h:1198
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:573
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:319
OrtExternalSemaphoreType
External semaphore type for GPU synchronization.
Definition onnxruntime_c_api.h:1094
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:309
struct OrtExternalInitializerInfo OrtExternalInitializerInfo
Definition onnxruntime_c_api.h:344
OrtAllocatorType
Definition onnxruntime_c_api.h:490
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:330
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:320
OrtDeviceEpIncompatibilityReason
Reasons why an execution provider might not be compatible with a device.
Definition onnxruntime_c_api.h:546
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:313
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:314
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:327
void(* OrtThreadPoolWorkStartFn)(void *user_context, void *enqueue_data)
Thread pool work start callback.
Definition onnxruntime_c_api.h:1006
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:486
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:635
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:328
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:341
struct OrtExternalResourceImporter OrtExternalResourceImporter
Definition onnxruntime_c_api.h:345
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:1059
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:312
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:526
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:338
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:337
struct OrtSyncStream OrtSyncStream
Definition onnxruntime_c_api.h:343
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:967
struct OrtEpAssignedSubgraph OrtEpAssignedSubgraph
Definition onnxruntime_c_api.h:349
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:317
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:318
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:512
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:311
OrtStatus *(* OrtWriteBufferFunc)(void *state, const void *buffer, size_t buffer_num_bytes)
Function called by ORT to write a buffer to a custom destination (e.g., file, stream,...
Definition onnxruntime_c_api.h:592
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:457
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:342
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:355
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:500
OrtSparseFormat
Definition onnxruntime_c_api.h:239
ONNXType
Definition onnxruntime_c_api.h:227
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:306
OrtErrorCode
Definition onnxruntime_c_api.h:266
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:307
struct OrtDeviceEpIncompatibilityDetails OrtDeviceEpIncompatibilityDetails
Definition onnxruntime_c_api.h:348
OrtStatus *(* OrtGetInitializerLocationFunc)(void *state, const char *initializer_name, const OrtValue *initializer_value, const OrtExternalInitializerInfo *external_info, OrtExternalInitializerInfo **new_external_info)
Function called by ORT to allow user to specify how an initializer should be saved,...
Definition onnxruntime_c_api.h:626
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:332
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:315
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:323
ExecutionMode
Definition onnxruntime_c_api.h:465
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:284
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:978
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:191
OrtCompileApiFlags
Flags representing options to enable when compiling a model.
Definition onnxruntime_c_api.h:8010
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:534
void *(* OrtThreadPoolWorkEnqueueFn)(void *user_context)
Thread pool work enqueue callback.
Definition onnxruntime_c_api.h:996
void(* OrtThreadPoolWorkStopFn)(void *user_context, void *enqueue_data)
Thread pool work stop callback.
Definition onnxruntime_c_api.h:1017
void(* OrtThreadPoolWorkAbandonFn)(void *user_context, void *enqueue_data)
Thread pool work abandon callback.
Definition onnxruntime_c_api.h:1026
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:259
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition onnxruntime_c_api.h:260
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition onnxruntime_c_api.h:262
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:261
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition onnxruntime_c_api.h:263
@ OrtMemoryInfoDeviceType_GPU
Definition onnxruntime_c_api.h:521
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:522
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:520
@ OrtMemoryInfoDeviceType_NPU
Definition onnxruntime_c_api.h:523
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:7509
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:7507
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:7508
@ ORT_GRAPHICS_API_D3D12
Definition onnxruntime_c_api.h:1123
@ ORT_GRAPHICS_API_VULKAN
Definition onnxruntime_c_api.h:1124
@ ORT_GRAPHICS_API_NONE
Definition onnxruntime_c_api.h:1122
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:474
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:477
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:475
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:479
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:476
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:478
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:480
@ ORT_SPARSE_COO_INDICES
Definition onnxruntime_c_api.h:248
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition onnxruntime_c_api.h:251
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition onnxruntime_c_api.h:250
@ ORT_SPARSE_CSR_INNER_INDICES
Definition onnxruntime_c_api.h:249
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE
Definition onnxruntime_c_api.h:1068
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_VK_MEMORY_WIN32
Definition onnxruntime_c_api.h:1070
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP
Definition onnxruntime_c_api.h:1069
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_VK_MEMORY_OPAQUE_FD
Definition onnxruntime_c_api.h:1071
@ OrtCompiledModelCompatibility_EP_SUPPORTED_PREFER_RECOMPILATION
Definition onnxruntime_c_api.h:1201
@ OrtCompiledModelCompatibility_EP_NOT_APPLICABLE
Definition onnxruntime_c_api.h:1199
@ OrtCompiledModelCompatibility_EP_SUPPORTED_OPTIMAL
Definition onnxruntime_c_api.h:1200
@ OrtCompiledModelCompatibility_EP_UNSUPPORTED
Definition onnxruntime_c_api.h:1202
@ ORT_EXTERNAL_SEMAPHORE_VK_TIMELINE_SEMAPHORE_WIN32
Definition onnxruntime_c_api.h:1096
@ ORT_EXTERNAL_SEMAPHORE_VK_TIMELINE_SEMAPHORE_OPAQUE_FD
Definition onnxruntime_c_api.h:1097
@ ORT_EXTERNAL_SEMAPHORE_D3D12_FENCE
Definition onnxruntime_c_api.h:1095
@ OrtDeviceAllocator
Definition onnxruntime_c_api.h:492
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:493
@ OrtReadOnlyAllocator
Definition onnxruntime_c_api.h:494
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:491
@ OrtDeviceEpIncompatibility_DEVICE_INCOMPATIBLE
Definition onnxruntime_c_api.h:549
@ OrtDeviceEpIncompatibility_MISSING_DEPENDENCY
Definition onnxruntime_c_api.h:550
@ OrtDeviceEpIncompatibility_DRIVER_INCOMPATIBLE
Definition onnxruntime_c_api.h:548
@ OrtDeviceEpIncompatibility_NONE
Definition onnxruntime_c_api.h:547
@ OrtDeviceEpIncompatibility_UNKNOWN
Definition onnxruntime_c_api.h:551
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:638
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:636
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:637
@ OrtHardwareDeviceType_CPU
Definition onnxruntime_c_api.h:527
@ OrtHardwareDeviceType_NPU
Definition onnxruntime_c_api.h:529
@ OrtHardwareDeviceType_GPU
Definition onnxruntime_c_api.h:528
@ OrtDeviceMemoryType_HOST_ACCESSIBLE
Shared/pinned memory for transferring between CPU and the device.
Definition onnxruntime_c_api.h:514
@ OrtDeviceMemoryType_DEFAULT
Device memory.
Definition onnxruntime_c_api.h:513
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:459
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:462
@ ORT_ENABLE_LAYOUT
Definition onnxruntime_c_api.h:461
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:458
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:460
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:502
@ OrtMemTypeCPU
CPU accessible memory allocated by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:506
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:508
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:504
@ ORT_SPARSE_CSRC
Definition onnxruntime_c_api.h:242
@ ORT_SPARSE_COO
Definition onnxruntime_c_api.h:241
@ ORT_SPARSE_BLOCK_SPARSE
Definition onnxruntime_c_api.h:243
@ ORT_SPARSE_UNDEFINED
Definition onnxruntime_c_api.h:240
@ ONNX_TYPE_SEQUENCE
Definition onnxruntime_c_api.h:230
@ ONNX_TYPE_MAP
Definition onnxruntime_c_api.h:231
@ ONNX_TYPE_OPAQUE
Definition onnxruntime_c_api.h:232
@ ONNX_TYPE_UNKNOWN
Definition onnxruntime_c_api.h:228
@ ONNX_TYPE_TENSOR
Definition onnxruntime_c_api.h:229
@ ONNX_TYPE_SPARSETENSOR
Definition onnxruntime_c_api.h:233
@ ONNX_TYPE_OPTIONAL
Definition onnxruntime_c_api.h:234
@ ORT_MODEL_LOAD_CANCELED
Definition onnxruntime_c_api.h:279
@ ORT_NO_SUCHFILE
Definition onnxruntime_c_api.h:270
@ ORT_OK
Definition onnxruntime_c_api.h:267
@ ORT_INVALID_ARGUMENT
Definition onnxruntime_c_api.h:269
@ ORT_EP_FAIL
Definition onnxruntime_c_api.h:278
@ ORT_NOT_IMPLEMENTED
Definition onnxruntime_c_api.h:276
@ ORT_RUNTIME_EXCEPTION
Definition onnxruntime_c_api.h:273
@ ORT_ENGINE_ERROR
Definition onnxruntime_c_api.h:272
@ ORT_FAIL
Definition onnxruntime_c_api.h:268
@ ORT_NOT_FOUND
Definition onnxruntime_c_api.h:281
@ ORT_MODEL_REQUIRES_COMPILATION
Definition onnxruntime_c_api.h:280
@ ORT_INVALID_PROTOBUF
Definition onnxruntime_c_api.h:274
@ ORT_NO_MODEL
Definition onnxruntime_c_api.h:271
@ ORT_INVALID_GRAPH
Definition onnxruntime_c_api.h:277
@ ORT_MODEL_LOADED
Definition onnxruntime_c_api.h:275
@ ORT_PARALLEL
Definition onnxruntime_c_api.h:467
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:466
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:286
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:289
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:291
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:285
@ ORT_OP_ATTR_GRAPH
Definition onnxruntime_c_api.h:292
@ ORT_OP_ATTR_TENSOR
Definition onnxruntime_c_api.h:293
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:287
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:290
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:288
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition onnxruntime_c_api.h:200
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition onnxruntime_c_api.h:198
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition onnxruntime_c_api.h:204
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E8M0
Definition onnxruntime_c_api.h:223
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT2
Definition onnxruntime_c_api.h:220
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition onnxruntime_c_api.h:196
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition onnxruntime_c_api.h:192
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition onnxruntime_c_api.h:207
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ
Definition onnxruntime_c_api.h:213
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition onnxruntime_c_api.h:205
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4
Definition onnxruntime_c_api.h:215
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition onnxruntime_c_api.h:199
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT4E2M1
Definition onnxruntime_c_api.h:218
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2
Definition onnxruntime_c_api.h:212
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition onnxruntime_c_api.h:201
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition onnxruntime_c_api.h:202
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition onnxruntime_c_api.h:194
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition onnxruntime_c_api.h:197
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition onnxruntime_c_api.h:203
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition onnxruntime_c_api.h:195
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:193
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN
Definition onnxruntime_c_api.h:210
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition onnxruntime_c_api.h:208
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4
Definition onnxruntime_c_api.h:216
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition onnxruntime_c_api.h:206
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ
Definition onnxruntime_c_api.h:211
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT2
Definition onnxruntime_c_api.h:221
@ OrtCompileApiFlags_NONE
Definition onnxruntime_c_api.h:8012
@ OrtCompileApiFlags_ERROR_IF_NO_NODES_COMPILED
Definition onnxruntime_c_api.h:8016
@ OrtCompileApiFlags_ERROR_IF_OUTPUT_FILE_EXISTS
Definition onnxruntime_c_api.h:8020
@ OrtExecutionProviderDevicePolicy_DEFAULT
Definition onnxruntime_c_api.h:535
@ OrtExecutionProviderDevicePolicy_PREFER_CPU
Definition onnxruntime_c_api.h:536
@ OrtExecutionProviderDevicePolicy_MAX_PERFORMANCE
Definition onnxruntime_c_api.h:539
@ OrtExecutionProviderDevicePolicy_PREFER_NPU
Definition onnxruntime_c_api.h:537
@ OrtExecutionProviderDevicePolicy_MAX_EFFICIENCY
Definition onnxruntime_c_api.h:540
@ OrtExecutionProviderDevicePolicy_PREFER_GPU
Definition onnxruntime_c_api.h:538
@ OrtExecutionProviderDevicePolicy_MIN_OVERALL_POWER
Definition onnxruntime_c_api.h:541
Memory allocation interface.
Definition onnxruntime_c_api.h:364
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:371
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:374
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:365
OrtStatus * Shrink(struct OrtAllocator *this_)
Release unused memory held by the allocator back to the system.
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition onnxruntime_c_api.h:368
void *(* AllocOnStream)(struct OrtAllocator *this_, size_t size, OrtSyncStream *stream)
Allocate using a stream.
Definition onnxruntime_c_api.h:429
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:385
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:935
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:951
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:945
The C API.
Definition onnxruntime_c_api.h:1300
OrtStatus * SetGlobalIntraOpThreadAffinity(OrtThreadingOptions *tp_options, const char *affinity_string)
OrtStatus * ShapeInferContext_SetOutputTypeShape(const OrtShapeInferContext *context, size_t index, const OrtTensorTypeAndShapeInfo *info)
OrtStatus * SessionGetOverridableInitializerTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get overridable initializer type information.
OrtStatus * SessionOptionsSetCustomJoinThreadFn(OrtSessionOptions *options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Set custom thread join function.
OrtStatus * KernelInfoGetAttributeArray_int64(const OrtKernelInfo *info, const char *name, int64_t *out, size_t *size)
Fetch an array of int64_t values stored as an attribute in the graph node.
OrtStatus * Graph_GetNumInputs(const OrtGraph *graph, size_t *num_inputs)
Returns the number of graph inputs.
OrtStatus * Node_GetOperatorType(const OrtNode *node, const char **operator_type)
Returns a node's operator type (e.g., "Conv").
OrtStatus * CreateSessionOptions(OrtSessionOptions **options)
Create an OrtSessionOptions object.
OrtHardwareDeviceType(* HardwareDevice_Type)(const OrtHardwareDevice *device)
Get the hardware device type.
Definition onnxruntime_c_api.h:5684
void(* ReleaseDnnlProviderOptions)(OrtDnnlProviderOptions *input)
Release an OrtDnnlProviderOptions.
Definition onnxruntime_c_api.h:4752
OrtStatus * GetTensorData(const OrtValue *value, const void **out)
Get a const pointer to the raw data inside a tensor.
OrtStatus * TensorAt(OrtValue *value, const int64_t *location_values, size_t location_values_count, void **out)
Direct memory access to a specified tensor element.
OrtStatus * KernelInfoGetAttribute_float(const OrtKernelInfo *info, const char *name, float *out)
Get a float stored as an attribute in the graph node.
OrtStatus * GetCANNProviderOptionsAsString(const OrtCANNProviderOptions *cann_options, OrtAllocator *allocator, char **ptr)
Get serialized CANN provider options string.
OrtStatus * InvokeOp(const OrtKernelContext *context, const OrtOp *ort_op, const OrtValue *const *input_values, int input_count, OrtValue *const *output_values, int output_count)
: Invoke the operator created by OrtApi::CreateOp The inputs must follow the order as specified in on...
OrtStatus * HasSessionConfigEntry(const OrtSessionOptions *options, const char *config_key, int *out)
Checks if the given session configuration entry exists.
const char *(* GetBuildInfoString)(void)
Returns a null terminated string of the build info including git info and cxx flags.
Definition onnxruntime_c_api.h:4942
OrtStatus * AddExternalInitializersFromFilesInMemory(OrtSessionOptions *options, const char *const *external_initializer_file_names, char *const *external_initializer_file_buffer_array, const size_t *external_initializer_file_lengths, size_t num_external_initializer_files)
Replace initialized Tensors with external data with the provided files in memory.
OrtStatus * ValueInfo_IsFromOuterScope(const OrtValueInfo *value_info, bool *is_from_outer_scope)
Returns a boolean indicating if the given value is defined in an outer scope.
OrtStatus * GetTensorMemoryInfo(const OrtValue *value, const OrtMemoryInfo **mem_info)
Returns a pointer to the OrtMemoryInfo of a Tensor.
OrtStatus * EnableCpuMemArena(OrtSessionOptions *options)
Enable the memory arena on CPU.
OrtStatus * CreateSparseTensorWithValuesAsOrtValue(const OrtMemoryInfo *info, void *p_data, const int64_t *dense_shape, size_t dense_shape_len, const int64_t *values_shape, size_t values_shape_len, ONNXTensorElementDataType type, OrtValue **out)
OrtStatus * GetValueCount(const OrtValue *value, size_t *out)
Get non tensor value count from an OrtValue.
OrtStatus * SetGlobalCustomJoinThreadFn(OrtThreadingOptions *tp_options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Set custom thread join function for global thread pools.
OrtStatus * CreateCUDAProviderOptions(OrtCUDAProviderOptionsV2 **out)
Create an OrtCUDAProviderOptionsV2.
OrtStatus * DisableProfiling(OrtSessionOptions *options)
Disable profiling for a session.
OrtStatus * KernelInfoGetAttributeArray_float(const OrtKernelInfo *info, const char *name, float *out, size_t *size)
Fetch an array of int64_t values stored as an attribute in the graph node.
OrtStatus * CreatePrepackedWeightsContainer(OrtPrepackedWeightsContainer **out)
Create an OrtPrepackedWeightsContainer.
OrtStatus * SetDeterministicCompute(OrtSessionOptions *options, bool value)
Set whether to use deterministic compute.
OrtStatus * UpdateTensorRTProviderOptionsWithValue(OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *key, void *value)
OrtStatus * CreateSessionFromArrayWithPrepackedWeightsContainer(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container, OrtSession **out)
Create session from memory with prepacked weights container.
OrtStatus * AddFreeDimensionOverrideByName(OrtSessionOptions *options, const char *dim_name, int64_t dim_value)
OrtStatus * GetSharedAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info, OrtAllocator **allocator)
Get a shared allocator from the OrtEnv.
OrtStatus * KernelInfo_GetInputCount(const OrtKernelInfo *info, size_t *out)
Get the number of inputs from OrtKernelInfo.
OrtStatus * Graph_GetOperatorSets(const OrtGraph *graph, const char **domains, int64_t *opset_versions, size_t num_operator_sets)
Returns the operator sets that the graph's model uses.
OrtStatus * GetSparseTensorFormat(const OrtValue *ort_value, enum OrtSparseFormat *out)
Returns sparse tensor format enum iff a given ort value contains an instance of sparse tensor.
OrtStatus * KernelContext_GetGPUComputeStream(const OrtKernelContext *context, void **out)
Used for custom operators, gets the GPU compute stream to use to launch the custom a GPU kernel.
OrtStatus * UpdateCANNProviderOptions(OrtCANNProviderOptions *cann_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CANN Execution Provider.
OrtStatus * GetTensorSizeInBytes(const OrtValue *ort_value, size_t *size)
Compute total size in bytes of the tensor data contained in an OrtValue.
const OrtEpApi *(* GetEpApi)(void)
Get the OrtEpApi instance for implementing an execution provider.
Definition onnxruntime_c_api.h:5773
OrtStatus * GetCompatibilityInfoFromModel(const char *model_path, const char *ep_type, OrtAllocator *allocator, char **compatibility_info)
Extract EP compatibility info from a precompiled model file.
OrtStatus * CreateAndRegisterAllocatorV2(OrtEnv *env, const char *provider_type, const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Create an allocator with specific type and register it with the OrtEnv This API enhance CreateAndRegi...
OrtStatus * SessionGetOutputName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get output name.
OrtStatus * SessionOptionsAppendExecutionProvider_TensorRT(OrtSessionOptions *options, const OrtTensorRTProviderOptions *tensorrt_options)
Append TensorRT provider to session options.
const char *(* HardwareDevice_Vendor)(const OrtHardwareDevice *device)
Get the hardware device's vendor name.
Definition onnxruntime_c_api.h:5702
OrtStatus * Node_GetAttributeByName(const OrtNode *node, const char *attribute_name, const OrtOpAttr **attribute)
Gets the OrtNode's attribute as OrtOpAttr by name.
const OrtTrainingApi *(* GetTrainingApi)(uint32_t version)
Gets the Training C Api struct.
Definition onnxruntime_c_api.h:4350
OrtStatus * SetIntraOpNumThreads(OrtSessionOptions *options, int intra_op_num_threads)
Sets the number of threads used to parallelize the execution within nodes.
OrtStatus * GetTypeInfo(const OrtValue *value, OrtTypeInfo **out)
Get type information of an OrtValue.
OrtStatus * AllocatorGetStats(const OrtAllocator *ort_allocator, OrtKeyValuePairs **out)
Calls OrtAllocator::GetStats function.
OrtStatus * CastTypeInfoToMapTypeInfo(const OrtTypeInfo *type_info, const OrtMapTypeInfo **out)
Get detailed map information from an OrtTypeInfo.
OrtStatus * KernelContext_GetLogger(const OrtKernelContext *context, const OrtLogger **logger)
Get the runtime logger from OrtKernelContext.
OrtStatus * SetGlobalCustomThreadCreationOptions(OrtThreadingOptions *tp_options, void *ort_custom_thread_creation_options)
Set custom thread creation options for global thread pools.
OrtStatus * AddSessionConfigEntry(OrtSessionOptions *options, const char *config_key, const char *config_value)
Set a session configuration entry as a pair of strings.
OrtStatus * SetGlobalDenormalAsZero(OrtThreadingOptions *tp_options)
Set threading flush-to-zero and denormal-as-zero.
void(* ClearBoundInputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Inputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2995
const char *(* GetRunConfigEntry)(const OrtRunOptions *options, const char *config_key)
Get a run configuration entry.
Definition onnxruntime_c_api.h:6633
OrtStatus * KernelInfo_GetInputTypeInfo(const OrtKernelInfo *info, size_t index, OrtTypeInfo **type_info)
Get the type information for a OrtKernelInfo's input.
OrtStatus * Graph_GetOnnxIRVersion(const OrtGraph *graph, int64_t *onnx_ir_version)
Returns the ONNX IR version.
OrtStatus * KernelInfoGetAttribute_string(const OrtKernelInfo *info, const char *name, char *out, size_t *size)
Fetch a string stored as an attribute in the graph node.
OrtStatus * Graph_GetName(const OrtGraph *graph, const char **graph_name)
Returns a graph's name.
OrtStatus * GetSparseTensorIndicesTypeShape(const OrtValue *ort_value, enum OrtSparseIndicesFormat indices_format, OrtTensorTypeAndShapeInfo **out)
Returns data type, shape for the type of indices specified by indices_format.
OrtStatus * SessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, const OrtMIGraphXProviderOptions *migraphx_options)
Append MIGraphX provider to session options.
OrtStatus * RunOptionsSetRunLogVerbosityLevel(OrtRunOptions *options, int log_verbosity_level)
Set per-run log verbosity level.
OrtStatus * AddInitializer(OrtSessionOptions *options, const char *name, const OrtValue *val)
Add a pre-allocated initializer to a session.
OrtStatus * CreateEnv(OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * UseCooIndices(OrtValue *ort_value, int64_t *indices_data, size_t indices_num)
OrtStatus * GetTensorMutableData(OrtValue *value, void **out)
Get a pointer to the raw data inside a tensor.
OrtStatus * CreateExternalInitializerInfo(const char *filepath, int64_t file_offset, size_t byte_size, OrtExternalInitializerInfo **out)
Creates an OrtExternalInitializerInfo instance.
OrtStatus * KernelInfoGetAllocator(const OrtKernelInfo *info, OrtMemType mem_type, OrtAllocator **out)
Get allocator from KernelInfo for a specific memory type. Please use C API ReleaseAllocator to releas...
OrtStatus * SessionOptionsAppendExecutionProvider_OpenVINO(OrtSessionOptions *options, const OrtOpenVINOProviderOptions *provider_options)
Append OpenVINO execution provider to the session options.
OrtStatus * IsSparseTensor(const OrtValue *value, int *out)
Sets *out to 1 iff an OrtValue is a SparseTensor, and 0 otherwise.
OrtStatus * SessionOptionsAppendExecutionProvider_V2(OrtSessionOptions *session_options, OrtEnv *env, const OrtEpDevice *const *ep_devices, size_t num_ep_devices, const char *const *ep_option_keys, const char *const *ep_option_vals, size_t num_ep_options)
Append the execution provider that is responsible for the selected OrtEpDevice instances to the sessi...
void(* GetKeyValuePairs)(const OrtKeyValuePairs *kvps, const char *const **keys, const char *const **values, size_t *num_entries)
Get all the key-value pairs from the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5556
OrtStatus * GetTensorElementType(const OrtTensorTypeAndShapeInfo *info, enum ONNXTensorElementDataType *out)
Get element type in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionOptionsSetEpSelectionPolicyDelegate(OrtSessionOptions *session_options, EpSelectionDelegate delegate, void *delegate_state)
Set the execution provider selection policy delegate for the session.
OrtStatus * CreateSparseTensorAsOrtValue(OrtAllocator *allocator, const int64_t *dense_shape, size_t dense_shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create an OrtValue with a sparse tensor that is empty.
OrtStatus * FillStringTensorElement(OrtValue *value, const char *s, size_t index)
Set a single string in a string tensor.
OrtStatus * CreateTensorWithDataAsOrtValue(const OrtMemoryInfo *info, void *p_data, size_t p_data_len, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create a tensor backed by a user supplied buffer.
OrtStatus * AddExternalInitializers(OrtSessionOptions *options, const char *const *initializer_names, const OrtValue *const *initializers, size_t num_initializers)
Replace initialized Tensors with external data with the data provided in initializers.
OrtStatus * SessionOptionsSetEpSelectionPolicy(OrtSessionOptions *session_options, OrtExecutionProviderDevicePolicy policy)
Set the execution provider selection policy for the session.
const OrtHardwareDevice *(* EpDevice_Device)(const OrtEpDevice *ep_device)
Get the OrtHardwareDevice instance for the OrtEpDevice.
Definition onnxruntime_c_api.h:5767
OrtStatus * ModelMetadataGetGraphDescription(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
OrtStatus * UpdateDnnlProviderOptions(OrtDnnlProviderOptions *dnnl_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a oneDNN Execution Provider.
OrtStatus * GetStringTensorElementLength(const OrtValue *value, size_t index, size_t *out)
Get the length of a single string in a string tensor.
OrtStatus * GetTensorElementTypeAndShapeDataReference(const OrtValue *value, ONNXTensorElementDataType *elem_type, const int64_t **shape_data, size_t *shape_data_count)
Get the element data type and shape for an OrtValue that represents a Tensor (scalar,...
uint32_t(* MemoryInfoGetVendorId)(const OrtMemoryInfo *ptr)
Get the vendor id from OrtMemoryInfo.
Definition onnxruntime_c_api.h:5847
OrtStatus * Node_GetNumOutputs(const OrtNode *node, size_t *num_outputs)
Returns the number of node outputs.
void(* MemoryInfoGetDeviceType)(const OrtMemoryInfo *ptr, OrtMemoryInfoDeviceType *out)
Definition onnxruntime_c_api.h:4422
OrtStatus * AddRunConfigEntry(OrtRunOptions *options, const char *config_key, const char *config_value)
Set a single run configuration entry as a pair of strings.
OrtStatus * GetBoundOutputValues(const OrtIoBinding *binding_ptr, OrtAllocator *allocator, OrtValue ***output, size_t *output_count)
Get the output OrtValue objects from an OrtIoBinding.
OrtStatus * ModelMetadataGetDomain(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get domain from an OrtModelMetadata.
OrtStatus * SetLanguageProjection(const OrtEnv *ort_env, OrtLanguageProjection projection)
Set language projection.
OrtStatus * GetSessionOptionsConfigEntries(const OrtSessionOptions *options, OrtKeyValuePairs **out)
Get Session configuration entries.
OrtStatus * FillStringTensor(OrtValue *value, const char *const *s, size_t s_len)
Set all strings at once in a string tensor.
OrtStatus * KernelInfoGetAttributeArray_string(const OrtKernelInfo *info, const char *name, OrtAllocator *allocator, char ***out, size_t *size)
Fetch an array of strings stored as an attribute in the graph node.
OrtStatus * Node_GetInputs(const OrtNode *node, const OrtValueInfo **inputs, size_t num_inputs)
Returns the node's inputs as OrtValueInfo instances.
OrtStatus * SetSessionLogId(OrtSessionOptions *options, const char *logid)
Set session log id.
OrtStatus * GetValueInfoTypeInfo(const OrtValueInfo *value_info, const OrtTypeInfo **type_info)
Get the type information from an OrtValueInfo instance.
OrtStatus * SessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, const OrtCUDAProviderOptions *cuda_options)
Append CUDA provider to session options.
OrtStatus * SessionGetMemoryInfoForOutputs(const OrtSession *session, const OrtMemoryInfo **outputs_memory_info, size_t num_outputs)
Get the OrtMemoryInfo for each output of the session.
OrtStatus * RegisterAllocator(OrtEnv *env, OrtAllocator *allocator)
Register a custom allocator.
OrtStatus * SetGlobalSpinControl(OrtThreadingOptions *tp_options, int allow_spinning)
Set global spin control options.
OrtStatus * MemoryInfoGetId(const OrtMemoryInfo *ptr, int *out)
Get the device id from OrtMemoryInfo.
const OrtMemoryInfo *(* EpDevice_MemoryInfo)(const OrtEpDevice *ep_device, OrtDeviceMemoryType memory_type)
Get the OrtMemoryInfo for the device.
Definition onnxruntime_c_api.h:6647
OrtStatus * KernelInfo_GetOutputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's output.
OrtStatus * Node_GetAttributes(const OrtNode *node, const OrtOpAttr **attributes, size_t num_attributes)
Returns a node's attributes as OrtOpAttr instances.
OrtStatus * Logger_LogMessage(const OrtLogger *logger, OrtLoggingLevel log_severity_level, const char *message, const char *file_path, int line_number, const char *func_name)
Logs a message at the given severity level using the provided OrtLogger.
OrtStatus * Graph_GetInputs(const OrtGraph *graph, const OrtValueInfo **inputs, size_t num_inputs)
Returns the graph's inputs as OrtValueInfo instances.
OrtStatus * CreateEnvWithCustomLogger(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * UpdateCUDAProviderOptionsWithValue(OrtCUDAProviderOptionsV2 *cuda_options, const char *key, void *value)
OrtStatus * MemoryInfoGetName(const OrtMemoryInfo *ptr, const char **out)
Get name from OrtMemoryInfo.
OrtStatus * Logger_GetLoggingSeverityLevel(const OrtLogger *logger, OrtLoggingLevel *out)
Get the logging severity level of the OrtLogger.
OrtStatus * GetExecutionProviderApi(const char *provider_name, uint32_t version, const void **provider_api)
Get a pointer to the requested version of the Execution Provider specific API extensions to the OrtAp...
OrtStatus * KernelContext_GetOutputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the output count of a kernel.
void(* RunOptionsSetSyncStream)(OrtRunOptions *options, OrtSyncStream *sync_stream)
Sets OrtSyncStream for the run options.
Definition onnxruntime_c_api.h:7352
OrtStatus * GetTensorShapeElementCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get total number of elements in a tensor shape from an OrtTensorTypeAndShapeInfo.
OrtStatus * GetModelCompatibilityForEpDevices(const OrtEpDevice *const *ep_devices, size_t num_ep_devices, const char *compatibility_info, OrtCompiledModelCompatibility *out_status)
Validate a compiled model's compatibility information for one or more EP devices.
OrtStatus * CastTypeInfoToTensorInfo(const OrtTypeInfo *type_info, const OrtTensorTypeAndShapeInfo **out)
Get OrtTensorTypeAndShapeInfo from an OrtTypeInfo.
OrtStatus * GetOptionalContainedTypeInfo(const OrtOptionalTypeInfo *optional_type_info, OrtTypeInfo **out)
Get OrtTypeInfo for the allowed contained type from an OrtOptionalTypeInfo.
OrtStatus * CreateOp(const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, int type_constraint_count, const OrtOpAttr *const *attr_values, int attr_count, int input_count, int output_count, OrtOp **ort_op)
: Create onnxruntime native operator
OrtStatus * MemoryInfoGetType(const OrtMemoryInfo *ptr, OrtAllocatorType *out)
Get the OrtAllocatorType from OrtMemoryInfo.
OrtStatus * HasValue(const OrtValue *value, int *out)
Sets out to 1 iff an optional type OrtValue has an element, 0 otherwise (OrtValue is None) Use this A...
OrtStatus * CreateEnvWithGlobalThreadPools(OrtLoggingLevel log_severity_level, const char *logid, const OrtThreadingOptions *tp_options, OrtEnv **out)
Create an OrtEnv.
OrtStatus * ValueInfo_GetValueNumConsumers(const OrtValueInfo *value_info, size_t *num_consumers)
Get the number of consumers of a value as a node input.
OrtStatus * KernelContext_GetAllocator(const OrtKernelContext *context, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Get Allocator from KernelContext for a specific memoryInfo. Please use C API ReleaseAllocator to rele...
OrtStatus * KernelInfoGetConstantInput_tensor(const OrtKernelInfo *info, size_t index, int *is_constant, const OrtValue **out)
Get a OrtValue tensor stored as a constant initializer in the graph node.
OrtStatus * GetCUDAProviderOptionsAsString(const OrtCUDAProviderOptionsV2 *cuda_options, OrtAllocator *allocator, char **ptr)
OrtStatus * ValueInfo_IsConstantInitializer(const OrtValueInfo *value_info, bool *is_constant_initializer)
Returns a boolean indicating if the given value is a constant initializer.
OrtStatus * UpdateCUDAProviderOptions(OrtCUDAProviderOptionsV2 *cuda_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CUDA Execution Provider.
OrtStatus * CopyKernelInfo(const OrtKernelInfo *info, OrtKernelInfo **info_copy)
OrtStatus * Graph_GetModelMetadata(const OrtGraph *graph, OrtModelMetadata **out)
Get OrtModelMetadata from an OrtGraph.
OrtStatus * RunOptionsDisableProfiling(OrtRunOptions *options)
Disable profiling for this run.
OrtStatus * GetTensorRTProviderOptionsAsString(const OrtTensorRTProviderOptionsV2 *tensorrt_options, OrtAllocator *allocator, char **ptr)
Get serialized TensorRT provider options string.
int64_t(* ExternalInitializerInfo_GetFileOffset)(const OrtExternalInitializerInfo *info)
Get the byte offset within the file where the initializer's data is stored.
Definition onnxruntime_c_api.h:6602
OrtStatus * SessionOptionsSetCustomThreadCreationOptions(OrtSessionOptions *options, void *ort_custom_thread_creation_options)
Set creation options for custom thread.
OrtStatus * GetDimensionsCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get dimension count in OrtTensorTypeAndShapeInfo.
OrtStatus * KernelInfo_GetConfigEntries(const OrtKernelInfo *info, OrtKeyValuePairs **out)
Get all config entries from OrtKernelInfo.
OrtStatus * Session_GetEpGraphAssignmentInfo(const OrtSession *session, const OrtEpAssignedSubgraph *const **ep_subgraphs, size_t *num_ep_subgraphs)
Get information about the subgraphs assigned to each execution provider (EP) and the nodes within.
void(* ReleaseROCMProviderOptions)(OrtROCMProviderOptions *input)
Release an OrtROCMProviderOptions.
Definition onnxruntime_c_api.h:5001
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 * GetSessionExecutionMode(const OrtSessionOptions *options, ExecutionMode *out)
Get the current execution mode setting.
OrtStatus * Node_GetNumAttributes(const OrtNode *node, size_t *num_attributes)
Returns the number of node attributes.
OrtStatus * SetCurrentGpuDeviceId(int device_id)
Set current GPU device ID.
OrtStatus * Node_GetNumInputs(const OrtNode *node, size_t *num_inputs)
Returns the number of node inputs.
OrtStatus * GetOnnxTypeFromTypeInfo(const OrtTypeInfo *type_info, enum ONNXType *out)
Get ONNXType from OrtTypeInfo.
OrtStatus * CreateMemoryInfo_V2(const char *name, enum OrtMemoryInfoDeviceType device_type, uint32_t vendor_id, int32_t device_id, enum OrtDeviceMemoryType mem_type, size_t alignment, enum OrtAllocatorType allocator_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo.
OrtStatus * GetEpDevices(const OrtEnv *env, const OrtEpDevice *const **ep_devices, size_t *num_ep_devices)
Get the list of available OrtEpDevice instances.
OrtStatus * CreateLoraAdapterFromArray(const void *bytes, size_t num_bytes, OrtAllocator *allocator, OrtLoraAdapter **out)
Create an OrtLoraAdapter.
OrtStatus * DeviceEpIncompatibilityDetails_GetErrorCode(const OrtDeviceEpIncompatibilityDetails *details, int32_t *error_code)
Get the execution provider error code from OrtDeviceEpIncompatibilityDetails.
const OrtInteropApi *(* GetInteropApi)(void)
Get the EP Interop API instance.
Definition onnxruntime_c_api.h:7017
OrtStatus * GetDenotationFromTypeInfo(const OrtTypeInfo *type_info, const char **const denotation, size_t *len)
Get denotation from type information.
OrtStatus * KernelContext_ParallelFor(const OrtKernelContext *context, void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data)
OrtStatus * SessionReleaseCapturedGraph(OrtSession *session, int graph_annotation_id)
Release a previously captured graph and its associated resources.
OrtStatus * RunOptionsEnableProfiling(OrtRunOptions *options, const char *profile_file_prefix)
Enable profiling for this run.
void(* ReleaseCANNProviderOptions)(OrtCANNProviderOptions *input)
Release an OrtCANNProviderOptions.
Definition onnxruntime_c_api.h:4416
OrtStatus * SetGlobalInterOpNumThreads(OrtThreadingOptions *tp_options, int inter_op_num_threads)
Set global inter-op thread count.
OrtStatus * CloneSessionOptions(const OrtSessionOptions *in_options, OrtSessionOptions **out_options)
Create a copy of an existing OrtSessionOptions.
OrtStatus * GetSessionConfigEntry(const OrtSessionOptions *options, const char *config_key, char *config_value, size_t *size)
Get a session configuration value.
OrtStatus * SessionOptionsAppendExecutionProvider_TensorRT_V2(OrtSessionOptions *options, const OrtTensorRTProviderOptionsV2 *tensorrt_options)
Append TensorRT execution provider to the session options.
OrtStatus * AddFreeDimensionOverride(OrtSessionOptions *options, const char *dim_denotation, int64_t dim_value)
Override session symbolic dimensions.
OrtStatus * KernelContext_GetOutput(OrtKernelContext *context, size_t index, const int64_t *dim_values, size_t dim_count, OrtValue **out)
Used for custom operators, get an output of a kernel.
OrtStatus * ValueInfo_GetInitializerValue(const OrtValueInfo *value_info, const OrtValue **initializer_value)
Get the underlying initializer value, as an OrtValue, from the given OrtValueInfo.
OrtStatus * EnableTelemetryEvents(const OrtEnv *env)
Enable Telemetry.
OrtStatus * OpAttr_GetTensorAttributeAsOrtValue(const OrtOpAttr *attribute, OrtValue **attr_tensor)
Get the OrtNode's 'TENSOR' attribute as an OrtValue.
OrtStatus * EpAssignedNode_GetDomain(const OrtEpAssignedNode *ep_node, const char **out)
Get the domain of the node assigned to an execution provider.
OrtStatus * OpAttr_GetType(const OrtOpAttr *attribute, OrtOpAttrType *type)
Get the attribute type as OrtOpAttrType from an OrtOpAttr.
OrtStatus * CreateMemoryInfo(const char *name, enum OrtAllocatorType type, int id, enum OrtMemType mem_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo.
OrtStatus * SessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, const OrtROCMProviderOptions *rocm_options)
Append ROCM execution provider to the session options.
OrtStatus * SessionGetInputTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get input type information.
OrtStatus * GetSymbolicDimensions(const OrtTensorTypeAndShapeInfo *info, const char *dim_params[], size_t dim_params_length)
Get symbolic dimension names in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionOptionsAppendExecutionProvider_OpenVINO_V2(OrtSessionOptions *options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Append OpenVINO execution provider to the session options.
OrtStatus * GetStringTensorDataLength(const OrtValue *value, size_t *len)
Get total byte length for all strings in a string tensor.
OrtStatus * KernelContext_GetInputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the input count of a kernel.
OrtStatus * BindOutputToDevice(OrtIoBinding *binding_ptr, const char *name, const OrtMemoryInfo *mem_info_ptr)
Bind an OrtIoBinding output to a device.
OrtStatus * SessionGetEpDeviceForInputs(const OrtSession *session, const OrtEpDevice **inputs_ep_devices, size_t num_inputs)
Get the OrtEpDevice (if available) for each input of the session.
OrtStatus * SessionOptionsAppendExecutionProvider(OrtSessionOptions *options, const char *provider_name, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
: Append execution provider to the session options.
OrtStatus * SetSessionGraphOptimizationLevel(OrtSessionOptions *options, GraphOptimizationLevel graph_optimization_level)
Set the optimization level to apply when loading a graph.
OrtStatus * SessionGetEpDeviceForOutputs(const OrtSession *session, const OrtEpDevice **outputs_ep_devices, size_t num_outputs)
Get the EP device assigned to each session output.
OrtStatus * ModelMetadataGetDescription(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get description from an OrtModelMetadata.
OrtStatus * CreateCANNProviderOptions(OrtCANNProviderOptions **out)
Create an OrtCANNProviderOptions.
OrtStatus * ReadOpAttr(const OrtOpAttr *op_attr, OrtOpAttrType type, void *data, size_t len, size_t *out)
OrtStatus * DisablePerSessionThreads(OrtSessionOptions *options)
Use global thread pool on a session.
OrtStatus * SetDimensions(OrtTensorTypeAndShapeInfo *info, const int64_t *dim_values, size_t dim_count)
Set shape information in OrtTensorTypeAndShapeInfo.
OrtStatus * SetInterOpNumThreads(OrtSessionOptions *options, int inter_op_num_threads)
Sets the number of threads used to parallelize the execution of the graph.
OrtStatus * CustomOpDomain_Add(OrtCustomOpDomain *custom_op_domain, const OrtCustomOp *op)
Add a custom op to a custom op domain.
OrtStatus * GetSequenceElementType(const OrtSequenceTypeInfo *sequence_type_info, OrtTypeInfo **type_info)
Get element type from an OrtSequenceTypeInfo.
OrtStatus * RunOptionsGetRunLogVerbosityLevel(const OrtRunOptions *options, int *log_verbosity_level)
Get per-run log verbosity level.
OrtStatus * FillSparseTensorCsr(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *inner_indices_data, size_t inner_indices_num, const int64_t *outer_indices_data, size_t outer_indices_num)
OrtStatus * CreateAndRegisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Create an allocator and register it with the OrtEnv.
OrtStatus * CreateCpuMemoryInfo(enum OrtAllocatorType type, enum OrtMemType mem_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo for CPU memory.
OrtStatus * Node_GetGraph(const OrtNode *node, const OrtGraph **graph)
Get the node's parent OrtGraph instance.
OrtStatus * ValueInfo_GetExternalInitializerInfo(const OrtValueInfo *value_info, OrtExternalInitializerInfo **info)
Get information about an external initializer (e.g., filepath, file offset, byte size).
OrtStatus * AddCustomOpDomain(OrtSessionOptions *options, OrtCustomOpDomain *custom_op_domain)
Add custom op domain to a session options.
OrtStatus * Graph_GetGraphView(const OrtGraph *src_graph, const OrtNode **nodes, size_t num_nodes, OrtGraph **dst_graph)
Returns an OrtGraph that contains a subset of nodes in the source OrtGraph.
OrtStatus * KernelInfo_GetOutputTypeInfo(const OrtKernelInfo *info, size_t index, OrtTypeInfo **type_info)
Get the type information for a OrtKernelInfo's output.
OrtStatus * GetHardwareDevices(const OrtEnv *env, const OrtHardwareDevice **devices, size_t num_devices)
Get the list of available hardware devices.
OrtStatus * KernelContext_GetInput(const OrtKernelContext *context, size_t index, const OrtValue **out)
Used for custom operators, get an input of a kernel.
OrtStatus * CreateEnvWithCustomLoggerAndGlobalThreadPools(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, const struct OrtThreadingOptions *tp_options, OrtEnv **out)
uint32_t(* HardwareDevice_VendorId)(const OrtHardwareDevice *device)
Get the hardware device's vendor identifier.
Definition onnxruntime_c_api.h:5693
OrtStatus * KernelInfo_GetOperatorType(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node's operator type from OrtKernelInfo.
OrtStatus * DisableTelemetryEvents(const OrtEnv *env)
Disable Telemetry.
OrtStatus * KernelInfo_GetOutputCount(const OrtKernelInfo *info, size_t *out)
Get the number of outputs from OrtKernelInfo.
OrtStatus * CreateTensorWithDataAndDeleterAsOrtValue(OrtAllocator *deleter, void *p_data, size_t p_data_len, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create an OrtValue for a Tensor that uses pre-existing memory.
OrtStatus * ShapeInferContext_GetInputCount(const OrtShapeInferContext *context, size_t *out)
OrtStatus * Graph_GetInitializers(const OrtGraph *graph, const OrtValueInfo **initializers, size_t num_initializers)
Returns the graph's initializers as OrtValueInfo instances.
OrtStatus * GetHardwareDeviceEpIncompatibilityDetails(const OrtEnv *env, const char *ep_name, const OrtHardwareDevice *hw, OrtDeviceEpIncompatibilityDetails **details)
Check for known incompatibility issues between hardware device and a specific execution provider.
OrtStatus * ModelMetadataGetGraphName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get graph name from an OrtModelMetadata.
OrtStatus * CreateROCMProviderOptions(OrtROCMProviderOptions **out)
Create an OrtROCMProviderOptions.
OrtStatus * SetPerSessionThreadPoolCallbacks(OrtEnv *env, const OrtThreadPoolCallbacksConfig *config)
Set thread pool work callbacks for per-session thread pools.
OrtStatus * ModelMetadataLookupCustomMetadataMap(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, const char *key, char **value)
Return data for a key in the custom metadata map in an OrtModelMetadata.
OrtStatus * EpAssignedNode_GetOperatorType(const OrtEpAssignedNode *ep_node, const char **out)
Get the operator type of the node assigned to an execution provider.
OrtStatus * CopyTensors(const OrtEnv *env, const OrtValue *const *src_tensors, OrtValue *const *dst_tensors, OrtSyncStream *stream, size_t num_tensors)
Copy OrtValue instances containing Tensors between devices.
OrtStatus * RegisterExecutionProviderLibrary(OrtEnv *env, const char *registration_name, const char *path)
Register an execution provider library with ORT.
OrtStatus * RunOptionsSetRunLogSeverityLevel(OrtRunOptions *options, int log_severity_level)
Set per-run log severity level.
OrtStatus * GetCUDAProviderOptionsByName(const OrtCUDAProviderOptionsV2 *cuda_options, const char *key, void **ptr)
OrtStatus * SessionOptionsSetLoadCancellationFlag(OrtSessionOptions *options, bool cancel)
sets load cancellation flag to abort session loading process.
OrtStatus * Node_GetDomain(const OrtNode *node, const char **domain_name)
Returns a node's domain name.
OrtStatus * SetSessionExecutionMode(OrtSessionOptions *options, ExecutionMode execution_mode)
Set execution mode.
OrtStatus * SessionGetInputName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get input name.
OrtStatus * Graph_GetNumOutputs(const OrtGraph *graph, size_t *num_outputs)
Returns the number of graph outputs.
OrtStatus * ValueInfo_IsOptionalGraphInput(const OrtValueInfo *value_info, bool *is_optional_graph_input)
Returns a boolean indicating if the given value is an optional graph input.
OrtStatus * CreateLoraAdapter(const char *adapter_file_path, OrtAllocator *allocator, OrtLoraAdapter **out)
Create an OrtLoraAdapter.
OrtStatus * GetDnnlProviderOptionsAsString(const OrtDnnlProviderOptions *dnnl_options, OrtAllocator *allocator, char **ptr)
void(* AddKeyValuePair)(OrtKeyValuePairs *kvps, const char *key, const char *value)
Add a key-value pair to the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5534
OrtStatus * CreateRunOptions(OrtRunOptions **out)
Create an OrtRunOptions.
OrtStatus * RunOptionsGetRunTag(const OrtRunOptions *options, const char **run_tag)
Get per-run tag.
size_t(* ExternalInitializerInfo_GetByteSize)(const OrtExternalInitializerInfo *info)
Get the size in bytes of the initializer's data within the file.
Definition onnxruntime_c_api.h:6611
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:1325
OrtStatus * IsTensor(const OrtValue *value, int *out)
Return if an OrtValue is a tensor type.
OrtStatus * Graph_GetNumNodes(const OrtGraph *graph, size_t *num_nodes)
Returns the number of graph nodes.
OrtStatus * AllocatorFree(OrtAllocator *ort_allocator, void *p)
Calls OrtAllocator::Free function.
OrtStatus * GetMapValueType(const OrtMapTypeInfo *map_type_info, OrtTypeInfo **type_info)
Get the value type from an OrtMapTypeInfo.
OrtStatus * ValueInfo_GetValueConsumers(const OrtValueInfo *value_info, const OrtNode **nodes, int64_t *input_indices, size_t num_consumers)
Returns information (OrtNode and input index) for all consumer nodes that use the value as an input.
OrtStatus * CreateSessionFromArray(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession from memory.
OrtStatus * CreateArenaCfgV2(const char *const *arena_config_keys, const size_t *arena_config_values, size_t num_keys, OrtArenaCfg **out)
Create an OrtArenaCfg.
OrtStatus * GetAllocatorWithDefaultOptions(OrtAllocator **out)
Get the default allocator.
OrtStatus * CreateSession(const OrtEnv *env, const char *model_path, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession from a model file.
OrtStatus * SessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, const OrtDnnlProviderOptions *dnnl_options)
Append dnnl provider to session options.
OrtStatus * CreateArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk, OrtArenaCfg **out)
OrtStatus * SessionGetInputCount(const OrtSession *session, size_t *out)
Get input count for a session.
const char *(* GetKeyValue)(const OrtKeyValuePairs *kvps, const char *key)
Get the value associated with a key in the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5545
OrtStatus * EpAssignedSubgraph_GetEpName(const OrtEpAssignedSubgraph *ep_subgraph, const char **out)
Get the name of the execution provider to which the subgraph was assigned.
OrtStatus * GetValue(const OrtValue *value, int index, OrtAllocator *allocator, OrtValue **out)
Get non tensor data from an OrtValue.
OrtStatus * ShapeInferContext_GetAttribute(const OrtShapeInferContext *context, const char *attr_name, const OrtOpAttr **attr)
OrtStatus * GetSparseTensorIndices(const OrtValue *ort_value, enum OrtSparseIndicesFormat indices_format, size_t *num_indices, const void **indices)
Returns indices data for the type of the indices specified by indices_format.
const char *(* EpDevice_EpName)(const OrtEpDevice *ep_device)
Get the execution provider name.
Definition onnxruntime_c_api.h:5731
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:5712
OrtStatus * Node_GetId(const OrtNode *node, size_t *node_id)
Returns a node's identifier.
OrtStatus * SetUserLoggingFunction(OrtSessionOptions *options, OrtLoggingFunction user_logging_function, void *user_logging_param)
Set user logging function.
OrtStatus * GetStringTensorElement(const OrtValue *value, size_t s_len, size_t index, void *s)
Get a single string from a string tensor.
OrtStatus * Graph_GetNumOperatorSets(const OrtGraph *graph, size_t *num_operator_sets)
Returns the number of operator sets that the graph's model uses.
OrtStatus * GetTensorTypeAndShape(const OrtValue *value, OrtTensorTypeAndShapeInfo **out)
Get type and shape information from a tensor OrtValue.
OrtStatus * GetMemPatternEnabled(const OrtSessionOptions *options, int *out)
Check if the memory pattern optimization is enabled in the session options.
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:5749
OrtStatus * CreateEnvWithOptions(const OrtEnvCreationOptions *options, OrtEnv **out)
Create an OrtEnv instance with the given options.
OrtStatus * GetResizedStringTensorElementBuffer(OrtValue *value, size_t index, size_t length_in_bytes, char **buffer)
Set a single string in a string tensor Do not zero terminate the string data.
OrtStatus * DisableCpuMemArena(OrtSessionOptions *options)
Disable the memory arena on CPU.
OrtDeviceMemoryType(* MemoryInfoGetDeviceMemType)(const OrtMemoryInfo *ptr)
Get the device memory type from OrtMemoryInfo.
Definition onnxruntime_c_api.h:5838
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2999
OrtStatus * KernelInfo_GetOperatorDomain(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node's operator domain from OrtKernelInfo.
OrtStatus * SetSymbolicDimensions(OrtTensorTypeAndShapeInfo *info, const char *dim_params[], size_t dim_params_length)
OrtStatus * SessionOptionsAppendExecutionProvider_CANN(OrtSessionOptions *options, const OrtCANNProviderOptions *cann_options)
Append CANN provider to session options.
OrtStatus * MemoryInfoGetMemType(const OrtMemoryInfo *ptr, OrtMemType *out)
Get the OrtMemType from OrtMemoryInfo.
OrtStatus * AllocatorGetInfo(const OrtAllocator *ort_allocator, const struct OrtMemoryInfo **out)
Calls OrtAllocator::Info function.
OrtStatus * CreateSharedAllocator(OrtEnv *env, const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type, OrtAllocatorType allocator_type, const OrtKeyValuePairs *allocator_options, OrtAllocator **allocator)
Create/replace a shared allocator for the OrtEpDevice in the OrtEnv.
OrtStatus * CompareMemoryInfo(const OrtMemoryInfo *info1, const OrtMemoryInfo *info2, int *out)
Compare OrtMemoryInfo objects for equality.
OrtStatus * GetAvailableProviders(char ***out_ptr, int *provider_length)
Get the names of all available providers.
OrtStatus * SynchronizeBoundInputs(OrtIoBinding *binding_ptr)
Synchronize bound inputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * GetOpaqueValue(const char *domain_name, const char *type_name, const OrtValue *in, void *data_container, size_t data_container_size)
Get internal data from an opaque (custom user defined type) OrtValue.
OrtStatus * AllocatorAlloc(OrtAllocator *ort_allocator, size_t size, void **out)
Calls OrtAllocator::Alloc function.
OrtStatus * RunAsync(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *input, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **output, RunAsyncCallbackFn run_async_callback, void *user_data)
Run the model asynchronously in a thread owned by intra op thread pool.
OrtStatus * GetTensorRTProviderOptionsByName(const OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *key, void **ptr)
OrtStatus * RegisterCustomOpsLibrary_V2(OrtSessionOptions *options, const char *library_name)
Register custom ops from a shared library.
OrtStatus * SessionGetOverridableInitializerName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get overridable initializer name.
OrtStatus * GetROCMProviderOptionsAsString(const OrtROCMProviderOptions *rocm_options, OrtAllocator *allocator, char **ptr)
OrtStatus * UnregisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info)
Unregister a custom allocator.
OrtStatus * Graph_GetParentNode(const OrtGraph *graph, const OrtNode **node)
Get the parent node for the given graph, if any exists.
OrtStatus * DisableMemPattern(OrtSessionOptions *options)
Disable the memory pattern optimization.
OrtStatus * UseBlockSparseIndices(OrtValue *ort_value, const int64_t *indices_shape, size_t indices_shape_len, int32_t *indices_data)
OrtStatus * SetEpDynamicOptions(OrtSession *sess, const char *const *keys, const char *const *values, size_t kv_len)
Set DynamicOptions for EPs (Execution Providers)
void(* CreateKeyValuePairs)(OrtKeyValuePairs **out)
Create an OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5519
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:1311
OrtStatus * RunWithBinding(OrtSession *session, const OrtRunOptions *run_options, const OrtIoBinding *binding_ptr)
Run a model using Io Bindings for the inputs & outputs.
OrtStatus * CreateDnnlProviderOptions(OrtDnnlProviderOptions **out)
Create an OrtDnnlProviderOptions.
OrtStatus * GetMapKeyType(const OrtMapTypeInfo *map_type_info, enum ONNXTensorElementDataType *out)
Get key type from an OrtMapTypeInfo.
OrtStatus * DeviceEpIncompatibilityDetails_GetReasonsBitmask(const OrtDeviceEpIncompatibilityDetails *details, uint32_t *reasons_bitmask)
Get the incompatibility reasons bitmask from OrtDeviceEpIncompatibilityDetails.
OrtStatus * RunOptionsGetRunLogSeverityLevel(const OrtRunOptions *options, int *log_severity_level)
Get per-run log severity level.
OrtStatus * CastTypeInfoToOptionalTypeInfo(const OrtTypeInfo *type_info, const OrtOptionalTypeInfo **out)
Get Optional Type information from an OrtTypeInfo.
const OrtCompileApi *(* GetCompileApi)(void)
Get the Compile API instance.
Definition onnxruntime_c_api.h:5505
OrtStatus * SessionGetModelMetadata(const OrtSession *session, OrtModelMetadata **out)
Get OrtModelMetadata from an OrtSession.
OrtStatus * Node_GetSinceVersion(const OrtNode *node, int *since_version)
Get the opset version in which the given node's operator type was first defined.
OrtStatus * Node_GetNumSubgraphs(const OrtNode *node, size_t *num_subgraphs)
Returns the number of subgraphs contained by the given node.
OrtStatus * GetCurrentGpuDeviceId(int *device_id)
Get current GPU device ID.
OrtStatus * SessionGetOutputTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get output type information.
OrtStatus * KernelContext_GetScratchBuffer(const OrtKernelContext *context, const OrtMemoryInfo *mem_info, size_t count_or_bytes, void **out)
Get scratch buffer from the corresponding allocator under the specific OrtMemoryInfo object....
OrtStatus * Graph_GetOutputs(const OrtGraph *graph, const OrtValueInfo **outputs, size_t num_outputs)
Returns the graph's outputs as OrtValueInfo instances.
OrtStatus * EnableOrtCustomOps(OrtSessionOptions *options)
Enable custom operators.
OrtStatus * UpdateEnvWithCustomLogLevel(OrtEnv *ort_env, OrtLoggingLevel log_severity_level)
OrtStatus * Node_GetEpName(const OrtNode *node, const char **out)
Returns the execution provider name that this node is assigned to run on. Returns NULL if the node ha...
OrtStatus * SessionGetMemoryInfoForInputs(const OrtSession *session, const OrtMemoryInfo **inputs_memory_info, size_t num_inputs)
Get the OrtMemoryInfo for each input of the session.
OrtStatus * ReleaseSharedAllocator(OrtEnv *env, const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type)
Release a shared allocator from the OrtEnv for the OrtEpDevice and memory type.
OrtStatus * CreateValue(const OrtValue *const *in, size_t num_values, enum ONNXType value_type, OrtValue **out)
Create a map or sequence OrtValue.
OrtStatus * SessionOptionsAppendExecutionProvider_VitisAI(OrtSessionOptions *options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Append VitisAI provider to session options.
OrtStatus * RegisterCustomOpsUsingFunction(OrtSessionOptions *options, const char *registration_func_name)
Register custom ops by calling a RegisterCustomOpsFn function.
OrtStatus * RunOptionsSetTerminate(OrtRunOptions *options)
Set terminate flag.
OrtStatus * SetSessionLogVerbosityLevel(OrtSessionOptions *options, int session_log_verbosity_level)
Set session log verbosity level.
OrtStatus * SetSessionLogSeverityLevel(OrtSessionOptions *options, int session_log_severity_level)
Set session log severity level.
bool(* TensorTypeAndShape_HasShape)(const OrtTensorTypeAndShapeInfo *info)
Fetch whether the tensor has shape information.
Definition onnxruntime_c_api.h:6929
OrtStatus * GetNumHardwareDevices(const OrtEnv *env, size_t *num_devices)
Get the number of available hardware devices.
OrtStatus * CreateThreadingOptions(OrtThreadingOptions **out)
Create an OrtThreadingOptions.
OrtStatus * UseCsrIndices(OrtValue *ort_value, int64_t *inner_data, size_t inner_num, int64_t *outer_data, size_t outer_num)
OrtStatus * Graph_GetModelPath(const OrtGraph *graph, const char **model_path)
Get the filepath to the model from which an OrtGraph is constructed.
OrtStatus * KernelInfo_GetOperatorSinceVersion(const OrtKernelInfo *info, int *since_version)
Get the opset version in which the given node's operator type was first defined from OrtKernelInfo.
OrtStatus * SessionGetOverridableInitializerCount(const OrtSession *session, size_t *out)
Get overridable initializer count.
OrtStatus * GetValueInfoName(const OrtValueInfo *value_info, const char **name)
Get the value name from an OrtValueInfo instance.
OrtStatus * UnregisterExecutionProviderLibrary(OrtEnv *env, const char *registration_name)
Unregister an execution provider library with ORT.
OrtStatus * CreateSessionWithPrepackedWeightsContainer(const OrtEnv *env, const char *model_path, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container, OrtSession **out)
Create session with prepacked weights container.
OrtStatus * KernelInfo_GetLogger(const OrtKernelInfo *info, const OrtLogger **logger)
Get the session logger from OrtKernelInfo.
OrtStatus * UpdateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a TensorRT Execution Provider.
OrtStatus * KernelInfoGetAttribute_tensor(const OrtKernelInfo *info, const char *name, OrtAllocator *allocator, OrtValue **out)
Get a OrtValue tensor stored as an attribute in the graph node.
OrtStatus * EnableMemPattern(OrtSessionOptions *options)
Enable the memory pattern optimization.
OrtStatus * SetOptimizedModelFilePath(OrtSessionOptions *options, const char *optimized_model_filepath)
Set filepath to save optimized model after graph level transformations.
const OrtKeyValuePairs *(* EpDevice_EpOptions)(const OrtEpDevice *ep_device)
Get the execution provider options for the OrtEpDevice.
Definition onnxruntime_c_api.h:5758
OrtStatus * CreateAllocator(const OrtSession *session, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Create an allocator for an OrtSession following an OrtMemoryInfo.
OrtStatus * SynchronizeBoundOutputs(OrtIoBinding *binding_ptr)
Synchronize bound outputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * SessionGetOutputCount(const OrtSession *session, size_t *out)
Get output count for a session.
OrtStatus * EpAssignedNode_GetName(const OrtEpAssignedNode *ep_node, const char **out)
Get the name of the node assigned to an execution provider.
OrtStatus * CastTypeInfoToSequenceTypeInfo(const OrtTypeInfo *type_info, const OrtSequenceTypeInfo **out)
Cast OrtTypeInfo to an OrtSequenceTypeInfo.
OrtStatus * Run(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *inputs, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **outputs)
Run the model in an OrtSession.
OrtStatus * ValueInfo_IsGraphOutput(const OrtValueInfo *value_info, bool *is_graph_output)
Returns a boolean indicating if the given value is a graph output.
OrtStatus * GetValueType(const OrtValue *value, enum ONNXType *out)
Get ONNXType of an OrtValue.
OrtStatus * Node_GetImplicitInputs(const OrtNode *node, const OrtValueInfo **implicit_inputs, size_t num_implicit_inputs)
Get the implicit inputs, as OrtValueInfo instances, that are used within the given node's subgraphs.
OrtStatus * Node_GetNumImplicitInputs(const OrtNode *node, size_t *num_implicit_inputs)
Returns the number of node implicit inputs.
OrtStatus * ShapeInferContext_GetInputTypeShape(const OrtShapeInferContext *context, size_t index, OrtTensorTypeAndShapeInfo **info)
OrtStatus * EpAssignedSubgraph_GetNodes(const OrtEpAssignedSubgraph *ep_subgraph, const OrtEpAssignedNode *const **ep_nodes, size_t *num_ep_nodes)
Get the nodes in a subgraph assigned to a specific execution provider.
OrtStatus * CreateSyncStreamForEpDevice(const OrtEpDevice *ep_device, const OrtKeyValuePairs *stream_options, OrtSyncStream **stream)
Create an OrtSyncStream for the given OrtEpDevice.
OrtStatus * KernelInfo_GetNodeName(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node name from OrtKernelInfo.
OrtStatus * CreateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 **out)
Create an OrtTensorRTProviderOptionsV2.
OrtStatus * GetDimensions(const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)
Get dimensions in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionGetProfilingStartTimeNs(const OrtSession *session, uint64_t *out)
Return the time that profiling was started.
OrtStatus * RunOptionsUnsetTerminate(OrtRunOptions *options)
Clears the terminate flag.
OrtStatus * CreateOpaqueValue(const char *domain_name, const char *type_name, const void *data_container, size_t data_container_size, OrtValue **out)
Create an opaque (custom user defined type) OrtValue.
OrtStatus * GetSparseTensorValuesTypeAndShape(const OrtValue *ort_value, OrtTensorTypeAndShapeInfo **out)
Returns data type and shape of sparse tensor values (nnz) iff OrtValue contains a SparseTensor.
void(* ReleaseTensorRTProviderOptions)(OrtTensorRTProviderOptionsV2 *input)
Release an OrtTensorRTProviderOptionsV2.
Definition onnxruntime_c_api.h:3556
OrtStatus * Graph_GetNodes(const OrtGraph *graph, const OrtNode **nodes, size_t num_nodes)
Returns the graph's nodes as OrtNode instances.
OrtStatus * ReleaseAvailableProviders(char **ptr, int providers_length)
Release data from OrtApi::GetAvailableProviders. This API will never fail so you can rely on it in a ...
const char *(* ExternalInitializerInfo_GetFilePath)(const OrtExternalInitializerInfo *info)
Get the relative path to the file that stores the initializer's data.
Definition onnxruntime_c_api.h:6593
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:5740
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:5722
const OrtModelEditorApi *(* GetModelEditorApi)(void)
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:5447
OrtStatus * ValueInfo_GetValueProducer(const OrtValueInfo *value_info, const OrtNode **producer_node, size_t *producer_output_index)
Get the OrtNode that produces the value represented by the given OrtValueInfo. Optionally returns the...
OrtStatus * ModelMetadataGetVersion(const OrtModelMetadata *model_metadata, int64_t *value)
Get version number from an OrtModelMetadata.
OrtStatus * GetStringTensorContent(const OrtValue *value, void *s, size_t s_len, size_t *offsets, size_t offsets_len)
Get all strings from a string tensor.
OrtStatus * OpAttr_GetName(const OrtOpAttr *attribute, const char **name)
Get the attribute name from an OrtOpAttr.
OrtStatus * GetBoundOutputNames(const OrtIoBinding *binding_ptr, OrtAllocator *allocator, char **buffer, size_t **lengths, size_t *count)
Get the names of an OrtIoBinding's outputs.
OrtStatus * ValueInfo_IsRequiredGraphInput(const OrtValueInfo *value_info, bool *is_required_graph_input)
Returns a boolean indicating if the given value is a required graph input.
OrtStatus * Node_GetOutputs(const OrtNode *node, const OrtValueInfo **outputs, size_t num_outputs)
Returns the node's outputs as OrtValueInfo instances.
OrtStatus * CreateTensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo **out)
Create an OrtTensorTypeAndShapeInfo object.
OrtStatus * FillSparseTensorCoo(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *indices_data, size_t indices_num)
OrtStatus * SessionEndProfiling(OrtSession *session, OrtAllocator *allocator, char **out)
End profiling and return filename of the profile data.
OrtStatus * DeviceEpIncompatibilityDetails_GetNotes(const OrtDeviceEpIncompatibilityDetails *details, const char **notes)
Get the notes from OrtDeviceEpIncompatibilityDetails.
OrtStatus * ModelMetadataGetProducerName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get producer name from an OrtModelMetadata.
OrtStatus * GetCompatibilityInfoFromModelBytes(const void *model_data, size_t model_data_length, const char *ep_type, OrtAllocator *allocator, char **compatibility_info)
Extract EP compatibility info from precompiled model bytes in memory.
OrtStatus * SessionOptionsSetCustomCreateThreadFn(OrtSessionOptions *options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Set custom thread creation function.
OrtStatus * SetGlobalCustomCreateThreadFn(OrtThreadingOptions *tp_options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Set custom thread creation function for global thread pools.
OrtStatus * Node_GetSubgraphs(const OrtNode *node, const OrtGraph **subgraphs, size_t num_subgraphs, const char **attribute_names)
Get the subgraphs, as OrtGraph instances, contained by the given node.
OrtStatus * SessionOptionsAppendExecutionProvider_CUDA_V2(OrtSessionOptions *options, const OrtCUDAProviderOptionsV2 *cuda_options)
Append CUDA execution provider to the session options.
OrtStatus * CreateTensorAsOrtValue(OrtAllocator *allocator, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create a tensor.
void(* RemoveKeyValuePair)(OrtKeyValuePairs *kvps, const char *key)
Remove a key-value pair from the OrtKeyValuePairs instance.
Definition onnxruntime_c_api.h:5567
void *(* SyncStream_GetHandle)(OrtSyncStream *stream)
Get the native handle of the sync stream.
Definition onnxruntime_c_api.h:6841
OrtStatus * Graph_GetNumInitializers(const OrtGraph *graph, size_t *num_initializers)
Returns the number of graph initializers.
void(* ReleaseCUDAProviderOptions)(OrtCUDAProviderOptionsV2 *input)
Release an OrtCUDAProviderOptionsV2.
Definition onnxruntime_c_api.h:4059
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:1318
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:645
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:724
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:698
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:693
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:703
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:713
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:676
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:684
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:647
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:707
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:719
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:670
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:664
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:8046
OrtStatus * ModelCompilationOptions_SetFlags(OrtModelCompilationOptions *model_compile_options, uint32_t flags)
Sets flags from OrtCompileApiFlags that represent one or more boolean options to enable.
OrtStatus * ModelCompilationOptions_SetOutputModelWriteFunc(OrtModelCompilationOptions *model_compile_options, OrtWriteBufferFunc write_func, void *state)
Sets a OrtWriteBufferFunc function that is called by ORT to write out the output model's serialized O...
OrtStatus * ModelCompilationOptions_SetOutputModelBuffer(OrtModelCompilationOptions *model_compile_options, OrtAllocator *allocator, void **output_model_buffer_ptr, size_t *output_model_buffer_size_ptr)
Configures model compilation to store the output compiled ONNX model in a buffer.
OrtStatus * ModelCompilationOptions_SetInputModelFromBuffer(OrtModelCompilationOptions *model_compile_options, const void *input_model_data, size_t input_model_data_size)
Sets the buffer that stores the bytes of the loaded ONNX model to compile.
OrtStatus * ModelCompilationOptions_SetInputModelPath(OrtModelCompilationOptions *model_compile_options, const char *input_model_path)
Sets the file path to the input ONNX model to compile.
OrtStatus * ModelCompilationOptions_SetOutputModelExternalInitializersFile(OrtModelCompilationOptions *model_compile_options, const char *external_initializers_file_path, size_t external_initializers_size_threshold)
Optionally sets the file that should store external initializers for the compiled ONNX model....
OrtStatus * ModelCompilationOptions_SetInputModel(OrtModelCompilationOptions *model_compile_options, const OrtModel *model)
Sets the OrtModel to compile.
OrtStatus * ModelCompilationOptions_SetGraphOptimizationLevel(OrtModelCompilationOptions *model_compile_options, GraphOptimizationLevel graph_optimization_level)
OrtStatus * CreateModelCompilationOptionsFromSessionOptions(const OrtEnv *env, const OrtSessionOptions *session_options, OrtModelCompilationOptions **out)
Creates an OrtModelCompilationOptions object from an existing OrtSessionOptions object.
OrtStatus * ModelCompilationOptions_SetEpContextEmbedMode(OrtModelCompilationOptions *model_compile_options, bool embed_ep_context_in_model)
Enables or disables the embedding of EPContext binary data into the ep_cache_context attribute of EPC...
OrtStatus * ModelCompilationOptions_SetOutputModelPath(OrtModelCompilationOptions *model_compile_options, const char *output_model_path)
Sets the file path for the output ONNX model generated by CompileModel.
OrtStatus * ModelCompilationOptions_SetOutputModelGetInitializerLocationFunc(OrtModelCompilationOptions *model_compile_options, OrtGetInitializerLocationFunc get_initializer_location_func, void *state)
Sets a OrtGetInitializerLocationFunc function that is called by ORT for every initializer in the gene...
OrtStatus * CompileModel(const OrtEnv *env, const OrtModelCompilationOptions *model_options)
Compiles an input ONNX model with the given compilation options.
OrtStatus * ModelCompilationOptions_SetEpContextBinaryInformation(OrtModelCompilationOptions *model_compile_options, const char *output_directory, const char *model_name)
Definition onnxruntime_c_api.h:969
char __place_holder
Definition onnxruntime_c_api.h:970
Definition onnxruntime_c_api.h:7516
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7562
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7546
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7534
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7566
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7599
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7584
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7596
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7527
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7536
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:7542
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7571
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7553
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:7523
uint32_t version
Definition onnxruntime_c_api.h:7517
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7533
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7600
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7545
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7530
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7535
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7557
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:7581
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7585
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:7574
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7592
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7579
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7541
Configuration options for creating an OrtEnv.
Definition onnxruntime_c_api.h:1212
uint32_t version
Must be set to ORT_API_VERSION.
Definition onnxruntime_c_api.h:1213
const OrtKeyValuePairs * config_entries
Optional environment configuration entries represented as string key-value pairs. May be set to NULL.
Definition onnxruntime_c_api.h:1285
const OrtThreadingOptions * threading_options
Optional threading options for creating an environment with global thread pools shared across session...
Definition onnxruntime_c_api.h:1265
OrtLoggingFunction custom_logging_function
Optional custom logging function. May be set to NULL.
Definition onnxruntime_c_api.h:1244
void * custom_logging_param
Optional state to pass as the first argument to OrtEnvCreationOptions::custom_logger_function....
Definition onnxruntime_c_api.h:1251
const char * log_id
The log identifier. Must be set to a valid UTF-8 null-terminated string.
Definition onnxruntime_c_api.h:1233
int32_t logging_severity_level
The logging severity level for the environment. Must be set to a value from OrtLoggingLevel.
Definition onnxruntime_c_api.h:1225
The OrtEpApi struct provides functions that are relevant to the implementation of an execution provid...
Definition onnxruntime_ep_c_api.h:1021
Descriptor for importing external memory.
Definition onnxruntime_c_api.h:1081
OrtExternalMemoryHandleType handle_type
Definition onnxruntime_c_api.h:1083
size_t size_bytes
Definition onnxruntime_c_api.h:1085
void * native_handle
Definition onnxruntime_c_api.h:1084
uint32_t version
Definition onnxruntime_c_api.h:1082
size_t offset_bytes
Definition onnxruntime_c_api.h:1086
Base struct for imported external memory handles.
Definition onnxruntime_ep_c_api.h:54
Descriptor for importing external semaphores.
Definition onnxruntime_c_api.h:1107
void * native_handle
Definition onnxruntime_c_api.h:1110
OrtExternalSemaphoreType type
Definition onnxruntime_c_api.h:1109
uint32_t version
Definition onnxruntime_c_api.h:1108
Base struct for imported external semaphore handles.
Definition onnxruntime_ep_c_api.h:81
Descriptor for creating a tensor from imported external memory.
Definition onnxruntime_c_api.h:1185
ONNXTensorElementDataType element_type
Definition onnxruntime_c_api.h:1187
size_t offset_bytes
Definition onnxruntime_c_api.h:1190
uint32_t version
Definition onnxruntime_c_api.h:1186
size_t rank
Definition onnxruntime_c_api.h:1189
const int64_t * shape
Definition onnxruntime_c_api.h:1188
Configuration for initializing graphics interop on an EP factory.
Definition onnxruntime_c_api.h:1153
OrtGraphicsApi graphics_api
Definition onnxruntime_c_api.h:1155
const OrtKeyValuePairs * additional_options
Additional API-specific options (optional).
Definition onnxruntime_c_api.h:1175
uint32_t version
Definition onnxruntime_c_api.h:1154
void * command_queue
Command queue/submission queue for graphics workloads (optional).
Definition onnxruntime_c_api.h:1166
The OrtInteropApi struct provides functions for external resource interop with execution providers.
Definition onnxruntime_c_api.h:8342
OrtStatus * WaitSemaphore(OrtExternalResourceImporter *importer, OrtExternalSemaphoreHandle *semaphore_handle, OrtSyncStream *stream, uint64_t value)
Wait on an external semaphore on the EP's stream.
OrtStatus * CreateTensorFromMemory(OrtExternalResourceImporter *importer, const OrtExternalMemoryHandle *mem_handle, const OrtExternalTensorDescriptor *tensor_desc, OrtValue **out_tensor)
Create a tensor backed by imported external memory.
OrtStatus * InitGraphicsInteropForEpDevice(const OrtEpDevice *ep_device, const OrtGraphicsInteropConfig *config)
Initialize graphics interop for an execution provider device.
OrtStatus * ImportMemory(OrtExternalResourceImporter *importer, const OrtExternalMemoryDescriptor *desc, OrtExternalMemoryHandle **out_handle)
Import external memory into the execution provider.
OrtStatus * SignalSemaphore(OrtExternalResourceImporter *importer, OrtExternalSemaphoreHandle *semaphore_handle, OrtSyncStream *stream, uint64_t value)
Signal an external semaphore from the EP's stream.
OrtStatus * ImportSemaphore(OrtExternalResourceImporter *importer, const OrtExternalSemaphoreDescriptor *desc, OrtExternalSemaphoreHandle **out_handle)
Import an external semaphore into the execution provider.
OrtStatus * CanImportSemaphore(const OrtExternalResourceImporter *importer, OrtExternalSemaphoreType type, bool *out_supported)
Check if the external resource importer can import a specific semaphore type.
OrtStatus * CreateExternalResourceImporterForDevice(const OrtEpDevice *ep_device, OrtExternalResourceImporter **out_importer)
Create an external resource importer for a specific EP device.
OrtStatus * CanImportMemory(const OrtExternalResourceImporter *importer, OrtExternalMemoryHandleType handle_type, bool *out_supported)
Check if the external resource importer can import a specific memory handle type.
OrtStatus * DeinitGraphicsInteropForEpDevice(const OrtEpDevice *ep_device)
Deinitialize graphics interop for an execution provider device.
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:849
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:860
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:856
int migraphx_fp8_enable
Definition onnxruntime_c_api.h:852
int migraphx_int8_enable
Definition onnxruntime_c_api.h:853
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:858
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:851
int device_id
Definition onnxruntime_c_api.h:850
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:854
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:866
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:859
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:857
int migraphx_arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:874
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:855
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:7614
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 * 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 * AddInitializerToGraph(OrtGraph *graph, const char *name, const OrtValue *ort_value, bool data_is_external)
Add an initializer to the OrtGraph.
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:888
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:909
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:906
void * context
Definition onnxruntime_c_api.h:908
const char * cache_dir
Definition onnxruntime_c_api.h:907
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:903
const char * device_id
Definition onnxruntime_c_api.h:905
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:904
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:890
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:910
ROCM Provider Options.
Definition onnxruntime_c_api.h:732
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:752
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:813
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:780
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:794
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:763
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:734
int enable_hip_graph
Definition onnxruntime_c_api.h:796
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:802
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:790
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:771
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:808
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:785
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exhaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:757
TensorRT Provider Options.
Definition onnxruntime_c_api.h:821
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:835
void * user_compute_stream
Definition onnxruntime_c_api.h:824
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:822
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:836
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:837
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:825
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:827
int trt_dla_enable
Definition onnxruntime_c_api.h:832
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:830
int has_user_compute_stream
Definition onnxruntime_c_api.h:823
int trt_dla_core
Definition onnxruntime_c_api.h:833
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:831
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:826
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:839
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:834
int trt_fp16_enable
Definition onnxruntime_c_api.h:828
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:838
int trt_int8_enable
Definition onnxruntime_c_api.h:829
Configuration for thread pool work callbacks.
Definition onnxruntime_c_api.h:1038
void * user_context
Definition onnxruntime_c_api.h:1044
uint32_t version
Definition onnxruntime_c_api.h:1039
OrtThreadPoolWorkEnqueueFn on_enqueue
Definition onnxruntime_c_api.h:1040
OrtThreadPoolWorkStartFn on_start_work
Definition onnxruntime_c_api.h:1041
OrtThreadPoolWorkStopFn on_stop_work
Definition onnxruntime_c_api.h:1042
OrtThreadPoolWorkAbandonFn on_abandon
Definition onnxruntime_c_api.h:1043
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122