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
37#include "onnxruntime_error_code.h"
38
43#define ORT_API_VERSION 31
44
45#ifdef __cplusplus
46extern "C" {
47#endif
48
50// SAL2 Definitions
51#ifndef _MSC_VER
52#define _In_
53#define _In_z_
54#define _In_opt_
55#define _In_opt_z_
56#define _Out_
57#define _Out_opt_
58#define _Outptr_
59#define _Outptr_opt_
60#define _Inout_
61#define _Inout_opt_
62#define _Frees_ptr_opt_
63#define _Ret_maybenull_
64#define _Ret_notnull_
65#define _Check_return_
66#define _Outptr_result_maybenull_
67#define _Outptr_result_maybenull_z_
68#define _In_reads_(X)
69#define _In_reads_opt_
70#define _Inout_updates_(X)
71#define _Out_writes_(X)
72#define _Out_writes_opt_(X)
73#define _Inout_updates_all_(X)
74#define _Out_writes_bytes_all_(X)
75#define _Out_writes_all_(X)
76#define _Success_(X)
77#define _Outptr_result_buffer_maybenull_(X)
78#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
79#else
80#include <specstrings.h>
81#define ORT_ALL_ARGS_NONNULL
82#endif
83
84#ifdef _WIN32
85// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
86// dllexport is not used, we use a .def file.
87#ifdef ORT_DLL_IMPORT
88#define ORT_EXPORT __declspec(dllimport)
89#else
90#define ORT_EXPORT
91#endif
92#define ORT_API_CALL __stdcall
93#define ORT_MUST_USE_RESULT
94#define ORTCHAR_T wchar_t
95#else
96// Make symbols visible on non-Windows platforms. The visibility attribute is
97// needed when ORT is built as a shared library without a version script
98// (e.g. when compiled within another project's build system). On non-Apple
99// platforms, the default ORT build uses a generated version script
100// (tools/ci_build/gen_def.py) that exports the needed symbols, so this was
101// previously only enabled for __APPLE__. Expanding to __GNUC__ (GCC/Clang)
102// covers additional embedding scenarios while remaining harmless when a
103// version script is also in use.
104#if defined(__GNUC__)
105#define ORT_EXPORT __attribute__((visibility("default")))
106#else
107#define ORT_EXPORT
108#endif
109#define ORT_API_CALL
110#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
111#define ORTCHAR_T char
112#endif
113
116#ifndef ORT_TSTR
117#ifdef _WIN32
118#define ORT_TSTR(X) L##X
119// When X is a macro, L##X is not defined. In this case, we need to use ORT_TSTR_ON_MACRO.
120#define ORT_TSTR_ON_MACRO(X) L"" X
121#else
122#define ORT_TSTR(X) X
123#define ORT_TSTR_ON_MACRO(X) X
124#endif
125#endif
126
127// On Windows, ORT_FILE is a wchar_t version of the __FILE__ macro.
128// Otherwise, ORT_FILE is equivalent to __FILE__.
129#ifndef ORT_FILE
130#define ORT_FILE_INTERNAL(x) ORT_TSTR(x)
131#define ORT_FILE ORT_FILE_INTERNAL(__FILE__)
132#endif
133
134// Any pointer marked with _In_ or _Out_, cannot be NULL.
135
136// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
137// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
138// for ReleaseXXX(...) functions, they can accept NULL pointer.
139
140#ifdef __cplusplus
141// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
142// Such complex condition is needed because compilers set __cplusplus value differently.
143#ifndef __has_feature
144#define __has_feature(x) 0
145#endif
146#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
147#define NO_EXCEPTION noexcept
148#else
149#define NO_EXCEPTION throw()
150#endif
151#else
152#define NO_EXCEPTION
153#endif
154
155// __VA_ARGS__ on Windows and Linux are different
156#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
157
158#define ORT_API_T(RETURN_TYPE, NAME, ...) \
159 RETURN_TYPE(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION
160
161#define ORT_API_STATUS(NAME, ...) \
162 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
163 NO_EXCEPTION ORT_MUST_USE_RESULT
164
165// XXX: Unfortunately, SAL annotations are known to not work with function pointers
166#define ORT_API2_STATUS(NAME, ...) \
167 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
168
169// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
170#define ORT_API_STATUS_IMPL(NAME, ...) \
171 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
172
173#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
174
175#ifdef __DOXYGEN__
176#undef ORT_API_STATUS
177#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
178#undef ORT_API2_STATUS
179#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
180#undef ORT_CLASS_RELEASE
181#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
182#undef NO_EXCEPTION
183#define NO_EXCEPTION
184#endif
195 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
196 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
197 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
198 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
199 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
200 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
201 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
202 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
205 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
206 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
207 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
208 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
209 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
210 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16, // Non-IEEE floating-point format based on IEEE754 single-precision
211 // float 8 types were introduced in onnx 1.14, see https://onnx.ai/onnx/technical/float8.html
212 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN, // Non-IEEE floating-point format based on IEEE754 single-precision
213 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
214 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2, // Non-IEEE floating-point format based on IEEE754 single-precision
215 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
216 // Int4 types were introduced in ONNX 1.16. See https://onnx.ai/onnx/technical/int4.html
217 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4, // maps to a pair of packed uint4 values (size == 1 byte)
218 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4, // maps to a pair of packed int4 values (size == 1 byte)
219 // Float4 types were introduced in ONNX 1.18. See https://onnx.ai/onnx/technical/float4.html
220 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT4E2M1, // maps to a pair of packed float4 values (size == 1 byte)
221 // Int2 types were introduced in ONNX 1.20. See https://onnx.ai/onnx/technical/int2.html
222 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT2, // maps to 4 packed uint2 values (size == 1 byte)
223 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT2, // maps to 4 packed int2 values (size == 1 byte)
224 // Float8E8M0 type introduced in ONNX 1.21. 8-bit float with 8 exponent bits, 0 mantissa bits, no sign bit.
225 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E8M0, // Non-IEEE floating-point format, all values are powers of two
227
228// Synced with onnx TypeProto oneof
238
239// These types are synced with internal
240// SparseFormatFlags
247
248// Enum allows to query sparse tensor indices
255
267
279
281#define ORT_RUNTIME_CLASS(X) \
282 struct Ort##X; \
283 typedef struct Ort##X Ort##X
284
289// The actual types defined have an Ort prefix
290ORT_RUNTIME_CLASS(Env);
291ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
292ORT_RUNTIME_CLASS(MemoryInfo);
293ORT_RUNTIME_CLASS(IoBinding);
294ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
295ORT_RUNTIME_CLASS(Value);
296ORT_RUNTIME_CLASS(RunOptions);
297ORT_RUNTIME_CLASS(TypeInfo);
298ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
299ORT_RUNTIME_CLASS(MapTypeInfo);
300ORT_RUNTIME_CLASS(SequenceTypeInfo);
301ORT_RUNTIME_CLASS(OptionalTypeInfo);
302ORT_RUNTIME_CLASS(SessionOptions);
303ORT_RUNTIME_CLASS(CustomOpDomain);
304ORT_RUNTIME_CLASS(ModelMetadata);
305ORT_RUNTIME_CLASS(ThreadPoolParams);
306ORT_RUNTIME_CLASS(ThreadingOptions);
307ORT_RUNTIME_CLASS(ArenaCfg);
308ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
309ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
310ORT_RUNTIME_CLASS(NvTensorRtRtxProviderOptions);
311ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
312ORT_RUNTIME_CLASS(CANNProviderOptions);
313ORT_RUNTIME_CLASS(DnnlProviderOptions);
314ORT_RUNTIME_CLASS(Op);
315ORT_RUNTIME_CLASS(OpAttr);
316ORT_RUNTIME_CLASS(Logger);
317ORT_RUNTIME_CLASS(ShapeInferContext);
318ORT_RUNTIME_CLASS(LoraAdapter);
319ORT_RUNTIME_CLASS(ValueInfo);
320ORT_RUNTIME_CLASS(Node);
321ORT_RUNTIME_CLASS(Graph);
322ORT_RUNTIME_CLASS(Model);
323ORT_RUNTIME_CLASS(ModelCompilationOptions);
324ORT_RUNTIME_CLASS(HardwareDevice);
325ORT_RUNTIME_CLASS(EpDevice);
326ORT_RUNTIME_CLASS(KeyValuePairs);
327ORT_RUNTIME_CLASS(SyncStream); // Opaque class to create an onnxruntime::Stream.
328ORT_RUNTIME_CLASS(ExternalInitializerInfo);
329ORT_RUNTIME_CLASS(ExternalResourceImporter); // Capability object for external resource import
330ORT_RUNTIME_CLASS(ExternalMemoryHandle); // EP-imported view of shared external allocation
331ORT_RUNTIME_CLASS(ExternalSemaphoreHandle); // EP-imported view of shared external semaphore
332ORT_RUNTIME_CLASS(DeviceEpIncompatibilityDetails);
333ORT_RUNTIME_CLASS(EpAssignedSubgraph);
334ORT_RUNTIME_CLASS(EpAssignedNode);
335
336#ifdef _MSC_VER
337typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
338#else
340#endif
341
350typedef void(ORT_API_CALL* OrtExperimentalFnPtr)(void);
351
358typedef struct OrtAllocator {
359 uint32_t version;
360
362 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
363
365 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
366
368 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
379 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
380
406 ORT_API2_STATUS(GetStats, _In_ const struct OrtAllocator* this_, _Outptr_ OrtKeyValuePairs** out);
407
423 void*(ORT_API_CALL* AllocOnStream)(struct OrtAllocator* this_, size_t size, OrtSyncStream* stream);
424
439 ORT_API2_STATUS(Shrink, _In_ struct OrtAllocator* this_);
441
442typedef void(ORT_API_CALL* OrtLoggingFunction)(
443 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
444 const char* message);
445
458
463
476
477struct OrtKernelInfo;
479struct OrtKernelContext;
481struct OrtCustomOp;
483
490
493// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
504
510
519
525
537
547
567typedef OrtStatus*(ORT_API_CALL* EpSelectionDelegate)(_In_ const OrtEpDevice** ep_devices,
568 _In_ size_t num_devices,
569 _In_ const OrtKeyValuePairs* model_metadata,
570 _In_opt_ const OrtKeyValuePairs* runtime_metadata,
571 _Inout_ const OrtEpDevice** selected,
572 _In_ size_t max_selected,
573 _Out_ size_t* num_selected,
574 _In_ void* state);
575
586typedef OrtStatus*(ORT_API_CALL* OrtWriteBufferFunc)(_In_ void* state,
587 _In_ const void* buffer,
588 _In_ size_t buffer_num_bytes);
589
621 _In_ void* state,
622 _In_ const char* initializer_name,
623 _In_ const OrtValue* initializer_value,
624 _In_opt_ const OrtExternalInitializerInfo* external_info,
625 _Outptr_result_maybenull_ OrtExternalInitializerInfo** new_external_info);
626
630 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
631 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
632 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
634
721
810
817 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
818 void* user_compute_stream; // user specified CUDA compute stream.
819 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
820 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
821 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
822 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
823 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
824 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
825 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
826 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
827 int trt_dla_core; // DLA core number. Default 0
828 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
829 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
830 const char* trt_engine_cache_path; // specify engine cache path
831 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
832 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
833 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
834 // This is the legacy struct and don't add new fields here.
835 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
836 // For non-string field, need to create a new separate api to handle it.
838
844 int device_id; // hip device id.
845 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
846 int migraphx_fp8_enable; // MIGraphX FP8 precision. Default 0 = false, nonzero = true
847 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
848 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, nonzero = true
849 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
850 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, nonzero = true
851 const char* migraphx_save_model_path; // migraphx model path name
852 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, nonzero = true
853 const char* migraphx_load_model_path; // migraphx model path name
854 bool migraphx_exhaustive_tune; // MIGraphX tuned compile. Default = false, nonzero = true
855
861
869
870 // This is the legacy struct and don't add new fields here.
872
883#ifdef __cplusplus
892#endif
897 const char* device_type;
899 const char* device_id;
901 const char* cache_dir; // path is set to empty by default
902 void* context;
904 unsigned char enable_dynamic_shapes;
906
907struct OrtApi;
908typedef struct OrtApi OrtApi;
909
910struct OrtTrainingApi;
912
913struct OrtModelEditorApi;
915
916struct OrtCompileApi;
918
919struct OrtInteropApi;
921
922struct OrtEpApi;
923typedef struct OrtEpApi OrtEpApi;
924
939 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
940
945 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
946};
947
948typedef struct OrtApiBase OrtApiBase;
949
954ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
955
961typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
962
966
972typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
973
979typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
980
990typedef _Ret_maybenull_ void* (*OrtThreadPoolWorkEnqueueFn)(_In_opt_ void* user_context)NO_EXCEPTION;
991
1000typedef void (*OrtThreadPoolWorkStartFn)(_In_opt_ void* user_context, _In_opt_ void* enqueue_data) NO_EXCEPTION;
1001
1011typedef void (*OrtThreadPoolWorkStopFn)(_In_opt_ void* user_context, _In_opt_ void* enqueue_data) NO_EXCEPTION;
1012
1020typedef void (*OrtThreadPoolWorkAbandonFn)(_In_opt_ void* user_context, _In_opt_ void* enqueue_data) NO_EXCEPTION;
1021
1043
1044typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
1045
1053typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
1054
1072
1073// Previous enum values added for backwards compatibility
1074#ifndef ORT_EXTERNAL_MEMORY_HANDLE_TYPE_VK_MEMORY_WIN32
1075#define ORT_EXTERNAL_MEMORY_HANDLE_TYPE_VK_MEMORY_WIN32 ORT_EXTERNAL_MEMORY_HANDLE_TYPE_MEMORY_WIN32
1076#endif
1077#ifndef ORT_EXTERNAL_MEMORY_HANDLE_TYPE_VK_MEMORY_OPAQUE_FD
1078#define ORT_EXTERNAL_MEMORY_HANDLE_TYPE_VK_MEMORY_OPAQUE_FD ORT_EXTERNAL_MEMORY_HANDLE_TYPE_MEMORY_OPAQUE_FD
1079#endif
1080
1096
1106
1119
1133
1184
1201
1202/*
1203 * Public enum for compiled model compatibility across EPs.
1204 */
1211
1220 uint32_t version;
1221
1233
1240 const char* log_id;
1241
1252
1259
1273
1293
1294 //
1295 // End of fields available in ORT 1.24
1296 //
1297
1299
1307struct OrtApi {
1310
1318 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1319
1325 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1326
1332 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
1333
1337
1348 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1349
1364 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
1365 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
1366
1374 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
1382 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
1383
1387
1397 // TODO: document the path separator convention? '/' vs '\'
1398 // TODO: should specify the access characteristics of model_path. Is this read only during the
1399 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
1400 // and continue to access throughout the OrtSession lifetime?
1401 // What sort of access is needed to model_path : read or read/write?
1402 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
1403 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1404
1415 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env,
1416 _In_ const void* model_data, size_t model_data_length,
1417 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
1418
1437 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
1438 _In_reads_(input_len) const char* const* input_names,
1439 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
1440 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
1441 _Inout_updates_all_(output_names_len) OrtValue** outputs);
1442
1446
1462 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
1463
1471 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
1472 _In_ const ORTCHAR_T* optimized_model_filepath);
1473
1481 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
1482 _Outptr_ OrtSessionOptions** out_options);
1483
1495 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
1496
1504 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
1505
1512 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
1513
1527 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
1528
1537 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
1538
1547 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
1548
1555 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
1556
1564 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
1565
1575 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1576
1584 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1585
1594 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1595 GraphOptimizationLevel graph_optimization_level);
1596
1610 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1611
1624 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1625
1629
1637 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1638
1648 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1649
1653
1663 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1664
1681 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1682
1686
1698 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1699
1711 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1712
1722 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1723
1732 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1733
1742 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1743
1752 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1753
1763 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1764
1774 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1775
1785 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1786 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1787
1791
1798 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1799
1809 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1810
1818 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1819
1829 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1830
1840 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1841 _Out_ int* log_verbosity_level);
1842
1850 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1851
1863 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1864
1873 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1874
1883 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1884
1888
1901 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1903
1921 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1922 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1923 _Outptr_ OrtValue** out);
1924
1932 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1933
1944 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1945
1954 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1955
1965 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1966
1986 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1987 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1988
1992
2001 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
2002 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
2003
2011 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
2012
2016
2024
2033
2042 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
2043
2053 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
2055
2065 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
2066
2075 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
2076 size_t dim_values_length);
2077
2086 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
2087 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
2088
2105 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
2106
2110
2118 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
2119
2127 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
2128
2136 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
2137
2141
2152 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
2153 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
2154
2165 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
2166 _Outptr_ OrtMemoryInfo** out);
2167
2178 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
2179
2187 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
2188
2191 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
2192
2195 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
2196
2199 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
2200
2204
2206 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
2208 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
2210 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
2211
2220 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
2221
2225
2237 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
2238 _In_ int64_t dim_value);
2239
2243
2244 /* Internal information (not seen in Doxygen)
2245 *
2246 * APIs to support non-tensor types - map and sequence.
2247 * Currently only the following types are supported
2248 * Note: the following types should be kept in sync with data_types.h
2249 * Map types
2250 * =========
2251 * std::map<std::string, std::string>
2252 * std::map<std::string, int64_t>
2253 * std::map<std::string, float>
2254 * std::map<std::string, double>
2255 * std::map<int64_t, std::string>
2256 * std::map<int64_t, int64_t>
2257 * std::map<int64_t, float>
2258 * std::map<int64_t, double>
2259 *
2260 * Sequence types
2261 * ==============
2262 * std::vector<std::string>
2263 * std::vector<int64_t>
2264 * std::vector<float>
2265 * std::vector<double>
2266 * std::vector<std::map<std::string, float>>
2267 * std::vector<std::map<int64_t, float>
2268 */
2269
2284 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
2285 _Outptr_ OrtValue** out);
2286
2297 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
2298
2314 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
2315 enum ONNXType value_type, _Outptr_ OrtValue** out);
2316
2339 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
2340 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
2341
2356 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
2357 _Out_ void* data_container, size_t data_container_size);
2358
2363
2372 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2373 _Out_ float* out);
2374
2383 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2384 _Out_ int64_t* out);
2385
2406 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
2407 _Inout_ size_t* size);
2408
2413
2418 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2419
2424 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
2425
2437 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
2438 _Out_ const OrtValue** out);
2439
2453 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
2454 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
2455
2459 ORT_CLASS_RELEASE(Env);
2463 ORT_CLASS_RELEASE(Status);
2467 ORT_CLASS_RELEASE(MemoryInfo);
2471 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
2475 ORT_CLASS_RELEASE(Value);
2479 ORT_CLASS_RELEASE(RunOptions);
2483 ORT_CLASS_RELEASE(TypeInfo);
2487 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
2491 ORT_CLASS_RELEASE(SessionOptions);
2495 ORT_CLASS_RELEASE(CustomOpDomain);
2496
2500
2513 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
2514 _Out_ size_t* len);
2515
2529 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
2530 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
2531
2545 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
2546 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
2547
2551
2563 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
2564
2573 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2574
2578
2589 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2590 _Outptr_ OrtTypeInfo** type_info);
2591
2595 ORT_CLASS_RELEASE(MapTypeInfo);
2599 ORT_CLASS_RELEASE(SequenceTypeInfo);
2600
2604
2615 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2616
2624 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2625
2629
2638 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2639 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2640
2649 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2650 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2651
2660 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2661 _Outptr_ char** value);
2662
2671 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2672 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2673
2684 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2685 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2686
2694 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2695
2696 ORT_CLASS_RELEASE(ModelMetadata);
2697
2701
2715 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2716 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2717
2721
2731 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2732
2736
2742 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2743
2744 ORT_CLASS_RELEASE(ThreadingOptions);
2745
2749
2761 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2762 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2763
2767
2775 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2776 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2777 _In_ int64_t dim_value);
2778
2782
2794 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2795
2804 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2805 _In_ int providers_length);
2806
2810
2819 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2820
2830 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2831
2840 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2841
2845
2858 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2859 _In_z_ const char* config_key, _In_z_ const char* config_value);
2860
2864
2875 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2876 _Outptr_ OrtAllocator** out);
2877
2880 ORT_CLASS_RELEASE(Allocator);
2881
2885
2896 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2897
2909 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2910
2914
2917 ORT_CLASS_RELEASE(IoBinding);
2918
2929 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2930
2941 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2942
2958 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2959
2977 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2978 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2979
2997 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2998 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2999
3002 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
3003
3006 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
3007
3011
3027 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
3028
3032
3047 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
3048 _In_ const OrtArenaCfg* arena_cfg);
3049
3061 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
3062
3066
3076 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
3077
3081
3093 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
3094
3106 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
3107
3121 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
3122
3126
3141 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
3142 _In_ const OrtValue* val);
3143
3147
3163 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
3164 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
3165
3169
3180 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
3181
3192 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
3193
3204 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
3205
3209
3220 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
3221
3225
3238 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
3239 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
3240
3241 ORT_CLASS_RELEASE(ArenaCfg);
3242
3246
3258 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
3259 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
3260
3264
3275 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
3276
3280
3291 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
3292
3303 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
3304
3309
3332 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
3333 _Out_ float* out, _Inout_ size_t* size);
3334
3356 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
3357 _Out_ int64_t* out, _Inout_ size_t* size);
3358
3362
3394 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
3395 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
3396 _Outptr_ OrtArenaCfg** out);
3397
3401
3414 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
3415 _In_z_ const char* config_key, _In_z_ const char* config_value);
3416
3420
3434
3439 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
3440
3444
3462 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
3463 _In_ const OrtSessionOptions* options,
3464 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3465 _Outptr_ OrtSession** out);
3466
3485 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
3486 _In_ const void* model_data, size_t model_data_length,
3487 _In_ const OrtSessionOptions* options,
3488 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
3489 _Outptr_ OrtSession** out);
3490
3494
3513 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
3514
3518
3526
3542 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
3543 _In_reads_(num_keys) const char* const* provider_options_keys,
3544 _In_reads_(num_keys) const char* const* provider_options_values,
3545 _In_ size_t num_keys);
3546
3558 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3559
3564 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
3565
3569
3576 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
3577
3581
3597 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3598
3609 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3610 _In_ const OrtMemoryInfo* mem_info);
3611
3615
3624 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3625
3642 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3643 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3644
3662 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3663 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3664 _In_ const int64_t* indices_data, size_t indices_num);
3665
3685 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3686 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3687 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3688 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3689
3708 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3709 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3710 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3711 _In_ const int32_t* indices_data);
3712
3737 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3738 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3739 _In_ const int64_t* values_shape, size_t values_shape_len,
3741
3756 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3757
3774 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3775 _Inout_ int64_t* outer_data, size_t outer_num);
3776
3790 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3791
3799 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3800
3808 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3809
3817 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3818
3828 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3829
3839 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3843
3856 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3857
3862
3874 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3875
3879
3885 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3886
3890
3900 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3901
3903
3906
3913 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3914
3922 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3923
3931 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3933
3936
3943 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3944
3952 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3953
3961 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3963
3972 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3973
3982 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3983
3986
4007 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
4008
4012
4021 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
4022
4040 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
4041 _In_reads_(num_keys) const char* const* provider_options_keys,
4042 _In_reads_(num_keys) const char* const* provider_options_values,
4043 _In_ size_t num_keys);
4044
4059 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4060
4067 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
4068
4070
4083 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
4084
4106 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
4107 _In_reads_(num_initializers) const char* const* initializer_names,
4108 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
4109
4121 ORT_API2_STATUS(CreateOpAttr,
4122 _In_ const char* name,
4123 _In_ const void* data,
4124 _In_ int len,
4125 _In_ OrtOpAttrType type,
4126 _Outptr_ OrtOpAttr** op_attr);
4127
4128 /* \brief: Release op attribute
4129 *
4130 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
4131 *
4132 * \since Version 1.12.
4133 */
4134 ORT_CLASS_RELEASE(OpAttr);
4135
4153 ORT_API2_STATUS(CreateOp,
4154 _In_ const OrtKernelInfo* info,
4155 _In_z_ const char* op_name,
4156 _In_z_ const char* domain,
4157 int version,
4158 _In_reads_(type_constraint_count) const char** type_constraint_names,
4159 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
4160 int type_constraint_count,
4161 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
4162 int attr_count,
4163 int input_count,
4164 int output_count,
4165 _Outptr_ OrtOp** ort_op);
4166
4179 ORT_API2_STATUS(InvokeOp,
4180 _In_ const OrtKernelContext* context,
4181 _In_ const OrtOp* ort_op,
4182 _In_ const OrtValue* const* input_values,
4183 _In_ int input_count,
4184 _Inout_ OrtValue* const* output_values,
4185 _In_ int output_count);
4186
4187 /* \brief: Release an onnxruntime operator
4188 *
4189 * \param[in] Op Operator created by OrtApi::CreateOp
4190 *
4191 * \since Version 1.12.
4192 */
4193 ORT_CLASS_RELEASE(Op);
4194
4317 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
4318 _In_ const char* provider_name,
4319 _In_reads_(num_keys) const char* const* provider_options_keys,
4320 _In_reads_(num_keys) const char* const* provider_options_values,
4321 _In_ size_t num_keys);
4322
4323 /* \brief: Get a copy of kernel info
4324 *
4325 * \param[in] info Kernel info
4326 * \param[out] info_copy Copy of kernel info
4327 *
4328 * \since Version 1.12.
4329 */
4330 ORT_API2_STATUS(CopyKernelInfo,
4331 _In_ const OrtKernelInfo* info,
4332 _Outptr_ OrtKernelInfo** info_copy);
4333
4334 /* \brief: Release kernel info
4335 *
4336 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
4337 *
4338 * \since Version 1.12.
4339 */
4340 ORT_CLASS_RELEASE(KernelInfo);
4341
4344
4358 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
4359
4361
4374 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
4375
4384 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
4385
4397 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
4398 _In_reads_(num_keys) const char* const* provider_options_keys,
4399 _In_reads_(num_keys) const char* const* provider_options_values,
4400 _In_ size_t num_keys);
4401
4415 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
4416 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4417
4424 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
4425
4426 /* \brief Get OrtDevice type from MemoryInfo
4427 *
4428 * \since Version 1.14
4429 */
4430 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
4431
4432 /* \brief Update the OrtEnv instance with custom log severity level
4433 *
4434 * \param[in] ort_env The OrtEnv instance being used
4435 * \param[in] log_severity_level The log severity level.
4436 *
4437 * \since Version 1.14.
4438 */
4439 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
4440
4441 /* \brief Set affinities for intra op threads
4442 *
4443 * Affinity string follows format:
4444 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
4445 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
4446 * e.g. 1,2,3;4,5
4447 * 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.
4448 * To ease the configuration, an "interval" is also allowed:
4449 * e.g. 1-8;8-16;17-24
4450 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
4451 * Note:
4452 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
4453 * ort does not set affinity on the main thread which is started and managed by the calling app;
4454 * 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,
4455 * 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.
4456 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
4457 *
4458 * \since Version 1.14
4459 */
4460 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
4461
4480 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
4481
4506 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
4507 _In_ const char* registration_func_name);
4508
4512
4524 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4525
4537 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
4538
4563 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_opt_ char* out,
4564 _Inout_ size_t* size);
4565
4591 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_opt_ char* out,
4592 _Inout_ size_t* size);
4593
4606 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4607 _Outptr_ OrtTypeInfo** type_info);
4608
4621 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4622 _Outptr_ OrtTypeInfo** type_info);
4623
4636 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4637 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4638
4643
4659 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4660 _In_z_ const char* config_key, _Out_ int* out);
4661
4690 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4691 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4692
4694
4707 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4708
4717 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4718
4735 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4736 _In_reads_(num_keys) const char* const* provider_options_keys,
4737 _In_reads_(num_keys) const char* const* provider_options_values,
4738 _In_ size_t num_keys);
4739
4754 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4755
4760 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4761
4765
4788 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_opt_ char* out, _Inout_ size_t* size);
4789
4801 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4802
4807
4819 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4820
4825
4844 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4845 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4846 _In_z_ const char* func_name);
4847
4859 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4860
4862
4876 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4877
4898 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4899 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4900
4917 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4918 _Outptr_ OrtTypeInfo** out);
4919
4930 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4931
4942 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4943
4950 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4951
4954
4963 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4964
4982 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4983 _In_reads_(num_keys) const char* const* provider_options_keys,
4984 _In_reads_(num_keys) const char* const* provider_options_values,
4985 _In_ size_t num_keys);
4986
5001 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
5002
5009 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
5010
5024 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type,
5025 _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
5026 _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);
5027
5046 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
5047 _In_reads_(input_len) const char* const* input_names,
5048 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
5049 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
5050 _Inout_updates_all_(output_names_len) OrtValue** output,
5051 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
5052
5065 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
5066
5077 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
5078
5091 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
5092
5103 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
5104
5116 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
5117 _In_ int resource_id, _Outptr_ void** resource);
5118
5136 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
5137 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
5138
5147 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
5148
5158 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
5159
5169 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
5170
5180 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
5181
5191 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
5192
5206 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
5207
5218 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
5219
5231 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);
5232
5247 _In_ OrtSessionOptions* options,
5248 _In_reads_(num_keys) const char* const* provider_options_keys,
5249 _In_reads_(num_keys) const char* const* provider_options_values,
5250 _In_ size_t num_keys);
5251
5266 _In_ OrtSessionOptions* options,
5267 _In_reads_(num_keys) const char* const* provider_options_keys,
5268 _In_reads_(num_keys) const char* const* provider_options_values,
5269 _In_ size_t num_keys);
5270
5282 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
5283
5294 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
5295
5317 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
5318 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
5319 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
5320 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
5321 size_t num_external_initializer_files);
5322
5341 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
5342 _Outptr_ OrtLoraAdapter** out);
5343
5361 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
5362 _Outptr_ OrtLoraAdapter** out);
5363
5366 ORT_CLASS_RELEASE(LoraAdapter);
5367
5384 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
5385
5389
5404 ORT_API2_STATUS(SetEpDynamicOptions, _Inout_ OrtSession* sess, _In_reads_(kv_len) const char* const* keys,
5405 _In_reads_(kv_len) const char* const* values, _In_ size_t kv_len);
5406
5408
5412 ORT_CLASS_RELEASE(ValueInfo);
5413
5417 ORT_CLASS_RELEASE(Node);
5418
5422 ORT_CLASS_RELEASE(Graph);
5423
5427 ORT_CLASS_RELEASE(Model);
5428
5435 ORT_API2_STATUS(GetValueInfoName, _In_ const OrtValueInfo* value_info, _Out_ const char** name);
5436
5443 ORT_API2_STATUS(GetValueInfoTypeInfo, _In_ const OrtValueInfo* value_info, _Outptr_ const OrtTypeInfo** type_info);
5444
5453 const OrtModelEditorApi*(ORT_API_CALL* GetModelEditorApi)(void);
5454
5473 ORT_API2_STATUS(CreateTensorWithDataAndDeleterAsOrtValue, _In_ OrtAllocator* deleter,
5474 _In_ void* p_data, size_t p_data_len,
5475 _In_ const int64_t* shape, size_t shape_len,
5477 _Outptr_ OrtValue** out);
5478
5495 ORT_API2_STATUS(SessionOptionsSetLoadCancellationFlag, _Inout_ OrtSessionOptions* options,
5496 _In_ bool cancel);
5497
5511 const OrtCompileApi*(ORT_API_CALL* GetCompileApi)(void);
5512
5513 //
5514 // OrtKeyValuePairs
5515 //
5516
5525 void(ORT_API_CALL* CreateKeyValuePairs)(_Outptr_ OrtKeyValuePairs** out);
5526
5540 void(ORT_API_CALL* AddKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key, _In_ const char* value);
5541
5551 const char*(ORT_API_CALL* GetKeyValue)(_In_ const OrtKeyValuePairs* kvps, _In_ const char* key);
5552
5562 void(ORT_API_CALL* GetKeyValuePairs)(_In_ const OrtKeyValuePairs* kvps,
5563 _Outptr_ const char* const** keys, _Outptr_ const char* const** values,
5564 _Out_ size_t* num_entries);
5565
5573 void(ORT_API_CALL* RemoveKeyValuePair)(_In_ OrtKeyValuePairs* kvps, _In_ const char* key);
5574
5581 ORT_CLASS_RELEASE(KeyValuePairs);
5582
5596 ORT_API2_STATUS(RegisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name,
5597 _In_ const ORTCHAR_T* path);
5598
5613 ORT_API2_STATUS(UnregisterExecutionProviderLibrary, _In_ OrtEnv* env, _In_ const char* registration_name);
5614
5627 ORT_API2_STATUS(GetEpDevices, _In_ const OrtEnv* env,
5628 _Outptr_ const OrtEpDevice* const** ep_devices, _Out_ size_t* num_ep_devices);
5629
5649 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_V2, _In_ OrtSessionOptions* session_options,
5650 _In_ OrtEnv* env,
5651 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices, _In_ size_t num_ep_devices,
5652 _In_reads_(num_op_options) const char* const* ep_option_keys,
5653 _In_reads_(num_op_options) const char* const* ep_option_vals,
5654 size_t num_ep_options);
5655
5666 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicy, _In_ OrtSessionOptions* session_options,
5668
5679 ORT_API2_STATUS(SessionOptionsSetEpSelectionPolicyDelegate, _In_ OrtSessionOptions* session_options,
5680 _In_ EpSelectionDelegate delegate,
5681 _In_opt_ void* delegate_state);
5682
5691
5699 uint32_t(ORT_API_CALL* HardwareDevice_VendorId)(_In_ const OrtHardwareDevice* device);
5700
5708 const char*(ORT_API_CALL* HardwareDevice_Vendor)(_In_ const OrtHardwareDevice* device);
5709
5718 uint32_t(ORT_API_CALL* HardwareDevice_DeviceId)(_In_ const OrtHardwareDevice* device);
5719
5728 const OrtKeyValuePairs*(ORT_API_CALL* HardwareDevice_Metadata)(_In_ const OrtHardwareDevice* device);
5729
5737 const char*(ORT_API_CALL* EpDevice_EpName)(_In_ const OrtEpDevice* ep_device);
5738
5746 const char*(ORT_API_CALL* EpDevice_EpVendor)(_In_ const OrtEpDevice* ep_device);
5747
5755 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpMetadata)(_In_ const OrtEpDevice* ep_device);
5756
5764 const OrtKeyValuePairs*(ORT_API_CALL* EpDevice_EpOptions)(_In_ const OrtEpDevice* ep_device);
5765
5773 const OrtHardwareDevice*(ORT_API_CALL* EpDevice_Device)(_In_ const OrtEpDevice* ep_device);
5774
5779 const OrtEpApi*(ORT_API_CALL* GetEpApi)(void);
5780
5798 ORT_API2_STATUS(GetTensorSizeInBytes, _In_ const OrtValue* ort_value, _Out_ size_t* size);
5799
5814 ORT_API2_STATUS(AllocatorGetStats, _In_ const OrtAllocator* ort_allocator, _Outptr_ OrtKeyValuePairs** out);
5815
5836 ORT_API2_STATUS(CreateMemoryInfo_V2, _In_ const char* name, _In_ enum OrtMemoryInfoDeviceType device_type,
5837 _In_ uint32_t vendor_id, _In_ int32_t device_id, _In_ enum OrtDeviceMemoryType mem_type,
5838 _In_ size_t alignment, enum OrtAllocatorType allocator_type,
5839 _Outptr_ OrtMemoryInfo** out);
5840
5849
5857 ORT_API_T(uint32_t, MemoryInfoGetVendorId, _In_ const OrtMemoryInfo* ptr);
5858
5861
5872 ORT_API2_STATUS(ValueInfo_GetValueProducer, _In_ const OrtValueInfo* value_info,
5873 _Outptr_ const OrtNode** producer_node, _Out_opt_ size_t* producer_output_index);
5874
5890 ORT_API2_STATUS(ValueInfo_GetValueNumConsumers, _In_ const OrtValueInfo* value_info, _Out_ size_t* num_consumers);
5891
5918 ORT_API2_STATUS(ValueInfo_GetValueConsumers, _In_ const OrtValueInfo* value_info,
5919 _Out_writes_all_(num_consumers) const OrtNode** nodes,
5920 _Out_writes_all_(num_consumers) int64_t* input_indices,
5921 _In_ size_t num_consumers);
5922
5942 ORT_API2_STATUS(ValueInfo_GetInitializerValue, _In_ const OrtValueInfo* value_info,
5943 _Outptr_ const OrtValue** initializer_value);
5944
5960 ORT_API2_STATUS(ValueInfo_GetExternalInitializerInfo, _In_ const OrtValueInfo* value_info,
5961 _Outptr_result_maybenull_ OrtExternalInitializerInfo** info);
5962
5977 ORT_API2_STATUS(ValueInfo_IsRequiredGraphInput, _In_ const OrtValueInfo* value_info,
5978 _Out_ bool* is_required_graph_input);
5979
5993 ORT_API2_STATUS(ValueInfo_IsOptionalGraphInput, _In_ const OrtValueInfo* value_info,
5994 _Out_ bool* is_optional_graph_input);
5995
6005 ORT_API2_STATUS(ValueInfo_IsGraphOutput, _In_ const OrtValueInfo* value_info, _Out_ bool* is_graph_output);
6006
6021 ORT_API2_STATUS(ValueInfo_IsConstantInitializer, _In_ const OrtValueInfo* value_info,
6022 _Out_ bool* is_constant_initializer);
6023
6037 ORT_API2_STATUS(ValueInfo_IsFromOuterScope, _In_ const OrtValueInfo* value_info,
6038 _Out_ bool* is_from_outer_scope);
6039
6041
6044
6054 ORT_API2_STATUS(Graph_GetName, _In_ const OrtGraph* graph, _Outptr_ const char** graph_name);
6055
6069 ORT_API2_STATUS(Graph_GetModelPath, _In_ const OrtGraph* graph, _Outptr_ const ORTCHAR_T** model_path);
6070
6080 ORT_API2_STATUS(Graph_GetOnnxIRVersion, _In_ const OrtGraph* graph, _Out_ int64_t* onnx_ir_version);
6081
6095 ORT_API2_STATUS(Graph_GetNumOperatorSets, _In_ const OrtGraph* graph, _Out_ size_t* num_operator_sets);
6096
6117 ORT_API2_STATUS(Graph_GetOperatorSets, _In_ const OrtGraph* graph,
6118 _Out_writes_(num_operator_sets) const char** domains,
6119 _Out_writes_(num_operator_sets) int64_t* opset_versions, _In_ size_t num_operator_sets);
6120
6132 ORT_API2_STATUS(Graph_GetNumInputs, _In_ const OrtGraph* graph, _Out_ size_t* num_inputs);
6133
6148 ORT_API2_STATUS(Graph_GetInputs, _In_ const OrtGraph* graph,
6149 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6150
6160 ORT_API2_STATUS(Graph_GetNumOutputs, _In_ const OrtGraph* graph, _Out_ size_t* num_outputs);
6161
6174 ORT_API2_STATUS(Graph_GetOutputs, _In_ const OrtGraph* graph,
6175 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6176
6188 ORT_API2_STATUS(Graph_GetNumInitializers, _In_ const OrtGraph* graph, _Out_ size_t* num_initializers);
6189
6211 ORT_API2_STATUS(Graph_GetInitializers, _In_ const OrtGraph* graph,
6212 _Out_writes_(num_initializers) const OrtValueInfo** initializers,
6213 _In_ size_t num_initializers);
6214
6224 ORT_API2_STATUS(Graph_GetNumNodes, _In_ const OrtGraph* graph, _Out_ size_t* num_nodes);
6225
6241 ORT_API2_STATUS(Graph_GetNodes, _In_ const OrtGraph* graph,
6242 _Out_writes_(num_nodes) const OrtNode** nodes, _In_ size_t num_nodes);
6243
6257 ORT_API2_STATUS(Graph_GetParentNode, _In_ const OrtGraph* graph, _Outptr_result_maybenull_ const OrtNode** node);
6258
6274 ORT_API2_STATUS(Graph_GetGraphView, _In_ const OrtGraph* src_graph, _In_ const OrtNode** nodes,
6275 _In_ size_t num_nodes, _Outptr_ OrtGraph** dst_graph);
6276
6278
6281
6294 ORT_API2_STATUS(Node_GetId, _In_ const OrtNode* node, _Out_ size_t* node_id);
6295
6305 ORT_API2_STATUS(Node_GetName, _In_ const OrtNode* node, _Outptr_ const char** node_name);
6306
6316 ORT_API2_STATUS(Node_GetOperatorType, _In_ const OrtNode* node, _Outptr_ const char** operator_type);
6317
6327 ORT_API2_STATUS(Node_GetDomain, _In_ const OrtNode* node, _Outptr_ const char** domain_name);
6328
6338 ORT_API2_STATUS(Node_GetSinceVersion, _In_ const OrtNode* node, _Out_ int* since_version);
6339
6349 ORT_API2_STATUS(Node_GetNumInputs, _In_ const OrtNode* node, _Out_ size_t* num_inputs);
6350
6363 ORT_API2_STATUS(Node_GetInputs, _In_ const OrtNode* node,
6364 _Out_writes_(num_inputs) const OrtValueInfo** inputs, _In_ size_t num_inputs);
6365
6375 ORT_API2_STATUS(Node_GetNumOutputs, _In_ const OrtNode* node, _Out_ size_t* num_outputs);
6376
6389 ORT_API2_STATUS(Node_GetOutputs, _In_ const OrtNode* node,
6390 _Out_writes_(num_outputs) const OrtValueInfo** outputs, _In_ size_t num_outputs);
6391
6405 ORT_API2_STATUS(Node_GetNumImplicitInputs, _In_ const OrtNode* node, _Out_ size_t* num_implicit_inputs);
6406
6424 ORT_API2_STATUS(Node_GetImplicitInputs, _In_ const OrtNode* node,
6425 _Out_writes_(num_implicit_inputs) const OrtValueInfo** implicit_inputs,
6426 _In_ size_t num_implicit_inputs);
6427
6437 ORT_API2_STATUS(Node_GetNumAttributes, _In_ const OrtNode* node, _Out_ size_t* num_attributes);
6438
6456 ORT_API2_STATUS(Node_GetAttributes, _In_ const OrtNode* node,
6457 _Out_writes_(num_attributes) const OrtOpAttr** attributes, _In_ size_t num_attributes);
6458
6477 ORT_API2_STATUS(Node_GetAttributeByName, _In_ const OrtNode* node, _In_ const char* attribute_name,
6478 _Outptr_result_maybenull_ const OrtOpAttr** attribute);
6479
6490 ORT_API2_STATUS(OpAttr_GetTensorAttributeAsOrtValue, _In_ const OrtOpAttr* attribute,
6491 _Outptr_result_maybenull_ OrtValue** attr_tensor);
6492
6502 ORT_API2_STATUS(OpAttr_GetType, _In_ const OrtOpAttr* attribute, _Out_ OrtOpAttrType* type);
6503
6513 ORT_API2_STATUS(OpAttr_GetName, _In_ const OrtOpAttr* attribute, _Outptr_ const char** name);
6514
6526 ORT_API2_STATUS(Node_GetNumSubgraphs, _In_ const OrtNode* node, _Out_ size_t* num_subgraphs);
6527
6545 ORT_API2_STATUS(Node_GetSubgraphs, _In_ const OrtNode* node,
6546 _Out_writes_(num_subgraphs) const OrtGraph** subgraphs, _In_ size_t num_subgraphs,
6547 _Out_writes_opt_(num_subgraphs) const char** attribute_names);
6548
6564 ORT_API2_STATUS(Node_GetGraph, _In_ const OrtNode* node, _Outptr_result_maybenull_ const OrtGraph** graph);
6565
6577 ORT_API2_STATUS(Node_GetEpName, _In_ const OrtNode* node, _Outptr_result_maybenull_ const char** out);
6578
6580
6583
6590 ORT_CLASS_RELEASE(ExternalInitializerInfo);
6591
6603 ORT_API_T(const ORTCHAR_T*, ExternalInitializerInfo_GetFilePath, _In_ const OrtExternalInitializerInfo* info);
6604
6613
6622
6624
6627
6642 ORT_API_T(const char*, GetRunConfigEntry, _In_ const OrtRunOptions* options,
6643 _In_z_ const char* config_key);
6644
6646
6656 ORT_API_T(const OrtMemoryInfo*, EpDevice_MemoryInfo, _In_ const OrtEpDevice* ep_device,
6657 _In_ OrtDeviceMemoryType memory_type);
6658
6682 ORT_API2_STATUS(CreateSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6683 _In_ OrtDeviceMemoryType mem_type, _In_ OrtAllocatorType allocator_type,
6684 _In_opt_ const OrtKeyValuePairs* allocator_options,
6685 _Outptr_opt_ OrtAllocator** allocator);
6686
6705 ORT_API2_STATUS(GetSharedAllocator, _In_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
6706 _Outptr_result_maybenull_ OrtAllocator** allocator);
6707
6721 ORT_API2_STATUS(ReleaseSharedAllocator, _In_ OrtEnv* env, _In_ const OrtEpDevice* ep_device,
6722 _In_ OrtDeviceMemoryType mem_type);
6723
6736 ORT_API2_STATUS(GetTensorData, _In_ const OrtValue* value, _Outptr_ const void** out);
6737
6748 ORT_API2_STATUS(GetSessionOptionsConfigEntries, _In_ const OrtSessionOptions* options, _Outptr_ OrtKeyValuePairs** out);
6749
6767 ORT_API2_STATUS(SessionGetMemoryInfoForInputs, _In_ const OrtSession* session,
6768 _Out_writes_(num_inputs) const OrtMemoryInfo** inputs_memory_info,
6769 _In_ size_t num_inputs);
6770
6790 ORT_API2_STATUS(SessionGetMemoryInfoForOutputs, _In_ const OrtSession* session,
6791 _Out_writes_(num_outputs) const OrtMemoryInfo** outputs_memory_info,
6792 _In_ size_t num_outputs);
6793
6818 ORT_API2_STATUS(SessionGetEpDeviceForInputs, _In_ const OrtSession* session,
6819 _Out_writes_(num_inputs) const OrtEpDevice** inputs_ep_devices,
6820 _In_ size_t num_inputs);
6821
6837 ORT_API2_STATUS(CreateSyncStreamForEpDevice, _In_ const OrtEpDevice* ep_device,
6838 _In_opt_ const OrtKeyValuePairs* stream_options,
6839 _Outptr_ OrtSyncStream** stream);
6840
6851 ORT_API_T(void*, SyncStream_GetHandle, _In_ OrtSyncStream* stream);
6852
6853 ORT_CLASS_RELEASE(SyncStream);
6854
6879 ORT_API2_STATUS(CopyTensors, _In_ const OrtEnv* env,
6880 _In_reads_(num_tensors) const OrtValue* const* src_tensors,
6881 _In_reads_(num_tensors) OrtValue* const* dst_tensors,
6882 _In_opt_ OrtSyncStream* stream,
6883 _In_ size_t num_tensors);
6884
6894 ORT_API2_STATUS(Graph_GetModelMetadata, _In_ const OrtGraph* graph, _Outptr_ OrtModelMetadata** out);
6895
6908 ORT_API2_STATUS(GetModelCompatibilityForEpDevices,
6909 _In_reads_(num_ep_devices) const OrtEpDevice* const* ep_devices,
6910 _In_ size_t num_ep_devices,
6911 _In_ const char* compatibility_info,
6913
6916
6929 ORT_API2_STATUS(CreateExternalInitializerInfo, _In_ const ORTCHAR_T* filepath, _In_ int64_t file_offset,
6930 _In_ size_t byte_size, _Outptr_ OrtExternalInitializerInfo** out);
6931
6933
6939 ORT_API_T(bool, TensorTypeAndShape_HasShape, _In_ const OrtTensorTypeAndShapeInfo* info);
6940
6956 ORT_API2_STATUS(KernelInfo_GetConfigEntries, _In_ const OrtKernelInfo* info, _Outptr_ OrtKeyValuePairs** out);
6957
6979 ORT_API2_STATUS(KernelInfo_GetOperatorDomain, _In_ const OrtKernelInfo* info, _Out_opt_ char* out,
6980 _Inout_ size_t* size);
6981
7003 ORT_API2_STATUS(KernelInfo_GetOperatorType, _In_ const OrtKernelInfo* info, _Out_opt_ char* out,
7004 _Inout_ size_t* size);
7005
7014 ORT_API2_STATUS(KernelInfo_GetOperatorSinceVersion, _In_ const OrtKernelInfo* info,
7015 _Out_ int* since_version);
7016
7027 const OrtInteropApi*(ORT_API_CALL* GetInteropApi)(void);
7028
7050 ORT_API2_STATUS(SessionGetEpDeviceForOutputs, _In_ const OrtSession* session,
7051 _Out_writes_(num_outputs) const OrtEpDevice** outputs_ep_devices,
7052 _In_ size_t num_outputs);
7065 ORT_API2_STATUS(GetNumHardwareDevices, _In_ const OrtEnv* env, _Out_ size_t* num_devices);
7066
7086 ORT_API2_STATUS(GetHardwareDevices, _In_ const OrtEnv* env,
7087 _Out_writes_(num_devices) const OrtHardwareDevice** devices,
7088 _In_ size_t num_devices);
7089
7111 ORT_API2_STATUS(GetHardwareDeviceEpIncompatibilityDetails, _In_ const OrtEnv* env,
7112 _In_ const char* ep_name,
7113 _In_ const OrtHardwareDevice* hw,
7115
7119
7130 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7131 _Out_ uint32_t* reasons_bitmask);
7132
7144 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7145 _Outptr_result_maybenull_ const char** notes);
7146
7160 _In_ const OrtDeviceEpIncompatibilityDetails* details,
7161 _Out_ int32_t* error_code);
7162
7167 ORT_CLASS_RELEASE(DeviceEpIncompatibilityDetails);
7168
7170
7173
7205 ORT_API2_STATUS(GetCompatibilityInfoFromModel,
7206 _In_ const ORTCHAR_T* model_path,
7207 _In_ const char* ep_type,
7208 _Inout_ OrtAllocator* allocator,
7209 _Outptr_result_maybenull_ char** compatibility_info);
7210
7233 ORT_API2_STATUS(GetCompatibilityInfoFromModelBytes,
7234 _In_reads_(model_data_length) const void* model_data,
7235 _In_ size_t model_data_length,
7236 _In_ const char* ep_type,
7237 _Inout_ OrtAllocator* allocator,
7238 _Outptr_result_maybenull_ char** compatibility_info);
7239
7241
7254 ORT_API2_STATUS(CreateEnvWithOptions, _In_ const OrtEnvCreationOptions* options, _Outptr_ OrtEnv** out);
7255
7285 ORT_API2_STATUS(Session_GetEpGraphAssignmentInfo, _In_ const OrtSession* session,
7286 _Outptr_ const OrtEpAssignedSubgraph* const** ep_subgraphs,
7287 _Out_ size_t* num_ep_subgraphs);
7288
7299 ORT_API2_STATUS(EpAssignedSubgraph_GetEpName, _In_ const OrtEpAssignedSubgraph* ep_subgraph,
7300 _Outptr_ const char** out);
7301
7312 ORT_API2_STATUS(EpAssignedSubgraph_GetNodes, _In_ const OrtEpAssignedSubgraph* ep_subgraph,
7313 _Outptr_ const OrtEpAssignedNode* const** ep_nodes, _Out_ size_t* num_ep_nodes);
7314
7325 ORT_API2_STATUS(EpAssignedNode_GetName, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7326
7337 ORT_API2_STATUS(EpAssignedNode_GetDomain, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7338
7349 ORT_API2_STATUS(EpAssignedNode_GetOperatorType, _In_ const OrtEpAssignedNode* ep_node, _Outptr_ const char** out);
7350
7362 ORT_API_T(void, RunOptionsSetSyncStream, _Inout_ OrtRunOptions* options, _In_ OrtSyncStream* sync_stream);
7363
7384 ORT_API2_STATUS(GetTensorElementTypeAndShapeDataReference, _In_ const OrtValue* value,
7385 _Out_ ONNXTensorElementDataType* elem_type,
7386 _Outptr_result_maybenull_ const int64_t** shape_data,
7387 _Out_ size_t* shape_data_count);
7388
7399 ORT_API2_STATUS(RunOptionsEnableProfiling, _Inout_ OrtRunOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
7400
7409 ORT_API2_STATUS(RunOptionsDisableProfiling, _Inout_ OrtRunOptions* options);
7410
7430 ORT_API2_STATUS(KernelInfoGetAttributeArray_string, _In_ const OrtKernelInfo* info, _In_ const char* name,
7431 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*size) char*** out, _Out_ size_t* size);
7432
7435
7454 ORT_API2_STATUS(SetPerSessionThreadPoolCallbacks, _Inout_ OrtEnv* env,
7455 _In_ const OrtThreadPoolCallbacksConfig* config);
7456
7458
7470 ORT_API2_STATUS(GetMemPatternEnabled, _In_ const OrtSessionOptions* options, _Out_ int* out);
7471
7483 ORT_API2_STATUS(GetSessionExecutionMode, _In_ const OrtSessionOptions* options, _Out_ ExecutionMode* out);
7484
7498 ORT_API2_STATUS(SessionReleaseCapturedGraph, _In_ OrtSession* session, _In_ int graph_annotation_id);
7499
7515 ORT_API_T(OrtExperimentalFnPtr, GetExperimentalFunction, _In_ const char* name);
7516
7535 ORT_API2_STATUS(KernelContext_GetSyncStream, _In_ const OrtKernelContext* context,
7536 _Outptr_result_maybenull_ OrtSyncStream** out);
7537
7561 ORT_API2_STATUS(SessionOptionsSetWeightlessSourceModelBuffer, _Inout_ OrtSessionOptions* options,
7562 _In_ const void* source_model_data, _In_ size_t source_model_data_length);
7563
7593 ORT_API2_STATUS(KernelContext_GetPreallocatedOutput, _In_ const OrtKernelContext* context, _In_ size_t output_index,
7594 _Outptr_result_maybenull_ OrtValue** output);
7595};
7596
7597/*
7598 * Steps to use a custom op:
7599 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
7600 * 2 Create an OrtCustomOp structure for each op and add them to the domain
7601 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
7602 */
7603
7604// Specifies some characteristics of inputs/outputs of custom ops:
7605// Specify if the inputs/outputs are one of:
7606// 1) Non-optional (input/output must be present in the node)
7607// 2) Optional (input/output may be absent in the node)
7608// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
7609// Only the last input or output of a custom op may be marked as variadic.
7610// The homogeneity of the variadic input or output determines whether all operands must be of the same
7611// tensor element type.
7617
7618/*
7619 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
7620 * the implementor of the custom op.
7621 */
7623 uint32_t version; // Initialize to ORT_API_VERSION. ORT will cap the API version used to select the OrtApi passed
7624 // to CreateKernel/CreateKernelV2 callbacks, so custom ops compiled against a newer ORT can load
7625 // on an older runtime if they only use APIs available at the runtime version. Newer OrtCustomOp
7626 // function pointers are gated by per-function version checks within ORT.
7627
7628 // This callback creates the kernel, which is a user defined
7629 // parameter that is passed to the Kernel* callbacks below. It is
7630 // recommended to use CreateKernelV2 which allows for a safe error
7631 // propagation by returning an OrtStatusPtr.
7632 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
7633 _In_ const OrtKernelInfo* info);
7634
7635 // Returns the name of the op
7636 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
7637
7638 // Returns the type of the execution provider, return nullptr to use CPU execution provider
7639 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
7640
7641 // Returns the count and types of the input & output tensors
7642 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7643 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
7644 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7645 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
7646
7647 // Perform a computation step. It is recommended to use
7648 // KernelComputeV2 which allows for a safe error propagation by
7649 // returning an OrtStatusPtr.
7650 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
7651 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
7652
7653 // Returns the characteristics of the input & output tensors
7654 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7655 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7656
7657 // Returns the memory type of the input tensors. This API allows the custom op
7658 // to place the inputs on specific devices. By default, it returns
7659 // OrtMemTypeDefault, which means the input is placed on the default device for
7660 // the execution provider. If the inputs need to be with different memory types,
7661 // this function can be overridden to return the specific memory types.
7662 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
7663
7664 // Returns the minimum number of input arguments expected for the variadic input.
7665 // Applicable only for custom ops that have a variadic input.
7666 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
7667
7668 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
7669 // and false (zero) otherwise.
7670 // Applicable only for custom ops that have a variadic input.
7671 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
7672
7673 // Returns the minimum number of output values expected for the variadic output.
7674 // Applicable only for custom ops that have a variadic output.
7675 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
7676
7677 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
7678 // and false (zero) otherwise.
7679 // Applicable only for custom ops that have a variadic output.
7680 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
7681
7682 // Create the kernel state which is passed to each compute call.
7683 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
7684 _In_ const OrtKernelInfo* info,
7685 _Out_ void** kernel);
7686
7687 // Perform the computation step.
7688 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
7689
7690 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
7691
7692 // Get start range
7693 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
7694 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
7695
7696 // Get the inplace_map that defines which output can reuse which input
7697 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
7698 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
7699 // The return value is the size of these 2 arrays.
7700 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
7701 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
7702
7703 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
7704 // If GetMayInplace() is defined, this function MUST be defined as well.
7705 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
7706
7707 // Same as GetMayInplace() and ReleaseMayInplace()
7708 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
7709 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
7710};
7711
7724 // Model building/editing requires a full build. We return nullptr from GetModelEditorApi if this is a minimal
7725 // build, so it doesn't matter if there are no function pointers in this struct as a user will never get an
7726 // OrtModelEditorApi instance. We do however need a dummy field to avoid empty struct warning.
7727#if defined(ORT_MINIMAL_BUILD)
7728 const bool not_defined_in_this_build;
7729#else
7743 ORT_API2_STATUS(CreateTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
7744 _Outptr_ OrtTypeInfo** type_info);
7745
7759 ORT_API2_STATUS(CreateSparseTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
7760 _Outptr_ OrtTypeInfo** type_info);
7761
7776 ORT_API2_STATUS(CreateMapTypeInfo, ONNXTensorElementDataType map_key_type, _In_ const OrtTypeInfo* map_value_type,
7777 _Outptr_ OrtTypeInfo** type_info);
7778
7792 ORT_API2_STATUS(CreateSequenceTypeInfo, _In_ const OrtTypeInfo* sequence_type, _Outptr_ OrtTypeInfo** type_info);
7793
7807 ORT_API2_STATUS(CreateOptionalTypeInfo, _In_ const OrtTypeInfo* contained_type, _Outptr_ OrtTypeInfo** type_info);
7808
7819 ORT_API2_STATUS(CreateValueInfo, _In_ const char* name, _In_ const OrtTypeInfo* type_info,
7820 _Outptr_ OrtValueInfo** value_info);
7821
7843 ORT_API2_STATUS(CreateNode, _In_ const char* operator_name, _In_ const char* domain_name, _In_ const char* node_name,
7844 _In_reads_(input_names_len) const char* const* input_names, size_t input_names_len,
7845 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
7846 _In_reads_(attribs_len) _In_opt_ OrtOpAttr** attributes, _In_ size_t attribs_len,
7847 _Outptr_ OrtNode** node);
7848
7853 ORT_API2_STATUS(CreateGraph, _Outptr_ OrtGraph** graph);
7854
7873 ORT_API2_STATUS(SetGraphInputs, _Inout_ OrtGraph* graph,
7874 _In_reads_(inputs_len) _Inout_ OrtValueInfo** inputs, _In_ size_t inputs_len);
7875
7894 ORT_API2_STATUS(SetGraphOutputs, _Inout_ OrtGraph* graph,
7895 _In_reads_(outputs_len) _Inout_ OrtValueInfo** outputs, _In_ size_t outputs_len);
7896
7941 ORT_API2_STATUS(AddInitializerToGraph, _Inout_ OrtGraph* graph, _In_ const char* name, _Inout_ OrtValue* tensor,
7942 bool data_is_external);
7943
7959 ORT_API2_STATUS(AddNodeToGraph, _Inout_ OrtGraph* graph, _Inout_ OrtNode* node);
7960
7979 ORT_API2_STATUS(CreateModel,
7980 _In_reads_(opset_entries_len) const char* const* domain_names,
7981 _In_reads_(opset_entries_len) const int* opset_versions,
7982 size_t opset_entries_len,
7983 _Outptr_ OrtModel** model);
7984
8002 ORT_API2_STATUS(AddGraphToModel, _Inout_ OrtModel* model, _Inout_ OrtGraph* graph);
8003
8022 ORT_API2_STATUS(CreateSessionFromModel, _In_ const OrtEnv* env, _In_ const OrtModel* model,
8023 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
8024
8047 ORT_API2_STATUS(CreateModelEditorSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
8048 _In_ const OrtSessionOptions* options,
8049 _Outptr_ OrtSession** out);
8050
8075 ORT_API2_STATUS(CreateModelEditorSessionFromArray, _In_ const OrtEnv* env,
8076 _In_ const void* model_data, size_t model_data_length,
8077 _In_ const OrtSessionOptions* options,
8078 _Outptr_ OrtSession** out);
8079
8094 ORT_API2_STATUS(SessionGetOpsetForDomain, _In_ const OrtSession* session, _In_ const char* domain, _Out_ int* opset);
8095
8114 ORT_API2_STATUS(ApplyModelToModelEditorSession, _Inout_ OrtSession* session, _In_ OrtModel* model);
8115
8129 ORT_API2_STATUS(FinalizeModelEditorSession, _Inout_ OrtSession* session, _In_ const OrtSessionOptions* options,
8130 _In_opt_ OrtPrepackedWeightsContainer* prepacked_weights_container);
8131#endif // !defined(ORT_MINIMAL_BUILD)
8132};
8133
8141 // Default. Do not enable any additional compilation options.
8143
8144 // Force compilation to return an error (ORT_FAIL) if no nodes were compiled.
8145 // Otherwise, a model with basic optimizations (ORT_ENABLE_BASIC) is still generated by default.
8147
8148 // Force compilation to return an error (ORT_FAIL) if a file with the same filename as the output model exists.
8149 // Otherwise, compilation will automatically overwrite the output file if it exists.
8152
8179 ORT_CLASS_RELEASE(ModelCompilationOptions);
8180
8199 ORT_API2_STATUS(CreateModelCompilationOptionsFromSessionOptions, _In_ const OrtEnv* env,
8200 _In_ const OrtSessionOptions* session_options, _Outptr_ OrtModelCompilationOptions** out);
8201
8214 ORT_API2_STATUS(ModelCompilationOptions_SetInputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
8215 _In_ const ORTCHAR_T* input_model_path);
8216
8231 _In_ OrtModelCompilationOptions* model_compile_options,
8232 _In_ const void* input_model_data,
8233 size_t input_model_data_size);
8234
8252 ORT_API2_STATUS(ModelCompilationOptions_SetOutputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
8253 _In_ const ORTCHAR_T* output_model_path);
8254
8271 _In_ OrtModelCompilationOptions* model_compile_options,
8272 _In_ const ORTCHAR_T* external_initializers_file_path,
8273 size_t external_initializers_size_threshold);
8274
8297 _In_ OrtModelCompilationOptions* model_compile_options,
8298 _Inout_ OrtAllocator* allocator,
8299 _Outptr_ void** output_model_buffer_ptr,
8300 _Out_ size_t* output_model_buffer_size_ptr);
8301
8324 ORT_API2_STATUS(ModelCompilationOptions_SetEpContextEmbedMode, _In_ OrtModelCompilationOptions* model_compile_options,
8325 bool embed_ep_context_in_model);
8326
8336 ORT_API2_STATUS(CompileModel, _In_ const OrtEnv* env, _In_ const OrtModelCompilationOptions* model_options);
8337
8347 ORT_API2_STATUS(ModelCompilationOptions_SetFlags, _In_ OrtModelCompilationOptions* model_compile_options,
8348 uint32_t flags);
8349
8364 _In_ OrtModelCompilationOptions* model_compile_options,
8365 _In_ const ORTCHAR_T* output_directory,
8366 _In_ const ORTCHAR_T* model_name);
8367
8378 _In_ OrtModelCompilationOptions* model_compile_options,
8379 _In_ GraphOptimizationLevel graph_optimization_level);
8380
8399 _In_ OrtModelCompilationOptions* model_compile_options,
8400 _In_ OrtWriteBufferFunc write_func, _In_ void* state);
8401
8415 _In_ OrtModelCompilationOptions* model_compile_options,
8416 _In_ OrtGetInitializerLocationFunc get_initializer_location_func, _In_ void* state);
8417
8438 _In_ OrtModelCompilationOptions* model_compile_options,
8439 _In_ const OrtModel* model);
8440
8463 _In_ OrtModelCompilationOptions* model_compile_options,
8464 _In_ bool use_weightless);
8465};
8466
8500
8520 _In_ const OrtEpDevice* ep_device,
8521 _Outptr_result_maybenull_ OrtExternalResourceImporter** out_importer);
8522
8529 ORT_CLASS_RELEASE(ExternalResourceImporter);
8530
8534
8545 ORT_API2_STATUS(CanImportMemory,
8546 _In_ const OrtExternalResourceImporter* importer,
8547 _In_ OrtExternalMemoryHandleType handle_type,
8548 _Out_ bool* out_supported);
8549
8561 ORT_API2_STATUS(ImportMemory,
8562 _In_ OrtExternalResourceImporter* importer,
8563 _In_ const OrtExternalMemoryDescriptor* desc,
8564 _Outptr_ OrtExternalMemoryHandle** out_handle);
8565
8572 ORT_CLASS_RELEASE(ExternalMemoryHandle);
8573
8589 ORT_API2_STATUS(CreateTensorFromMemory,
8590 _In_ OrtExternalResourceImporter* importer,
8591 _In_ const OrtExternalMemoryHandle* mem_handle,
8592 _In_ const OrtExternalTensorDescriptor* tensor_desc,
8593 _Outptr_ OrtValue** out_tensor);
8594
8598
8609 ORT_API2_STATUS(CanImportSemaphore,
8610 _In_ const OrtExternalResourceImporter* importer,
8611 _In_ OrtExternalSemaphoreType type,
8612 _Out_ bool* out_supported);
8613
8627 ORT_API2_STATUS(ImportSemaphore,
8628 _In_ OrtExternalResourceImporter* importer,
8629 _In_ const OrtExternalSemaphoreDescriptor* desc,
8630 _Outptr_ OrtExternalSemaphoreHandle** out_handle);
8631
8638 ORT_CLASS_RELEASE(ExternalSemaphoreHandle);
8639
8655 ORT_API2_STATUS(WaitSemaphore,
8656 _In_ OrtExternalResourceImporter* importer,
8657 _In_ OrtExternalSemaphoreHandle* semaphore_handle,
8658 _In_ OrtSyncStream* stream,
8659 _In_ uint64_t value);
8660
8676 ORT_API2_STATUS(SignalSemaphore,
8677 _In_ OrtExternalResourceImporter* importer,
8678 _In_ OrtExternalSemaphoreHandle* semaphore_handle,
8679 _In_ OrtSyncStream* stream,
8680 _In_ uint64_t value);
8681
8685
8707 ORT_API2_STATUS(InitGraphicsInteropForEpDevice, _In_ const OrtEpDevice* ep_device,
8708 _In_ const OrtGraphicsInteropConfig* config);
8709
8726 ORT_API2_STATUS(DeinitGraphicsInteropForEpDevice, _In_ const OrtEpDevice* ep_device);
8727
8729};
8730
8731/*
8732 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
8733 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
8734 *
8735 * \param device_id CUDA device id, starts from zero.
8736 */
8737ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
8738
8739/*
8740 * This is the old way to add the ROCm provider to the session, please use
8741 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
8742 * This function always exists, but will only succeed if Onnxruntime was built with
8743 * HIP support and the ROCm provider shared library exists
8744 *
8745 * \param device_id HIP device id, starts from zero.
8746 */
8747ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
8748
8749/*
8750 * This is the old way to add the MIGraphX provider to the session, please use
8751 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
8752 * This function always exists, but will only succeed if Onnxruntime was built with
8753 * HIP support and the MIGraphX provider shared library exists
8754 *
8755 * \param device_id HIP device id, starts from zero.
8756 */
8757ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
8758
8759/*
8760 * This is the old way to add the oneDNN provider to the session, please use
8761 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
8762 * This function always exists, but will only succeed if Onnxruntime was built with
8763 * oneDNN support and the oneDNN provider shared library exists
8764 *
8765 * \param use_arena zero: false. non-zero: true.
8766 */
8767ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
8768
8769/*
8770 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
8771 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
8772 *
8773 * \param device_id CUDA device id, starts from zero.
8774 */
8775ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
8776
8777#ifdef __cplusplus
8778}
8779#endif
8781
8782#include "onnxruntime_ep_c_api.h"
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
void(* OrtExperimentalFnPtr)(void)
Generic function pointer type for experimental API lookup.
Definition onnxruntime_c_api.h:350
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:292
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:318
struct OrtHardwareDevice OrtHardwareDevice
Definition onnxruntime_c_api.h:324
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:478
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:320
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Tensorrt(OrtSessionOptions *options, int device_id)
struct OrtEpAssignedNode OrtEpAssignedNode
Definition onnxruntime_c_api.h:334
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:260
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:513
struct OrtModelCompilationOptions OrtModelCompilationOptions
Definition onnxruntime_c_api.h:323
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:317
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:442
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:979
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:1044
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:7612
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:309
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:315
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:306
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:300
OrtGraphicsApi
Graphics API type for interop configuration.
Definition onnxruntime_c_api.h:1128
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:467
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:319
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:313
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:249
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:308
OrtExternalMemoryHandleType
External memory handle type for importing GPU/NPU resources.
Definition onnxruntime_c_api.h:1061
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:294
OrtCompiledModelCompatibility
Definition onnxruntime_c_api.h:1205
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:567
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:303
OrtExternalSemaphoreType
External semaphore type for GPU synchronization.
Definition onnxruntime_c_api.h:1101
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:293
struct OrtExternalInitializerInfo OrtExternalInitializerInfo
Definition onnxruntime_c_api.h:328
OrtAllocatorType
Definition onnxruntime_c_api.h:484
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:314
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:304
OrtDeviceEpIncompatibilityReason
Reasons why an execution provider might not be compatible with a device.
Definition onnxruntime_c_api.h:540
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:297
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:298
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:311
void(* OrtThreadPoolWorkStartFn)(void *user_context, void *enqueue_data)
Thread pool work start callback.
Definition onnxruntime_c_api.h:1000
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:480
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:629
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:312
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:325
struct OrtExternalResourceImporter OrtExternalResourceImporter
Definition onnxruntime_c_api.h:329
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:1053
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:296
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:520
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:322
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:321
struct OrtSyncStream OrtSyncStream
Definition onnxruntime_c_api.h:327
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:961
struct OrtEpAssignedSubgraph OrtEpAssignedSubgraph
Definition onnxruntime_c_api.h:333
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:301
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:302
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:506
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:295
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:586
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:451
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:326
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:339
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:494
OrtSparseFormat
Definition onnxruntime_c_api.h:241
ONNXType
Definition onnxruntime_c_api.h:229
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:290
OrtErrorCode
Error codes reported by ONNX Runtime.
Definition onnxruntime_error_code.h:19
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:291
struct OrtDeviceEpIncompatibilityDetails OrtDeviceEpIncompatibilityDetails
Definition onnxruntime_c_api.h:332
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:620
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:316
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:299
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:307
ExecutionMode
Definition onnxruntime_c_api.h:459
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:268
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:972
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:193
OrtCompileApiFlags
Flags representing options to enable when compiling a model.
Definition onnxruntime_c_api.h:8140
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:528
void *(* OrtThreadPoolWorkEnqueueFn)(void *user_context)
Thread pool work enqueue callback.
Definition onnxruntime_c_api.h:990
void(* OrtThreadPoolWorkStopFn)(void *user_context, void *enqueue_data)
Thread pool work stop callback.
Definition onnxruntime_c_api.h:1011
void(* OrtThreadPoolWorkAbandonFn)(void *user_context, void *enqueue_data)
Thread pool work abandon callback.
Definition onnxruntime_c_api.h:1020
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:261
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition onnxruntime_c_api.h:262
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition onnxruntime_c_api.h:264
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:263
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition onnxruntime_c_api.h:265
@ OrtMemoryInfoDeviceType_GPU
Definition onnxruntime_c_api.h:515
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:516
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:514
@ OrtMemoryInfoDeviceType_NPU
Definition onnxruntime_c_api.h:517
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:7615
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:7613
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:7614
@ ORT_GRAPHICS_API_D3D12
Definition onnxruntime_c_api.h:1130
@ ORT_GRAPHICS_API_VULKAN
Definition onnxruntime_c_api.h:1131
@ ORT_GRAPHICS_API_NONE
Definition onnxruntime_c_api.h:1129
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:468
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:471
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:469
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:473
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:470
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:472
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:474
@ ORT_SPARSE_COO_INDICES
Definition onnxruntime_c_api.h:250
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition onnxruntime_c_api.h:253
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition onnxruntime_c_api.h:252
@ ORT_SPARSE_CSR_INNER_INDICES
Definition onnxruntime_c_api.h:251
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE
Definition onnxruntime_c_api.h:1062
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP
Definition onnxruntime_c_api.h:1063
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_MEMORY_OPAQUE_FD
Definition onnxruntime_c_api.h:1066
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_HOST_ALLOCATION
Definition onnxruntime_c_api.h:1068
@ ORT_EXTERNAL_MEMORY_HANDLE_TYPE_MEMORY_WIN32
Definition onnxruntime_c_api.h:1064
@ OrtCompiledModelCompatibility_EP_SUPPORTED_PREFER_RECOMPILATION
Definition onnxruntime_c_api.h:1208
@ OrtCompiledModelCompatibility_EP_NOT_APPLICABLE
Definition onnxruntime_c_api.h:1206
@ OrtCompiledModelCompatibility_EP_SUPPORTED_OPTIMAL
Definition onnxruntime_c_api.h:1207
@ OrtCompiledModelCompatibility_EP_UNSUPPORTED
Definition onnxruntime_c_api.h:1209
@ ORT_EXTERNAL_SEMAPHORE_VK_TIMELINE_SEMAPHORE_WIN32
Definition onnxruntime_c_api.h:1103
@ ORT_EXTERNAL_SEMAPHORE_VK_TIMELINE_SEMAPHORE_OPAQUE_FD
Definition onnxruntime_c_api.h:1104
@ ORT_EXTERNAL_SEMAPHORE_D3D12_FENCE
Definition onnxruntime_c_api.h:1102
@ OrtDeviceAllocator
Definition onnxruntime_c_api.h:486
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:487
@ OrtReadOnlyAllocator
Definition onnxruntime_c_api.h:488
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:485
@ OrtDeviceEpIncompatibility_DEVICE_INCOMPATIBLE
Definition onnxruntime_c_api.h:543
@ OrtDeviceEpIncompatibility_MISSING_DEPENDENCY
Definition onnxruntime_c_api.h:544
@ OrtDeviceEpIncompatibility_DRIVER_INCOMPATIBLE
Definition onnxruntime_c_api.h:542
@ OrtDeviceEpIncompatibility_NONE
Definition onnxruntime_c_api.h:541
@ OrtDeviceEpIncompatibility_UNKNOWN
Definition onnxruntime_c_api.h:545
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:632
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:630
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:631
@ OrtHardwareDeviceType_CPU
Definition onnxruntime_c_api.h:521
@ OrtHardwareDeviceType_NPU
Definition onnxruntime_c_api.h:523
@ OrtHardwareDeviceType_GPU
Definition onnxruntime_c_api.h:522
@ OrtDeviceMemoryType_HOST_ACCESSIBLE
Shared/pinned memory for transferring between CPU and the device.
Definition onnxruntime_c_api.h:508
@ OrtDeviceMemoryType_DEFAULT
Device memory.
Definition onnxruntime_c_api.h:507
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:453
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:456
@ ORT_ENABLE_LAYOUT
Definition onnxruntime_c_api.h:455
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:452
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:454
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:496
@ OrtMemTypeCPU
CPU accessible memory allocated by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:500
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:502
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. HOST_ACCESSIBLE.
Definition onnxruntime_c_api.h:498
@ ORT_SPARSE_CSRC
Definition onnxruntime_c_api.h:244
@ ORT_SPARSE_COO
Definition onnxruntime_c_api.h:243
@ ORT_SPARSE_BLOCK_SPARSE
Definition onnxruntime_c_api.h:245
@ ORT_SPARSE_UNDEFINED
Definition onnxruntime_c_api.h:242
@ ONNX_TYPE_SEQUENCE
Definition onnxruntime_c_api.h:232
@ ONNX_TYPE_MAP
Definition onnxruntime_c_api.h:233
@ ONNX_TYPE_OPAQUE
Definition onnxruntime_c_api.h:234
@ ONNX_TYPE_UNKNOWN
Definition onnxruntime_c_api.h:230
@ ONNX_TYPE_TENSOR
Definition onnxruntime_c_api.h:231
@ ONNX_TYPE_SPARSETENSOR
Definition onnxruntime_c_api.h:235
@ ONNX_TYPE_OPTIONAL
Definition onnxruntime_c_api.h:236
@ ORT_PARALLEL
Definition onnxruntime_c_api.h:461
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:460
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:270
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:273
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:275
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:269
@ ORT_OP_ATTR_GRAPH
Definition onnxruntime_c_api.h:276
@ ORT_OP_ATTR_TENSOR
Definition onnxruntime_c_api.h:277
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:271
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:274
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:272
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition onnxruntime_c_api.h:202
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition onnxruntime_c_api.h:200
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition onnxruntime_c_api.h:206
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E8M0
Definition onnxruntime_c_api.h:225
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT2
Definition onnxruntime_c_api.h:222
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition onnxruntime_c_api.h:198
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition onnxruntime_c_api.h:194
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition onnxruntime_c_api.h:209
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ
Definition onnxruntime_c_api.h:215
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition onnxruntime_c_api.h:207
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4
Definition onnxruntime_c_api.h:217
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition onnxruntime_c_api.h:201
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT4E2M1
Definition onnxruntime_c_api.h:220
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2
Definition onnxruntime_c_api.h:214
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition onnxruntime_c_api.h:203
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition onnxruntime_c_api.h:204
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition onnxruntime_c_api.h:196
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition onnxruntime_c_api.h:199
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition onnxruntime_c_api.h:205
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition onnxruntime_c_api.h:197
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:195
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN
Definition onnxruntime_c_api.h:212
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition onnxruntime_c_api.h:210
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4
Definition onnxruntime_c_api.h:218
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition onnxruntime_c_api.h:208
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ
Definition onnxruntime_c_api.h:213
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT2
Definition onnxruntime_c_api.h:223
@ OrtCompileApiFlags_NONE
Definition onnxruntime_c_api.h:8142
@ OrtCompileApiFlags_ERROR_IF_NO_NODES_COMPILED
Definition onnxruntime_c_api.h:8146
@ OrtCompileApiFlags_ERROR_IF_OUTPUT_FILE_EXISTS
Definition onnxruntime_c_api.h:8150
@ OrtExecutionProviderDevicePolicy_DEFAULT
Definition onnxruntime_c_api.h:529
@ OrtExecutionProviderDevicePolicy_PREFER_CPU
Definition onnxruntime_c_api.h:530
@ OrtExecutionProviderDevicePolicy_MAX_PERFORMANCE
Definition onnxruntime_c_api.h:533
@ OrtExecutionProviderDevicePolicy_PREFER_NPU
Definition onnxruntime_c_api.h:531
@ OrtExecutionProviderDevicePolicy_MAX_EFFICIENCY
Definition onnxruntime_c_api.h:534
@ OrtExecutionProviderDevicePolicy_PREFER_GPU
Definition onnxruntime_c_api.h:532
@ OrtExecutionProviderDevicePolicy_MIN_OVERALL_POWER
Definition onnxruntime_c_api.h:535
Memory allocation interface.
Definition onnxruntime_c_api.h:358
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:365
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:368
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:359
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:362
void *(* AllocOnStream)(struct OrtAllocator *this_, size_t size, OrtSyncStream *stream)
Allocate using a stream.
Definition onnxruntime_c_api.h:423
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:379
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:929
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:945
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:939
The C API.
Definition onnxruntime_c_api.h:1307
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:5690
void(* ReleaseDnnlProviderOptions)(OrtDnnlProviderOptions *input)
Release an OrtDnnlProviderOptions.
Definition onnxruntime_c_api.h:4760
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:4950
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:5779
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:5708
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:4358
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:3002
const char *(* GetRunConfigEntry)(const OrtRunOptions *options, const char *config_key)
Get a run configuration entry.
Definition onnxruntime_c_api.h:6643
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:5562
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 * KernelContext_GetSyncStream(const OrtKernelContext *context, OrtSyncStream **out)
Get the framework synchronization stream associated with a kernel context.
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:5773
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:5857
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:4430
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:6657
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:7362
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:6612
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:5009
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:7027
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:4424
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:5699
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 * KernelContext_GetPreallocatedOutput(const OrtKernelContext *context, size_t output_index, OrtValue **output)
Get a preallocated output tensor without allocating an output.
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:5540
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:6621
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:1332
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:5551
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 * SessionOptionsSetWeightlessSourceModelBuffer(OrtSessionOptions *options, const void *source_model_data, size_t source_model_data_length)
Set the source ONNX model as a byte buffer for weightless EPContext sessions.
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:5737
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:5718
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:5755
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:5848
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:3006
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:5525
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:1318
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:5511
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:6939
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.
OrtExperimentalFnPtr(* GetExperimentalFunction)(const char *name)
Retrieve an experimental function pointer by name.
Definition onnxruntime_c_api.h:7515
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:5764
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:3564
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:6603
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:5746
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:5728
const OrtModelEditorApi *(* GetModelEditorApi)(void)
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:5453
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:5573
void *(* SyncStream_GetHandle)(OrtSyncStream *stream)
Get the native handle of the sync stream.
Definition onnxruntime_c_api.h:6851
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:4067
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:1325
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:639
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:718
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:692
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:687
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:697
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:707
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:670
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:678
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:641
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:701
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:713
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:664
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:658
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:8176
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_SetWeightlessEnabled(OrtModelCompilationOptions *model_compile_options, bool use_weightless)
Enable or disable weightless mode for model compilation.
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:963
char __place_holder
Definition onnxruntime_c_api.h:964
Definition onnxruntime_c_api.h:7622
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7671
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7655
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7643
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7675
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7708
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7693
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7705
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7636
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7645
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:7651
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7680
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7662
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:7632
uint32_t version
Definition onnxruntime_c_api.h:7623
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7642
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7709
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7654
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7639
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7644
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7666
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:7690
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7694
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:7683
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7701
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7688
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7650
Configuration options for creating an OrtEnv.
Definition onnxruntime_c_api.h:1219
uint32_t version
Must be set to ORT_API_VERSION.
Definition onnxruntime_c_api.h:1220
const OrtKeyValuePairs * config_entries
Optional environment configuration entries represented as string key-value pairs. May be set to NULL.
Definition onnxruntime_c_api.h:1292
const OrtThreadingOptions * threading_options
Optional threading options for creating an environment with global thread pools shared across session...
Definition onnxruntime_c_api.h:1272
OrtLoggingFunction custom_logging_function
Optional custom logging function. May be set to NULL.
Definition onnxruntime_c_api.h:1251
void * custom_logging_param
Optional state to pass as the first argument to OrtEnvCreationOptions::custom_logger_function....
Definition onnxruntime_c_api.h:1258
const char * log_id
The log identifier. Must be set to a valid UTF-8 null-terminated string.
Definition onnxruntime_c_api.h:1240
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:1232
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:1088
OrtExternalMemoryHandleType handle_type
Definition onnxruntime_c_api.h:1090
size_t size_bytes
Definition onnxruntime_c_api.h:1092
void * native_handle
Definition onnxruntime_c_api.h:1091
uint32_t version
Definition onnxruntime_c_api.h:1089
size_t offset_bytes
Definition onnxruntime_c_api.h:1093
Base struct for imported external memory handles.
Definition onnxruntime_ep_c_api.h:54
Descriptor for importing external semaphores.
Definition onnxruntime_c_api.h:1114
void * native_handle
Definition onnxruntime_c_api.h:1117
OrtExternalSemaphoreType type
Definition onnxruntime_c_api.h:1116
uint32_t version
Definition onnxruntime_c_api.h:1115
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:1192
ONNXTensorElementDataType element_type
Definition onnxruntime_c_api.h:1194
size_t offset_bytes
Definition onnxruntime_c_api.h:1197
uint32_t version
Definition onnxruntime_c_api.h:1193
size_t rank
Definition onnxruntime_c_api.h:1196
const int64_t * shape
Definition onnxruntime_c_api.h:1195
Configuration for initializing graphics interop on an EP factory.
Definition onnxruntime_c_api.h:1160
OrtGraphicsApi graphics_api
Definition onnxruntime_c_api.h:1162
const OrtKeyValuePairs * additional_options
Additional API-specific options (optional).
Definition onnxruntime_c_api.h:1182
uint32_t version
Definition onnxruntime_c_api.h:1161
void * command_queue
Command queue/submission queue for graphics workloads (optional).
Definition onnxruntime_c_api.h:1173
The OrtInteropApi struct provides functions for external resource interop with execution providers.
Definition onnxruntime_c_api.h:8497
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:843
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:854
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:850
int migraphx_fp8_enable
Definition onnxruntime_c_api.h:846
int migraphx_int8_enable
Definition onnxruntime_c_api.h:847
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:852
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:845
int device_id
Definition onnxruntime_c_api.h:844
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:848
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:860
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:853
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:851
int migraphx_arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:868
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:849
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:7723
OrtStatus * CreateModel(const char *const *domain_names, const int *opset_versions, size_t opset_entries_len, OrtModel **model)
Create an OrtModel.
OrtStatus * CreateGraph(OrtGraph **graph)
Create an OrtGraph.
OrtStatus * ApplyModelToModelEditorSession(OrtSession *session, OrtModel *model)
Apply changes to augment the ONNX model in a session created using CreateModelEditorSession[FromArray...
OrtStatus * AddInitializerToGraph(OrtGraph *graph, const char *name, OrtValue *tensor, bool data_is_external)
Add an initializer to the OrtGraph.
OrtStatus * SessionGetOpsetForDomain(const OrtSession *session, const char *domain, int *opset)
Query the session for the opset version of a domain.
OrtStatus * CreateValueInfo(const char *name, const OrtTypeInfo *type_info, OrtValueInfo **value_info)
Create an OrtValueInfo for use as an OrtGraph input or output.
OrtStatus * CreateModelEditorSessionFromArray(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession to augment an existing model.
OrtStatus * CreateSequenceTypeInfo(const OrtTypeInfo *sequence_type, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a Sequence.
OrtStatus * CreateOptionalTypeInfo(const OrtTypeInfo *contained_type, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for an Optional.
OrtStatus * AddGraphToModel(OrtModel *model, OrtGraph *graph)
Add an OrtGraph to an OrtModel.
OrtStatus * FinalizeModelEditorSession(OrtSession *session, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Finalize the Model Editor session that was created using CreateModelEditorSession[FromArray].
OrtStatus * CreateMapTypeInfo(ONNXTensorElementDataType map_key_type, const OrtTypeInfo *map_value_type, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a Map.
OrtStatus * CreateSparseTensorTypeInfo(const OrtTensorTypeAndShapeInfo *tensor_info, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a SparseTensor.
OrtStatus * CreateNode(const char *operator_name, const char *domain_name, const char *node_name, const char *const *input_names, size_t input_names_len, const char *const *output_names, size_t output_names_len, OrtOpAttr **attributes, size_t attribs_len, OrtNode **node)
Create an OrtNode to add to an OrtGraph.
OrtStatus * CreateModelEditorSession(const OrtEnv *env, const char *model_path, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession to augment an existing model.
OrtStatus * CreateSessionFromModel(const OrtEnv *env, const OrtModel *model, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession using the OrtModel.
OrtStatus * SetGraphOutputs(OrtGraph *graph, OrtValueInfo **outputs, size_t outputs_len)
Set the outputs for the OrtGraph.
OrtStatus * CreateTensorTypeInfo(const OrtTensorTypeAndShapeInfo *tensor_info, OrtTypeInfo **type_info)
Create an OrtTypeInfo instance for a Tensor.
OrtStatus * AddNodeToGraph(OrtGraph *graph, OrtNode *node)
Add an OrtNode to an OrtGraph.
OrtStatus * SetGraphInputs(OrtGraph *graph, OrtValueInfo **inputs, size_t inputs_len)
Set the inputs for the OrtGraph.
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:882
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:903
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:900
void * context
Definition onnxruntime_c_api.h:902
const char * cache_dir
Definition onnxruntime_c_api.h:901
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:897
const char * device_id
Definition onnxruntime_c_api.h:899
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:898
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:884
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:904
ROCM Provider Options.
Definition onnxruntime_c_api.h:726
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:746
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:807
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:774
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:788
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:757
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:728
int enable_hip_graph
Definition onnxruntime_c_api.h:790
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:796
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:784
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:765
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:802
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:779
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exhaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:751
TensorRT Provider Options.
Definition onnxruntime_c_api.h:815
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:829
void * user_compute_stream
Definition onnxruntime_c_api.h:818
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:816
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:830
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:831
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:819
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:821
int trt_dla_enable
Definition onnxruntime_c_api.h:826
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:824
int has_user_compute_stream
Definition onnxruntime_c_api.h:817
int trt_dla_core
Definition onnxruntime_c_api.h:827
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:825
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:820
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:833
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:828
int trt_fp16_enable
Definition onnxruntime_c_api.h:822
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:832
int trt_int8_enable
Definition onnxruntime_c_api.h:823
Configuration for thread pool work callbacks.
Definition onnxruntime_c_api.h:1032
void * user_context
Definition onnxruntime_c_api.h:1038
uint32_t version
Definition onnxruntime_c_api.h:1033
OrtThreadPoolWorkEnqueueFn on_enqueue
Definition onnxruntime_c_api.h:1034
OrtThreadPoolWorkStartFn on_start_work
Definition onnxruntime_c_api.h:1035
OrtThreadPoolWorkStopFn on_stop_work
Definition onnxruntime_c_api.h:1036
OrtThreadPoolWorkAbandonFn on_abandon
Definition onnxruntime_c_api.h:1037
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122