ONNX Runtime
Loading...
Searching...
No Matches
onnxruntime_c_api.h
1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the MIT License.
3
4// See docs\c_cxx\README.md on generating the Doxygen documentation from this file
5
31#pragma once
32#include <stdbool.h>
33#include <stdint.h>
34#include <stdlib.h>
35#include <string.h>
36
41#define ORT_API_VERSION 22
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
48// SAL2 Definitions
49#ifndef _MSC_VER
50#define _In_
51#define _In_z_
52#define _In_opt_
53#define _In_opt_z_
54#define _Out_
55#define _Outptr_
56#define _Out_opt_
57#define _Inout_
58#define _Inout_opt_
59#define _Frees_ptr_opt_
60#define _Ret_maybenull_
61#define _Ret_notnull_
62#define _Check_return_
63#define _Outptr_result_maybenull_
64#define _In_reads_(X)
65#define _Inout_updates_(X)
66#define _Out_writes_(X)
67#define _Inout_updates_all_(X)
68#define _Out_writes_bytes_all_(X)
69#define _Out_writes_all_(X)
70#define _Success_(X)
71#define _Outptr_result_buffer_maybenull_(X)
72#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
73#else
74#include <specstrings.h>
75#define ORT_ALL_ARGS_NONNULL
76#endif
77
78#ifdef _WIN32
79// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
80// dllexport is not used, we use a .def file.
81#ifdef ORT_DLL_IMPORT
82#define ORT_EXPORT __declspec(dllimport)
83#else
84#define ORT_EXPORT
85#endif
86#define ORT_API_CALL _stdcall
87#define ORT_MUST_USE_RESULT
88#define ORTCHAR_T wchar_t
89#else
90// To make symbols visible on macOS/iOS
91#ifdef __APPLE__
92#define ORT_EXPORT __attribute__((visibility("default")))
93#else
94#define ORT_EXPORT
95#endif
96#define ORT_API_CALL
97#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
98#define ORTCHAR_T char
99#endif
100
103#ifndef ORT_TSTR
104#ifdef _WIN32
105#define ORT_TSTR(X) L##X
106// When X is a macro, L##X is not defined. In this case, we need to use ORT_TSTR_ON_MACRO.
107#define ORT_TSTR_ON_MACRO(X) L"" X
108#else
109#define ORT_TSTR(X) X
110#define ORT_TSTR_ON_MACRO(X) X
111#endif
112#endif
113
114// On Windows, ORT_FILE is a wchar_t version of the __FILE__ macro.
115// Otherwise, ORT_FILE is equivalent to __FILE__.
116#ifndef ORT_FILE
117#define ORT_FILE_INTERNAL(x) ORT_TSTR(x)
118#define ORT_FILE ORT_FILE_INTERNAL(__FILE__)
119#endif
120
121// Any pointer marked with _In_ or _Out_, cannot be NULL.
122
123// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
124// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
125// for ReleaseXXX(...) functions, they can accept NULL pointer.
126
127#ifdef __cplusplus
128// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
129// Such complex condition is needed because compilers set __cplusplus value differently.
130#ifndef __has_feature
131#define __has_feature(x) 0
132#endif
133#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
134#define NO_EXCEPTION noexcept
135#else
136#define NO_EXCEPTION throw()
137#endif
138#else
139#define NO_EXCEPTION
140#endif
141
142// __VA_ARGS__ on Windows and Linux are different
143#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
144
145#define ORT_API_STATUS(NAME, ...) \
146 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
147 NO_EXCEPTION ORT_MUST_USE_RESULT
148
149// XXX: Unfortunately, SAL annotations are known to not work with function pointers
150#define ORT_API2_STATUS(NAME, ...) \
151 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
152
153// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
154#define ORT_API_STATUS_IMPL(NAME, ...) \
155 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
156
157#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
158
159#ifdef __DOXYGEN__
160#undef ORT_API_STATUS
161#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
162#undef ORT_API2_STATUS
163#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
164#undef ORT_CLASS_RELEASE
165#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
166#undef NO_EXCEPTION
167#define NO_EXCEPTION
168#endif
179 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
180 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
181 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
182 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
183 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
184 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
185 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
186 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
189 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
190 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
191 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
192 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
193 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
194 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16, // Non-IEEE floating-point format based on IEEE754 single-precision
195 // float 8 types were introduced in onnx 1.14, see https://onnx.ai/onnx/technical/float8.html
196 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN, // Non-IEEE floating-point format based on IEEE754 single-precision
197 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
198 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2, // Non-IEEE floating-point format based on IEEE754 single-precision
199 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
200 // Int4 types were introduced in ONNX 1.16. See https://onnx.ai/onnx/technical/int4.html
201 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4, // maps to a pair of packed uint4 values (size == 1 byte)
202 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4 // maps to a pair of packed int4 values (size == 1 byte)
204
205// Synced with onnx TypeProto oneof
215
216// These types are synced with internal
217// SparseFormatFlags
224
225// Enum allows to query sparse tensor indices
232
244
260
270
272#define ORT_RUNTIME_CLASS(X) \
273 struct Ort##X; \
274 typedef struct Ort##X Ort##X
275
280// The actual types defined have an Ort prefix
281ORT_RUNTIME_CLASS(Env);
282ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
283ORT_RUNTIME_CLASS(MemoryInfo);
284ORT_RUNTIME_CLASS(IoBinding);
285ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
286ORT_RUNTIME_CLASS(Value);
287ORT_RUNTIME_CLASS(RunOptions);
288ORT_RUNTIME_CLASS(TypeInfo);
289ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
290ORT_RUNTIME_CLASS(MapTypeInfo);
291ORT_RUNTIME_CLASS(SequenceTypeInfo);
292ORT_RUNTIME_CLASS(OptionalTypeInfo);
293ORT_RUNTIME_CLASS(SessionOptions);
294ORT_RUNTIME_CLASS(CustomOpDomain);
295ORT_RUNTIME_CLASS(ModelMetadata);
296ORT_RUNTIME_CLASS(ThreadPoolParams);
297ORT_RUNTIME_CLASS(ThreadingOptions);
298ORT_RUNTIME_CLASS(ArenaCfg);
299ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
300ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
301ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
302ORT_RUNTIME_CLASS(CANNProviderOptions);
303ORT_RUNTIME_CLASS(DnnlProviderOptions);
304ORT_RUNTIME_CLASS(Op);
305ORT_RUNTIME_CLASS(OpAttr);
306ORT_RUNTIME_CLASS(Logger);
307ORT_RUNTIME_CLASS(ShapeInferContext);
308ORT_RUNTIME_CLASS(LoraAdapter);
309ORT_RUNTIME_CLASS(ValueInfo);
310ORT_RUNTIME_CLASS(Node);
311ORT_RUNTIME_CLASS(Graph);
312ORT_RUNTIME_CLASS(Model);
313ORT_RUNTIME_CLASS(ModelCompilationOptions);
314
315#ifdef _MSC_VER
316typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
317#else
319#endif
320
327typedef struct OrtAllocator {
328 uint32_t version;
329 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
330 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
331 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
337 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
339
340typedef void(ORT_API_CALL* OrtLoggingFunction)(
341 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
342 const char* message);
343
355
360
373
374struct OrtKernelInfo;
376struct OrtKernelContext;
378struct OrtCustomOp;
380
386
389// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
396
404
408 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
409 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
410 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
412
499
588
595 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
596 void* user_compute_stream; // user specified CUDA compute stream.
597 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
598 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
599 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
600 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
601 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
602 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
603 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
604 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
605 int trt_dla_core; // DLA core number. Default 0
606 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
607 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
608 const char* trt_engine_cache_path; // specify engine cache path
609 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
610 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
611 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
612 // This is the legacy struct and don't add new fields here.
613 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
614 // For non-string field, need to create a new separate api to handle it.
616
622 int device_id; // hip device id.
623 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
624 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
625 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, noznero = true
626 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
627 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, noznero = true
628 const char* migraphx_save_model_path; // migraphx model path name
629 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, noznero = true
630 const char* migraphx_load_model_path; // migraphx model path name
631 bool migraphx_exhaustive_tune; // migraphx tuned compile Default = false
633
644#ifdef __cplusplus
653#endif
658 const char* device_type;
660 const char* device_id;
662 const char* cache_dir; // path is set to empty by default
663 void* context;
665 unsigned char enable_dynamic_shapes;
667
668struct OrtApi;
669typedef struct OrtApi OrtApi;
670
671struct OrtTrainingApi;
673
674struct OrtModelEditorApi;
676
677struct OrtCompileApi;
679
694 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
695
700 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
701};
702
703typedef struct OrtApiBase OrtApiBase;
704
709ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
710
716typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
717
721
727typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
728
734typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
735
736typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
737
745typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
746
754struct OrtApi {
757
765 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
766
772 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
773
779 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
780
784
795 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
796
811 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
812 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
813
821 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
829 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
830
834
844 // TODO: document the path separator convention? '/' vs '\'
845 // TODO: should specify the access characteristics of model_path. Is this read only during the
846 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
847 // and continue to access throughout the OrtSession lifetime?
848 // What sort of access is needed to model_path : read or read/write?
849 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
850 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
851
862 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env,
863 _In_ const void* model_data, size_t model_data_length,
864 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
865
884 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
885 _In_reads_(input_len) const char* const* input_names,
886 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
887 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
888 _Inout_updates_all_(output_names_len) OrtValue** outputs);
889
893
909 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
910
918 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
919 _In_ const ORTCHAR_T* optimized_model_filepath);
920
928 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
929 _Outptr_ OrtSessionOptions** out_options);
930
942 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
943
951 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
952
959 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
960
974 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
975
984 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
985
994 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
995
1002 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
1003
1011 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
1012
1022 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1023
1031 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1032
1041 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1042 GraphOptimizationLevel graph_optimization_level);
1043
1057 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1058
1071 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1072
1076
1084 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1085
1095 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1096
1100
1110 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1111
1128 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1129
1133
1145 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1146
1158 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1159
1169 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1170
1179 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1180
1189 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1190
1199 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1200
1210 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1211
1221 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1222
1232 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1233 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1234
1238
1245 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1246
1256 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1257
1265 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1266
1276 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1277
1287 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1288 _Out_ int* log_verbosity_level);
1289
1297 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1298
1310 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1311
1320 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1321
1330 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1331
1335
1348 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1350
1368 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1369 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1370 _Outptr_ OrtValue** out);
1371
1379 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1380
1391 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1392
1401 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1402
1412 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1413
1433 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1434 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1435
1439
1448 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1449 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1450
1458 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1459
1463
1471
1480
1489 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1490
1500 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1502
1512 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1513
1522 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1523 size_t dim_values_length);
1524
1533 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1534 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1535
1552 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1553
1557
1565 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
1566
1574 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
1575
1583 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
1584
1588
1599 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
1600 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
1601
1612 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
1613 _Outptr_ OrtMemoryInfo** out);
1614
1625 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
1626
1634 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
1635
1638 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
1639
1642 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
1643
1646 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
1647
1651
1653 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
1655 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
1657 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
1658
1667 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
1668
1672
1684 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
1685 _In_ int64_t dim_value);
1686
1690
1691 /* Internal information (not seen in Doxygen)
1692 *
1693 * APIs to support non-tensor types - map and sequence.
1694 * Currently only the following types are supported
1695 * Note: the following types should be kept in sync with data_types.h
1696 * Map types
1697 * =========
1698 * std::map<std::string, std::string>
1699 * std::map<std::string, int64_t>
1700 * std::map<std::string, float>
1701 * std::map<std::string, double>
1702 * std::map<int64_t, std::string>
1703 * std::map<int64_t, int64_t>
1704 * std::map<int64_t, float>
1705 * std::map<int64_t, double>
1706 *
1707 * Sequence types
1708 * ==============
1709 * std::vector<std::string>
1710 * std::vector<int64_t>
1711 * std::vector<float>
1712 * std::vector<double>
1713 * std::vector<std::map<std::string, float>>
1714 * std::vector<std::map<int64_t, float>
1715 */
1716
1731 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
1732 _Outptr_ OrtValue** out);
1733
1744 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
1745
1761 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
1762 enum ONNXType value_type, _Outptr_ OrtValue** out);
1763
1786 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
1787 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
1788
1803 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
1804 _Out_ void* data_container, size_t data_container_size);
1805
1810
1819 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
1820 _Out_ float* out);
1821
1830 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
1831 _Out_ int64_t* out);
1832
1853 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
1854 _Inout_ size_t* size);
1855
1860
1865 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1866
1871 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1872
1884 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
1885 _Out_ const OrtValue** out);
1886
1900 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
1901 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
1902
1906 ORT_CLASS_RELEASE(Env);
1910 ORT_CLASS_RELEASE(Status);
1914 ORT_CLASS_RELEASE(MemoryInfo);
1918 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
1922 ORT_CLASS_RELEASE(Value);
1926 ORT_CLASS_RELEASE(RunOptions);
1930 ORT_CLASS_RELEASE(TypeInfo);
1934 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
1938 ORT_CLASS_RELEASE(SessionOptions);
1942 ORT_CLASS_RELEASE(CustomOpDomain);
1943
1947
1960 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
1961 _Out_ size_t* len);
1962
1976 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
1977 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
1978
1992 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
1993 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
1994
1998
2010 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
2011
2020 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2021
2025
2036 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2037 _Outptr_ OrtTypeInfo** type_info);
2038
2042 ORT_CLASS_RELEASE(MapTypeInfo);
2046 ORT_CLASS_RELEASE(SequenceTypeInfo);
2047
2051
2062 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2063
2071 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2072
2076
2085 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2086 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2087
2096 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2097 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2098
2107 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2108 _Outptr_ char** value);
2109
2118 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2119 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2120
2131 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2132 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2133
2141 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2142
2143 ORT_CLASS_RELEASE(ModelMetadata);
2144
2148
2162 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2163 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2164
2168
2178 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2179
2183
2189 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2190
2191 ORT_CLASS_RELEASE(ThreadingOptions);
2192
2196
2208 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2209 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2210
2214
2222 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2223 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2224 _In_ int64_t dim_value);
2225
2229
2241 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2242
2251 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2252 _In_ int providers_length);
2253
2257
2266 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2267
2277 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2278
2287 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2288
2292
2305 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2306 _In_z_ const char* config_key, _In_z_ const char* config_value);
2307
2311
2320 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2321 _Outptr_ OrtAllocator** out);
2322
2325 ORT_CLASS_RELEASE(Allocator);
2326
2330
2341 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2342
2354 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2355
2359
2362 ORT_CLASS_RELEASE(IoBinding);
2363
2374 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2375
2386 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2387
2403 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2404
2422 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2423 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2424
2442 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2443 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2444
2447 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2448
2451 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2452
2456
2471 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2472
2476
2491 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2492 _In_ const OrtArenaCfg* arena_cfg);
2493
2505 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2506
2510
2520 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2521
2525
2537 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2538
2550 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
2551
2565 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
2566
2570
2585 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
2586 _In_ const OrtValue* val);
2587
2591
2607 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
2608 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2609
2613
2624 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
2625
2636 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
2637
2648 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
2649
2653
2664 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
2665
2669
2682 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
2683 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
2684
2685 ORT_CLASS_RELEASE(ArenaCfg);
2686
2690
2702 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
2703 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2704
2708
2719 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
2720
2724
2735 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
2736
2747 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
2748
2753
2776 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2777 _Out_ float* out, _Inout_ size_t* size);
2778
2800 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2801 _Out_ int64_t* out, _Inout_ size_t* size);
2802
2806
2838 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
2839 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
2840 _Outptr_ OrtArenaCfg** out);
2841
2845
2858 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
2859 _In_z_ const char* config_key, _In_z_ const char* config_value);
2860
2864
2878
2883 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
2884
2888
2906 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
2907 _In_ const OrtSessionOptions* options,
2908 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2909 _Outptr_ OrtSession** out);
2910
2929 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
2930 _In_ const void* model_data, size_t model_data_length,
2931 _In_ const OrtSessionOptions* options,
2932 _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2933 _Outptr_ OrtSession** out);
2934
2938
2957 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
2958
2962
2970
2986 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
2987 _In_reads_(num_keys) const char* const* provider_options_keys,
2988 _In_reads_(num_keys) const char* const* provider_options_values,
2989 _In_ size_t num_keys);
2990
3002 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3003
3008 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
3009
3013
3020 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
3021
3025
3041 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3042
3053 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3054 _In_ const OrtMemoryInfo* mem_info);
3055
3059
3068 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3069
3086 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3087 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3088
3106 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3107 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3108 _In_ const int64_t* indices_data, size_t indices_num);
3109
3129 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3130 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3131 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3132 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3133
3152 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3153 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3154 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3155 _In_ const int32_t* indices_data);
3156
3181 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3182 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3183 _In_ const int64_t* values_shape, size_t values_shape_len,
3185
3200 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3201
3218 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3219 _Inout_ int64_t* outer_data, size_t outer_num);
3220
3234 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3235
3243 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3244
3252 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3253
3261 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3262
3272 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3273
3283 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3287
3300 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3301
3306
3318 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3319
3323
3329 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3330
3334
3344 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3345
3347
3350
3357 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3358
3366 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3367
3375 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3377
3380
3387 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3388
3396 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3397
3405 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3407
3416 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3417
3426 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3427
3430
3451 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3452
3456
3465 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3466
3484 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3485 _In_reads_(num_keys) const char* const* provider_options_keys,
3486 _In_reads_(num_keys) const char* const* provider_options_values,
3487 _In_ size_t num_keys);
3488
3503 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3504
3511 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3512
3514
3527 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3528
3550 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
3551 _In_reads_(num_initializers) const char* const* initializer_names,
3552 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
3553
3564 ORT_API2_STATUS(CreateOpAttr,
3565 _In_ const char* name,
3566 _In_ const void* data,
3567 _In_ int len,
3568 _In_ OrtOpAttrType type,
3569 _Outptr_ OrtOpAttr** op_attr);
3570
3571 /* \brief: Release op attribute
3572 *
3573 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
3574 *
3575 * \since Version 1.12.
3576 */
3577 ORT_CLASS_RELEASE(OpAttr);
3578
3596 ORT_API2_STATUS(CreateOp,
3597 _In_ const OrtKernelInfo* info,
3598 _In_z_ const char* op_name,
3599 _In_z_ const char* domain,
3600 int version,
3601 _In_reads_(type_constraint_count) const char** type_constraint_names,
3602 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
3603 int type_constraint_count,
3604 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
3605 int attr_count,
3606 int input_count,
3607 int output_count,
3608 _Outptr_ OrtOp** ort_op);
3609
3622 ORT_API2_STATUS(InvokeOp,
3623 _In_ const OrtKernelContext* context,
3624 _In_ const OrtOp* ort_op,
3625 _In_ const OrtValue* const* input_values,
3626 _In_ int input_count,
3627 _Inout_ OrtValue* const* output_values,
3628 _In_ int output_count);
3629
3630 /* \brief: Release an onnxruntime operator
3631 *
3632 * \param[in] Op Operator created by OrtApi::CreateOp
3633 *
3634 * \since Version 1.12.
3635 */
3636 ORT_CLASS_RELEASE(Op);
3637
3751 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
3752 _In_ const char* provider_name,
3753 _In_reads_(num_keys) const char* const* provider_options_keys,
3754 _In_reads_(num_keys) const char* const* provider_options_values,
3755 _In_ size_t num_keys);
3756
3757 /* \brief: Get a copy of kernel info
3758 *
3759 * \param[in] info Kernel info
3760 * \param[out] info_copy Copy of kernel info
3761 *
3762 * \since Version 1.12.
3763 */
3764 ORT_API2_STATUS(CopyKernelInfo,
3765 _In_ const OrtKernelInfo* info,
3766 _Outptr_ OrtKernelInfo** info_copy);
3767
3768 /* \brief: Release kernel info
3769 *
3770 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
3771 *
3772 * \since Version 1.12.
3773 */
3774 ORT_CLASS_RELEASE(KernelInfo);
3775
3778
3792 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
3793
3795
3808 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
3809
3818 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
3819
3831 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
3832 _In_reads_(num_keys) const char* const* provider_options_keys,
3833 _In_reads_(num_keys) const char* const* provider_options_values,
3834 _In_ size_t num_keys);
3835
3849 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
3850 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3851
3858 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
3859
3860 /* \brief Get OrtDevice type from MemoryInfo
3861 *
3862 * \since Version 1.14
3863 */
3864 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
3865
3866 /* \brief Update the OrtEnv instance with custom log severity level
3867 *
3868 * \param[in] ort_env The OrtEnv instance being used
3869 * \param[in] log_severity_level The log severity level.
3870 *
3871 * \since Version 1.14.
3872 */
3873 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
3874
3875 /* \brief Set affinities for intra op threads
3876 *
3877 * Affinity string follows format:
3878 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
3879 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
3880 * e.g. 1,2,3;4,5
3881 * 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.
3882 * To ease the configuration, an "interval" is also allowed:
3883 * e.g. 1-8;8-16;17-24
3884 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
3885 * Note:
3886 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
3887 * ort does not set affinity on the main thread which is started and managed by the calling app;
3888 * 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,
3889 * 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.
3890 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
3891 *
3892 * \since Version 1.14
3893 */
3894 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
3895
3914 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
3915
3940 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
3941 _In_ const char* registration_func_name);
3942
3946
3958 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3959
3971 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3972
3997 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3998 _Inout_ size_t* size);
3999
4025 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
4026 _Inout_ size_t* size);
4027
4040 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4041 _Outptr_ OrtTypeInfo** type_info);
4042
4055 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
4056 _Outptr_ OrtTypeInfo** type_info);
4057
4070 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4071 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4072
4077
4093 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4094 _In_z_ const char* config_key, _Out_ int* out);
4095
4124 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4125 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4126
4128
4141 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4142
4151 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4152
4169 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4170 _In_reads_(num_keys) const char* const* provider_options_keys,
4171 _In_reads_(num_keys) const char* const* provider_options_values,
4172 _In_ size_t num_keys);
4173
4188 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4189
4194 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4195
4199
4222 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_ char* out, _Inout_ size_t* size);
4223
4235 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4236
4241
4253 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4254
4259
4278 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4279 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4280 _In_z_ const char* func_name);
4281
4293 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4294
4296
4310 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4311
4332 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4333 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4334
4351 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4352 _Outptr_ OrtTypeInfo** out);
4353
4364 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4365
4376 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4377
4384 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4385
4388
4397 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4398
4416 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4417 _In_reads_(num_keys) const char* const* provider_options_keys,
4418 _In_reads_(num_keys) const char* const* provider_options_values,
4419 _In_ size_t num_keys);
4420
4435 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4436
4443 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
4444
4458 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type, _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
4459 _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);
4460
4479 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
4480 _In_reads_(input_len) const char* const* input_names,
4481 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
4482 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
4483 _Inout_updates_all_(output_names_len) OrtValue** output,
4484 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
4485
4498 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
4499
4510 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
4511
4524 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
4525
4536 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
4537
4549 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
4550 _In_ int resource_id, _Outptr_ void** resource);
4551
4569 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
4570 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
4571
4580 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
4581
4591 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
4592
4602 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
4603
4613 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
4614
4624 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
4625
4637 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
4638
4649 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
4650
4662 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);
4663
4678 _In_ OrtSessionOptions* options,
4679 _In_reads_(num_keys) const char* const* provider_options_keys,
4680 _In_reads_(num_keys) const char* const* provider_options_values,
4681 _In_ size_t num_keys);
4682
4697 _In_ OrtSessionOptions* options,
4698 _In_reads_(num_keys) const char* const* provider_options_keys,
4699 _In_reads_(num_keys) const char* const* provider_options_values,
4700 _In_ size_t num_keys);
4701
4713 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
4714
4725 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
4726
4748 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
4749 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
4750 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
4751 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
4752 size_t num_external_initializer_files);
4753
4772 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
4773 _Outptr_ OrtLoraAdapter** out);
4774
4792 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
4793 _Outptr_ OrtLoraAdapter** out);
4794
4797 ORT_CLASS_RELEASE(LoraAdapter);
4798
4815 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
4816
4820
4835 ORT_API2_STATUS(SetEpDynamicOptions, _Inout_ OrtSession* sess, _In_reads_(kv_len) const char* const* keys,
4836 _In_reads_(kv_len) const char* const* values, _In_ size_t kv_len);
4837
4841 ORT_CLASS_RELEASE(ValueInfo);
4842
4846 ORT_CLASS_RELEASE(Node);
4847
4852 ORT_CLASS_RELEASE(Graph);
4853
4858 ORT_CLASS_RELEASE(Model);
4859
4866 ORT_API2_STATUS(GetValueInfoName, _In_ const OrtValueInfo* value_info, _Out_ const char** name);
4867
4874 ORT_API2_STATUS(GetValueInfoTypeInfo, _In_ const OrtValueInfo* value_info, _Outptr_ const OrtTypeInfo** type_info);
4875
4884 const OrtModelEditorApi*(ORT_API_CALL* GetModelEditorApi)();
4885
4904 ORT_API2_STATUS(CreateTensorWithDataAndDeleterAsOrtValue, _In_ OrtAllocator* deleter,
4905 _In_ void* p_data, size_t p_data_len,
4906 _In_ const int64_t* shape, size_t shape_len,
4908 _Outptr_ OrtValue** out);
4909
4926 ORT_API2_STATUS(SessionOptionsSetLoadCancellationFlag, _Inout_ OrtSessionOptions* options,
4927 _In_ bool cancel);
4928
4942 const OrtCompileApi*(ORT_API_CALL* GetCompileApi)();
4943};
4944
4945/*
4946 * Steps to use a custom op:
4947 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
4948 * 2 Create an OrtCustomOp structure for each op and add them to the domain
4949 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
4950 */
4951
4952// Specifies some characteristics of inputs/outputs of custom ops:
4953// Specify if the inputs/outputs are one of:
4954// 1) Non-optional (input/output must be present in the node)
4955// 2) Optional (input/output may be absent in the node)
4956// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
4957// Only the last input or output of a custom op may be marked as variadic.
4958// The homogeneity of the variadic input or output determines whether all operands must be of the same
4959// tensor element type.
4965
4966/*
4967 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
4968 * the implementor of the custom op.
4969 */
4971 uint32_t version; // Must be initialized to ORT_API_VERSION
4972
4973 // This callback creates the kernel, which is a user defined
4974 // parameter that is passed to the Kernel* callbacks below. It is
4975 // recommended to use CreateKernelV2 which allows for a safe error
4976 // propagation by returning an OrtStatusPtr.
4977 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
4978 _In_ const OrtKernelInfo* info);
4979
4980 // Returns the name of the op
4981 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
4982
4983 // Returns the type of the execution provider, return nullptr to use CPU execution provider
4984 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
4985
4986 // Returns the count and types of the input & output tensors
4987 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4988 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
4989 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4990 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
4991
4992 // Perform a computation step. It is recommended to use
4993 // KernelComputeV2 which allows for a safe error propagation by
4994 // returning an OrtStatusPtr.
4995 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
4996 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
4997
4998 // Returns the characteristics of the input & output tensors
4999 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5000 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5001
5002 // Returns the memory type of the input tensors. This API allows the custom op
5003 // to place the inputs on specific devices. By default, it returns
5004 // OrtMemTypeDefault, which means the input is placed on the default device for
5005 // the execution provider. If the inputs need to be with different memory tyeps,
5006 // this function can be overridden to return the specific memory types.
5007 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
5008
5009 // Returns the minimum number of input arguments expected for the variadic input.
5010 // Applicable only for custom ops that have a variadic input.
5011 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
5012
5013 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
5014 // and false (zero) otherwise.
5015 // Applicable only for custom ops that have a variadic input.
5016 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
5017
5018 // Returns the minimum number of output values expected for the variadic output.
5019 // Applicable only for custom ops that have a variadic output.
5020 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
5021
5022 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
5023 // and false (zero) otherwise.
5024 // Applicable only for custom ops that have a variadic output.
5025 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
5026
5027 // Create the kernel state which is passed to each compute call.
5028 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
5029 _In_ const OrtKernelInfo* info,
5030 _Out_ void** kernel);
5031
5032 // Perform the computation step.
5033 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
5034
5035 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
5036
5037 // Get start range
5038 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
5039 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
5040
5041 // Get the inplace_map that defines which output can reuse which input
5042 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
5043 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
5044 // The return value is the size of these 2 arrays.
5045 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
5046 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
5047
5048 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
5049 // If GetMayInplace() is defined, this function MUST be defined as well.
5050 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
5051
5052 // Same as GetMayInplace() and ReleaseMayInplace()
5053 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
5054 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
5055};
5056
5069 // Model building/editing requires a full build. We return nullptr from GetModelEditorApi if this is a minimal
5070 // build, so it doesn't matter if there are no function pointers in this struct as a user will never get an
5071 // OrtModelEditorApi instance. We do however need a dummy field to avoid empty struct warning.
5072#if defined(ORT_MINIMAL_BUILD)
5073 const bool not_defined_in_this_build;
5074#else
5088 ORT_API2_STATUS(CreateTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
5089 _Outptr_ OrtTypeInfo** type_info);
5090
5104 ORT_API2_STATUS(CreateSparseTensorTypeInfo, _In_ const OrtTensorTypeAndShapeInfo* tensor_info,
5105 _Outptr_ OrtTypeInfo** type_info);
5106
5121 ORT_API2_STATUS(CreateMapTypeInfo, ONNXTensorElementDataType map_key_type, _In_ const OrtTypeInfo* map_value_type,
5122 _Outptr_ OrtTypeInfo** type_info);
5123
5137 ORT_API2_STATUS(CreateSequenceTypeInfo, _In_ const OrtTypeInfo* sequence_type, _Outptr_ OrtTypeInfo** type_info);
5138
5152 ORT_API2_STATUS(CreateOptionalTypeInfo, _In_ const OrtTypeInfo* contained_type, _Outptr_ OrtTypeInfo** type_info);
5153
5164 ORT_API2_STATUS(CreateValueInfo, _In_ const char* name, _In_ const OrtTypeInfo* type_info,
5165 _Outptr_ OrtValueInfo** value_info);
5166
5188 ORT_API2_STATUS(CreateNode, _In_ const char* operator_name, _In_ const char* domain_name, _In_ const char* node_name,
5189 _In_reads_(input_names_len) const char* const* input_names, size_t input_names_len,
5190 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
5191 _In_reads_(attribs_len) _In_opt_ OrtOpAttr** attributes, _In_ size_t attribs_len,
5192 _Outptr_ OrtNode** node);
5193
5198 ORT_API2_STATUS(CreateGraph, _Outptr_ OrtGraph** graph);
5199
5213 ORT_API2_STATUS(SetGraphInputs, _Inout_ OrtGraph* graph,
5214 _In_reads_(inputs_len) _In_ OrtValueInfo** inputs, _In_ size_t inputs_len);
5215
5229 ORT_API2_STATUS(SetGraphOutputs, _Inout_ OrtGraph* graph,
5230 _In_reads_(outputs_len) _In_ OrtValueInfo** outputs, _In_ size_t outputs_len);
5231
5270 ORT_API2_STATUS(AddInitializerToGraph, _Inout_ OrtGraph* graph, _In_ const char* name, _In_ OrtValue* tensor,
5271 bool data_is_external);
5272
5284 ORT_API2_STATUS(AddNodeToGraph, _Inout_ OrtGraph* graph, _In_ OrtNode* node);
5285
5304 ORT_API2_STATUS(CreateModel,
5305 _In_reads_(opset_entries_len) const char* const* domain_names,
5306 _In_reads_(opset_entries_len) const int* opset_versions,
5307 size_t opset_entries_len,
5308 _Outptr_ OrtModel** model);
5309
5323 ORT_API2_STATUS(AddGraphToModel, _Inout_ OrtModel* model, _In_ OrtGraph* graph);
5324
5343 ORT_API2_STATUS(CreateSessionFromModel, _In_ const OrtEnv* env, _In_ const OrtModel* model,
5344 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
5345
5368 ORT_API2_STATUS(CreateModelEditorSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
5369 _In_ const OrtSessionOptions* options,
5370 _Outptr_ OrtSession** out);
5371
5396 ORT_API2_STATUS(CreateModelEditorSessionFromArray, _In_ const OrtEnv* env,
5397 _In_ const void* model_data, size_t model_data_length,
5398 _In_ const OrtSessionOptions* options,
5399 _Outptr_ OrtSession** out);
5400
5415 ORT_API2_STATUS(SessionGetOpsetForDomain, _In_ const OrtSession* session, _In_ const char* domain, _Out_ int* opset);
5416
5435 ORT_API2_STATUS(ApplyModelToModelEditorSession, _Inout_ OrtSession* session, _In_ OrtModel* model);
5436
5450 ORT_API2_STATUS(FinalizeModelEditorSession, _Inout_ OrtSession* session, _In_ const OrtSessionOptions* options,
5451 _In_opt_ OrtPrepackedWeightsContainer* prepacked_weights_container);
5452#endif // !defined(ORT_MINIMAL_BUILD)
5453};
5454
5486 ORT_CLASS_RELEASE(ModelCompilationOptions);
5487
5503 ORT_API2_STATUS(CreateModelCompilationOptionsFromSessionOptions, _In_ const OrtEnv* env,
5504 _In_ const OrtSessionOptions* session_options, _Outptr_ OrtModelCompilationOptions** out);
5505
5518 ORT_API2_STATUS(ModelCompilationOptions_SetInputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
5519 _In_ const ORTCHAR_T* input_model_path);
5520
5535 _In_ OrtModelCompilationOptions* model_compile_options,
5536 _In_ const void* input_model_data,
5537 size_t input_model_data_size);
5538
5556 ORT_API2_STATUS(ModelCompilationOptions_SetOutputModelPath, _In_ OrtModelCompilationOptions* model_compile_options,
5557 _In_ const ORTCHAR_T* output_model_path);
5558
5575 _In_ OrtModelCompilationOptions* model_compile_options,
5576 _In_ const ORTCHAR_T* external_initializers_file_path,
5577 size_t external_initializers_size_threshold);
5578
5601 _In_ OrtModelCompilationOptions* model_compile_options,
5602 _Inout_ OrtAllocator* allocator,
5603 _Outptr_ void** output_model_buffer_ptr,
5604 _Out_ size_t* output_model_buffer_size_ptr);
5605
5628 ORT_API2_STATUS(ModelCompilationOptions_SetEpContextEmbedMode, _In_ OrtModelCompilationOptions* model_compile_options,
5629 bool embed_ep_context_in_model);
5630
5640 ORT_API2_STATUS(CompileModel, _In_ const OrtEnv* env, _In_ const OrtModelCompilationOptions* model_options);
5641};
5642/*
5643 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
5644 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
5645 *
5646 * \param device_id CUDA device id, starts from zero.
5647 */
5648ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
5649
5650/*
5651 * This is the old way to add the ROCm provider to the session, please use
5652 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
5653 * This function always exists, but will only succeed if Onnxruntime was built with
5654 * HIP support and the ROCm provider shared library exists
5655 *
5656 * \param device_id HIP device id, starts from zero.
5657 */
5658ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
5659
5660/*
5661 * This is the old way to add the MIGraphX provider to the session, please use
5662 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
5663 * This function always exists, but will only succeed if Onnxruntime was built with
5664 * HIP support and the MIGraphX provider shared library exists
5665 *
5666 * \param device_id HIP device id, starts from zero.
5667 */
5668ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
5669
5670/*
5671 * This is the old way to add the oneDNN provider to the session, please use
5672 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
5673 * This function always exists, but will only succeed if Onnxruntime was built with
5674 * oneDNN support and the oneDNN provider shared library exists
5675 *
5676 * \param use_arena zero: false. non-zero: true.
5677 */
5678ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
5679
5680/*
5681 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
5682 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
5683 *
5684 * \param device_id CUDA device id, starts from zero.
5685 */
5686ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
5687
5688#ifdef __cplusplus
5689}
5690#endif
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:283
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:308
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:375
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:310
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Tensorrt(OrtSessionOptions *options, int device_id)
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:237
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:399
struct OrtModelCompilationOptions OrtModelCompilationOptions
Definition onnxruntime_c_api.h:313
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:307
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:340
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:734
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:736
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:4960
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:300
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:305
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:297
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:291
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:364
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:309
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:303
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:226
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:299
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:285
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:294
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:284
OrtAllocatorType
Definition onnxruntime_c_api.h:381
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:304
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:295
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:288
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:289
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:301
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:377
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:407
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:302
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:745
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:287
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:312
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:311
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:716
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:292
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:293
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:286
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:349
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:318
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:390
OrtSparseFormat
Definition onnxruntime_c_api.h:218
ONNXType
Definition onnxruntime_c_api.h:206
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:281
OrtErrorCode
Definition onnxruntime_c_api.h:245
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:282
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:306
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:290
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:298
ExecutionMode
Definition onnxruntime_c_api.h:356
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:261
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:727
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:177
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:238
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition onnxruntime_c_api.h:239
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition onnxruntime_c_api.h:241
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:240
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition onnxruntime_c_api.h:242
@ OrtMemoryInfoDeviceType_GPU
Definition onnxruntime_c_api.h:401
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:402
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:400
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:4963
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:4961
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:4962
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:365
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:368
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:366
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:370
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:367
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:369
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:371
@ ORT_SPARSE_COO_INDICES
Definition onnxruntime_c_api.h:227
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition onnxruntime_c_api.h:230
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition onnxruntime_c_api.h:229
@ ORT_SPARSE_CSR_INNER_INDICES
Definition onnxruntime_c_api.h:228
@ OrtDeviceAllocator
Definition onnxruntime_c_api.h:383
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:384
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:382
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:410
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:408
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:409
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:351
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:353
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:350
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:352
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:391
@ OrtMemTypeCPU
Temporary CPU accessible memory allocated by non-CPU execution provider, i.e. CUDA_PINNED.
Definition onnxruntime_c_api.h:393
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:394
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. CUDA_PINNED.
Definition onnxruntime_c_api.h:392
@ ORT_SPARSE_CSRC
Definition onnxruntime_c_api.h:221
@ ORT_SPARSE_COO
Definition onnxruntime_c_api.h:220
@ ORT_SPARSE_BLOCK_SPARSE
Definition onnxruntime_c_api.h:222
@ ORT_SPARSE_UNDEFINED
Definition onnxruntime_c_api.h:219
@ ONNX_TYPE_SEQUENCE
Definition onnxruntime_c_api.h:209
@ ONNX_TYPE_MAP
Definition onnxruntime_c_api.h:210
@ ONNX_TYPE_OPAQUE
Definition onnxruntime_c_api.h:211
@ ONNX_TYPE_UNKNOWN
Definition onnxruntime_c_api.h:207
@ ONNX_TYPE_TENSOR
Definition onnxruntime_c_api.h:208
@ ONNX_TYPE_SPARSETENSOR
Definition onnxruntime_c_api.h:212
@ ONNX_TYPE_OPTIONAL
Definition onnxruntime_c_api.h:213
@ ORT_MODEL_LOAD_CANCELED
Definition onnxruntime_c_api.h:258
@ ORT_NO_SUCHFILE
Definition onnxruntime_c_api.h:249
@ ORT_OK
Definition onnxruntime_c_api.h:246
@ ORT_INVALID_ARGUMENT
Definition onnxruntime_c_api.h:248
@ ORT_EP_FAIL
Definition onnxruntime_c_api.h:257
@ ORT_NOT_IMPLEMENTED
Definition onnxruntime_c_api.h:255
@ ORT_RUNTIME_EXCEPTION
Definition onnxruntime_c_api.h:252
@ ORT_ENGINE_ERROR
Definition onnxruntime_c_api.h:251
@ ORT_FAIL
Definition onnxruntime_c_api.h:247
@ ORT_INVALID_PROTOBUF
Definition onnxruntime_c_api.h:253
@ ORT_NO_MODEL
Definition onnxruntime_c_api.h:250
@ ORT_INVALID_GRAPH
Definition onnxruntime_c_api.h:256
@ ORT_MODEL_LOADED
Definition onnxruntime_c_api.h:254
@ ORT_PARALLEL
Definition onnxruntime_c_api.h:358
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:357
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:263
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:266
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:268
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:262
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:264
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:267
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:265
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition onnxruntime_c_api.h:186
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition onnxruntime_c_api.h:184
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition onnxruntime_c_api.h:190
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition onnxruntime_c_api.h:182
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition onnxruntime_c_api.h:178
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition onnxruntime_c_api.h:193
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ
Definition onnxruntime_c_api.h:199
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition onnxruntime_c_api.h:191
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT4
Definition onnxruntime_c_api.h:201
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition onnxruntime_c_api.h:185
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2
Definition onnxruntime_c_api.h:198
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition onnxruntime_c_api.h:187
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition onnxruntime_c_api.h:188
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition onnxruntime_c_api.h:180
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition onnxruntime_c_api.h:183
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition onnxruntime_c_api.h:189
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition onnxruntime_c_api.h:181
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:179
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN
Definition onnxruntime_c_api.h:196
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition onnxruntime_c_api.h:194
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT4
Definition onnxruntime_c_api.h:202
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition onnxruntime_c_api.h:192
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ
Definition onnxruntime_c_api.h:197
Memory allocation interface.
Definition onnxruntime_c_api.h:327
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:330
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:331
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:328
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition onnxruntime_c_api.h:329
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:337
The helper interface to get the right version of OrtApi.
Definition onnxruntime_c_api.h:684
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:700
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:694
The C API.
Definition onnxruntime_c_api.h:754
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 * CreateSessionOptions(OrtSessionOptions **options)
Create an OrtSessionOptions object.
void(* ReleaseDnnlProviderOptions)(OrtDnnlProviderOptions *input)
Release an OrtDnnlProviderOptions.
Definition onnxruntime_c_api.h:4194
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:4384
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 * GetTensorMemoryInfo(const OrtValue *value, const OrtMemoryInfo **mem_info)
Returns a pointer to the OrtMemoryInfo of a Tensor.
OrtStatus * EnableCpuMemArena(OrtSessionOptions *options)
Enable the memory arena on CPU.
OrtStatus * CreateSparseTensorWithValuesAsOrtValue(const OrtMemoryInfo *info, void *p_data, const int64_t *dense_shape, size_t dense_shape_len, const int64_t *values_shape, size_t values_shape_len, ONNXTensorElementDataType type, OrtValue **out)
OrtStatus * GetValueCount(const OrtValue *value, size_t *out)
Get non tensor value count from an OrtValue.
OrtStatus * SetGlobalCustomJoinThreadFn(OrtThreadingOptions *tp_options, OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Set custom thread join function for global thread pools.
OrtStatus * CreateCUDAProviderOptions(OrtCUDAProviderOptionsV2 **out)
Create an OrtCUDAProviderOptionsV2.
OrtStatus * DisableProfiling(OrtSessionOptions *options)
Disable profiling for a session.
OrtStatus * KernelInfoGetAttributeArray_float(const OrtKernelInfo *info, const char *name, float *out, size_t *size)
Fetch an array of int64_t values stored as an attribute in the graph node.
OrtStatus * CreatePrepackedWeightsContainer(OrtPrepackedWeightsContainer **out)
Create an OrtPrepackedWeightsContainer.
OrtStatus * SetDeterministicCompute(OrtSessionOptions *options, bool value)
Set whether to use deterministic compute.
OrtStatus * UpdateTensorRTProviderOptionsWithValue(OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *key, void *value)
OrtStatus * CreateSessionFromArrayWithPrepackedWeightsContainer(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtPrepackedWeightsContainer *prepacked_weights_container, OrtSession **out)
Create session from memory with prepacked weights container.
const OrtCompileApi *(* GetCompileApi)()
Get the Compile API instance.
Definition onnxruntime_c_api.h:4942
OrtStatus * AddFreeDimensionOverrideByName(OrtSessionOptions *options, const char *dim_name, int64_t dim_value)
OrtStatus * KernelInfo_GetInputCount(const OrtKernelInfo *info, size_t *out)
Get the number of inputs from OrtKernelInfo.
OrtStatus * GetSparseTensorFormat(const OrtValue *ort_value, enum OrtSparseFormat *out)
Returns sparse tensor format enum iff a given ort value contains an instance of sparse tensor.
OrtStatus * KernelContext_GetGPUComputeStream(const OrtKernelContext *context, void **out)
Used for custom operators, gets the GPU compute stream to use to launch the custom a GPU kernel.
OrtStatus * UpdateCANNProviderOptions(OrtCANNProviderOptions *cann_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CANN Execution Provider.
OrtStatus * 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 OrtTrainingApi *(* GetTrainingApi)(uint32_t version)
Gets the Training C Api struct.
Definition onnxruntime_c_api.h:3792
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 * 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:2447
OrtStatus * KernelInfo_GetInputTypeInfo(const OrtKernelInfo *info, size_t index, OrtTypeInfo **type_info)
Get the type information for a OrtKernelInfo's input.
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 * GetSparseTensorIndicesTypeShape(const OrtValue *ort_value, enum OrtSparseIndicesFormat indices_format, OrtTensorTypeAndShapeInfo **out)
Returns data type, shape for the type of indices specified by indices_format.
OrtStatus * SessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, const OrtMIGraphXProviderOptions *migraphx_options)
Append MIGraphX provider to session options.
OrtStatus * RunOptionsSetRunLogVerbosityLevel(OrtRunOptions *options, int log_verbosity_level)
Set per-run log verbosity level.
OrtStatus * AddInitializer(OrtSessionOptions *options, const char *name, const OrtValue *val)
Add a pre-allocated initializer to a session.
OrtStatus * CreateEnv(OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * UseCooIndices(OrtValue *ort_value, int64_t *indices_data, size_t indices_num)
OrtStatus * GetTensorMutableData(OrtValue *value, void **out)
Get a pointer to the raw data inside a tensor.
OrtStatus * KernelInfoGetAllocator(const OrtKernelInfo *info, OrtMemType mem_type, OrtAllocator **out)
Get allocator from KernelInfo for a specific memory type. Please use C API ReleaseAllocator to releas...
OrtStatus * SessionOptionsAppendExecutionProvider_OpenVINO(OrtSessionOptions *options, const OrtOpenVINOProviderOptions *provider_options)
Append OpenVINO execution provider to the session options.
OrtStatus * IsSparseTensor(const OrtValue *value, int *out)
Sets *out to 1 iff an OrtValue is a SparseTensor, and 0 otherwise.
OrtStatus * GetTensorElementType(const OrtTensorTypeAndShapeInfo *info, enum ONNXTensorElementDataType *out)
Get element type in OrtTensorTypeAndShapeInfo.
OrtStatus * CreateSparseTensorAsOrtValue(OrtAllocator *allocator, const int64_t *dense_shape, size_t dense_shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create an OrtValue with a sparse tensor that is empty.
OrtStatus * FillStringTensorElement(OrtValue *value, const char *s, size_t index)
Set a single string in a string tensor.
OrtStatus * CreateTensorWithDataAsOrtValue(const OrtMemoryInfo *info, void *p_data, size_t p_data_len, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create a tensor backed by a user supplied buffer.
OrtStatus * AddExternalInitializers(OrtSessionOptions *options, const char *const *initializer_names, const OrtValue *const *initializers, size_t num_initializers)
Replace initialized Tensors with external data with the data provided in initializers.
OrtStatus * 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.
void(* MemoryInfoGetDeviceType)(const OrtMemoryInfo *ptr, OrtMemoryInfoDeviceType *out)
Definition onnxruntime_c_api.h:3864
OrtStatus * AddRunConfigEntry(OrtRunOptions *options, const char *config_key, const char *config_value)
Set a single run configuration entry as a pair of strings.
OrtStatus * GetBoundOutputValues(const OrtIoBinding *binding_ptr, OrtAllocator *allocator, OrtValue ***output, size_t *output_count)
Get the output OrtValue objects from an OrtIoBinding.
OrtStatus * ModelMetadataGetDomain(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get domain from an OrtModelMetadata.
OrtStatus * SetLanguageProjection(const OrtEnv *ort_env, OrtLanguageProjection projection)
Set language projection.
OrtStatus * FillStringTensor(OrtValue *value, const char *const *s, size_t s_len)
Set all strings at once in a string tensor.
OrtStatus * SetSessionLogId(OrtSessionOptions *options, const char *logid)
Set session log id.
OrtStatus * GetValueInfoTypeInfo(const OrtValueInfo *value_info, const OrtTypeInfo **type_info)
Get the type information from an OrtValueInfo instance.
OrtStatus * SessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, const OrtCUDAProviderOptions *cuda_options)
Append CUDA provider to session options.
OrtStatus * RegisterAllocator(OrtEnv *env, OrtAllocator *allocator)
Register a custom allocator.
OrtStatus * SetGlobalSpinControl(OrtThreadingOptions *tp_options, int allow_spinning)
Set global spin control options.
OrtStatus * MemoryInfoGetId(const OrtMemoryInfo *ptr, int *out)
Get the id from OrtMemoryInfo.
OrtStatus * KernelInfo_GetOutputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's output.
OrtStatus * Logger_LogMessage(const OrtLogger *logger, OrtLoggingLevel log_severity_level, const char *message, const char *file_path, int line_number, const char *func_name)
Logs a message at the given severity level using the provided OrtLogger.
OrtStatus * CreateEnvWithCustomLogger(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * UpdateCUDAProviderOptionsWithValue(OrtCUDAProviderOptionsV2 *cuda_options, const char *key, void *value)
OrtStatus * MemoryInfoGetName(const OrtMemoryInfo *ptr, const char **out)
Get name from OrtMemoryInfo.
OrtStatus * Logger_GetLoggingSeverityLevel(const OrtLogger *logger, OrtLoggingLevel *out)
Get the logging severity level of the OrtLogger.
OrtStatus * GetExecutionProviderApi(const char *provider_name, uint32_t version, const void **provider_api)
Get a pointer to the requested version of the Execution Provider specific API extensions to the OrtAp...
const OrtModelEditorApi *(* GetModelEditorApi)()
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:4884
OrtStatus * KernelContext_GetOutputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the output count of a kernel.
OrtStatus * GetTensorShapeElementCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get total number of elements in a tensor shape from an OrtTensorTypeAndShapeInfo.
OrtStatus * CastTypeInfoToTensorInfo(const OrtTypeInfo *type_info, const OrtTensorTypeAndShapeInfo **out)
Get OrtTensorTypeAndShapeInfo from an OrtTypeInfo.
OrtStatus * 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 * 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 * UpdateCUDAProviderOptions(OrtCUDAProviderOptionsV2 *cuda_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CUDA Execution Provider.
OrtStatus * CopyKernelInfo(const OrtKernelInfo *info, OrtKernelInfo **info_copy)
OrtStatus * GetTensorRTProviderOptionsAsString(const OrtTensorRTProviderOptionsV2 *tensorrt_options, OrtAllocator *allocator, char **ptr)
Get serialized TensorRT provider options string.
OrtStatus * SessionOptionsSetCustomThreadCreationOptions(OrtSessionOptions *options, void *ort_custom_thread_creation_options)
Set creation options for custom thread.
OrtStatus * GetDimensionsCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get dimension count in OrtTensorTypeAndShapeInfo.
void(* ReleaseROCMProviderOptions)(OrtROCMProviderOptions *input)
Release an OrtROCMProviderOptions.
Definition onnxruntime_c_api.h:4443
OrtStatus * UpdateROCMProviderOptions(OrtROCMProviderOptions *rocm_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a ROCm Execution Provider.
OrtStatus * KernelInfo_GetInputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's input.
OrtStatus * KernelContext_GetResource(const OrtKernelContext *context, int resource_version, int resource_id, void **resource)
OrtStatus * RegisterCustomOpsLibrary(OrtSessionOptions *options, const char *library_path, void **library_handle)
OrtStatus * SetCurrentGpuDeviceId(int device_id)
Set current GPU device ID.
OrtStatus * GetOnnxTypeFromTypeInfo(const OrtTypeInfo *type_info, enum ONNXType *out)
Get ONNXType from OrtTypeInfo.
OrtStatus * CreateLoraAdapterFromArray(const void *bytes, size_t num_bytes, OrtAllocator *allocator, OrtLoraAdapter **out)
Create an OrtLoraAdapter.
OrtStatus * GetDenotationFromTypeInfo(const OrtTypeInfo *type_info, const char **const denotation, size_t *len)
Get denotation from type information.
OrtStatus * KernelContext_ParallelFor(const OrtKernelContext *context, void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data)
void(* ReleaseCANNProviderOptions)(OrtCANNProviderOptions *input)
Release an OrtCANNProviderOptions.
Definition onnxruntime_c_api.h:3858
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 * EnableTelemetryEvents(const OrtEnv *env)
Enable Telemetry.
OrtStatus * CreateMemoryInfo(const char *name, enum OrtAllocatorType type, int id, enum OrtMemType mem_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo.
OrtStatus * SessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, const OrtROCMProviderOptions *rocm_options)
Append ROCM execution provider to the session options.
OrtStatus * SessionGetInputTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get input type information.
OrtStatus * GetSymbolicDimensions(const OrtTensorTypeAndShapeInfo *info, const char *dim_params[], size_t dim_params_length)
Get symbolic dimension names in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionOptionsAppendExecutionProvider_OpenVINO_V2(OrtSessionOptions *options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Append OpenVINO execution provider to the session options.
OrtStatus * GetStringTensorDataLength(const OrtValue *value, size_t *len)
Get total byte length for all strings in a string tensor.
OrtStatus * KernelContext_GetInputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the input count of a kernel.
OrtStatus * BindOutputToDevice(OrtIoBinding *binding_ptr, const char *name, const OrtMemoryInfo *mem_info_ptr)
Bind an OrtIoBinding output to a device.
OrtStatus * SessionOptionsAppendExecutionProvider(OrtSessionOptions *options, const char *provider_name, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
: Append execution provider to the session options.
OrtStatus * SetSessionGraphOptimizationLevel(OrtSessionOptions *options, GraphOptimizationLevel graph_optimization_level)
Set the optimization level to apply when loading a graph.
OrtStatus * ModelMetadataGetDescription(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get description from an OrtModelMetadata.
OrtStatus * CreateCANNProviderOptions(OrtCANNProviderOptions **out)
Create an OrtCANNProviderOptions.
OrtStatus * ReadOpAttr(const OrtOpAttr *op_attr, OrtOpAttrType type, void *data, size_t len, size_t *out)
OrtStatus * DisablePerSessionThreads(OrtSessionOptions *options)
Use global thread pool on a session.
OrtStatus * SetDimensions(OrtTensorTypeAndShapeInfo *info, const int64_t *dim_values, size_t dim_count)
Set shape information in OrtTensorTypeAndShapeInfo.
OrtStatus * SetInterOpNumThreads(OrtSessionOptions *options, int inter_op_num_threads)
Sets the number of threads used to parallelize the execution of the graph.
OrtStatus * CustomOpDomain_Add(OrtCustomOpDomain *custom_op_domain, const OrtCustomOp *op)
Add a custom op to a custom op domain.
OrtStatus * GetSequenceElementType(const OrtSequenceTypeInfo *sequence_type_info, OrtTypeInfo **type_info)
Get element type from an OrtSequenceTypeInfo.
OrtStatus * RunOptionsGetRunLogVerbosityLevel(const OrtRunOptions *options, int *log_verbosity_level)
Get per-run log verbosity level.
OrtStatus * FillSparseTensorCsr(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *inner_indices_data, size_t inner_indices_num, const int64_t *outer_indices_data, size_t outer_indices_num)
OrtStatus * CreateAndRegisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Create an allocator and register it with the OrtEnv.
OrtStatus * CreateCpuMemoryInfo(enum OrtAllocatorType type, enum OrtMemType mem_type, OrtMemoryInfo **out)
Create an OrtMemoryInfo for CPU memory.
OrtStatus * AddCustomOpDomain(OrtSessionOptions *options, OrtCustomOpDomain *custom_op_domain)
Add custom op domain to a session options.
OrtStatus * KernelInfo_GetOutputTypeInfo(const OrtKernelInfo *info, size_t index, OrtTypeInfo **type_info)
Get the type information for a OrtKernelInfo's output.
OrtStatus * KernelContext_GetInput(const OrtKernelContext *context, size_t index, const OrtValue **out)
Used for custom operators, get an input of a kernel.
OrtStatus * CreateEnvWithCustomLoggerAndGlobalThreadPools(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, const struct OrtThreadingOptions *tp_options, OrtEnv **out)
OrtStatus * DisableTelemetryEvents(const OrtEnv *env)
Disable Telemetry.
OrtStatus * KernelInfo_GetOutputCount(const OrtKernelInfo *info, size_t *out)
Get the number of outputs from OrtKernelInfo.
OrtStatus * CreateTensorWithDataAndDeleterAsOrtValue(OrtAllocator *deleter, void *p_data, size_t p_data_len, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type, OrtValue **out)
Create an OrtValue for a Tensor that uses pre-existing memory.
OrtStatus * ShapeInferContext_GetInputCount(const OrtShapeInferContext *context, size_t *out)
OrtStatus * ModelMetadataGetGraphName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get graph name from an OrtModelMetadata.
OrtStatus * CreateROCMProviderOptions(OrtROCMProviderOptions **out)
Create an OrtROCMProviderOptions.
OrtStatus * ModelMetadataLookupCustomMetadataMap(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, const char *key, char **value)
Return data for a key in the custom metadata map in an OrtModelMetadata.
OrtStatus * 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 * 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 * CreateLoraAdapter(const char *adapter_file_path, OrtAllocator *allocator, OrtLoraAdapter **out)
Create an OrtLoraAdapter.
OrtStatus * GetDnnlProviderOptionsAsString(const OrtDnnlProviderOptions *dnnl_options, OrtAllocator *allocator, char **ptr)
OrtStatus * CreateRunOptions(OrtRunOptions **out)
Create an OrtRunOptions.
OrtStatus * RunOptionsGetRunTag(const OrtRunOptions *options, const char **run_tag)
Get per-run tag.
OrtStatus * CreateCustomOpDomain(const char *domain, OrtCustomOpDomain **out)
Create a custom op domain.
OrtStatus * ModelMetadataGetCustomMetadataMapKeys(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char ***keys, int64_t *num_keys)
const char *(* GetErrorMessage)(const OrtStatus *status) __attribute__((nonnull))
Get error string from OrtStatus.
Definition onnxruntime_c_api.h:779
OrtStatus * IsTensor(const OrtValue *value, int *out)
Return if an OrtValue is a tensor type.
OrtStatus * AllocatorFree(OrtAllocator *ort_allocator, void *p)
Calls OrtAllocator::Free function.
OrtStatus * GetMapValueType(const OrtMapTypeInfo *map_type_info, OrtTypeInfo **type_info)
Get the value type from an OrtMapTypeInfo.
OrtStatus * CreateSessionFromArray(const OrtEnv *env, const void *model_data, size_t model_data_length, const OrtSessionOptions *options, OrtSession **out)
Create an OrtSession from memory.
OrtStatus * CreateArenaCfgV2(const char *const *arena_config_keys, const size_t *arena_config_values, size_t num_keys, OrtArenaCfg **out)
Create an OrtArenaCfg.
OrtStatus * 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.
OrtStatus * GetValue(const OrtValue *value, int index, OrtAllocator *allocator, OrtValue **out)
Get non tensor data from an OrtValue.
OrtStatus * ShapeInferContext_GetAttribute(const OrtShapeInferContext *context, const char *attr_name, const OrtOpAttr **attr)
OrtStatus * GetSparseTensorIndices(const OrtValue *ort_value, enum OrtSparseIndicesFormat indices_format, size_t *num_indices, const void **indices)
Returns indices data for the type of the indices specified by indices_format.
OrtStatus * EnableProfiling(OrtSessionOptions *options, const char *profile_file_prefix)
Enable profiling for a session.
OrtStatus * SetUserLoggingFunction(OrtSessionOptions *options, OrtLoggingFunction user_logging_function, void *user_logging_param)
Set user logging function.
OrtStatus * GetStringTensorElement(const OrtValue *value, size_t s_len, size_t index, void *s)
Get a single string from a string tensor.
OrtStatus * GetTensorTypeAndShape(const OrtValue *value, OrtTensorTypeAndShapeInfo **out)
Get type and shape information from a tensor OrtValue.
OrtStatus * BindInput(OrtIoBinding *binding_ptr, const char *name, const OrtValue *val_ptr)
Bind an OrtValue to an OrtIoBinding input.
OrtStatus * GetResizedStringTensorElementBuffer(OrtValue *value, size_t index, size_t length_in_bytes, char **buffer)
Set a single string in a string tensor Do not zero terminate the string data.
OrtStatus * DisableCpuMemArena(OrtSessionOptions *options)
Disable the memory arena on CPU.
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition onnxruntime_c_api.h:2451
OrtStatus * SetSymbolicDimensions(OrtTensorTypeAndShapeInfo *info, const char *dim_params[], size_t dim_params_length)
OrtStatus * SessionOptionsAppendExecutionProvider_CANN(OrtSessionOptions *options, const OrtCANNProviderOptions *cann_options)
Append CANN provider to session options.
OrtStatus * MemoryInfoGetMemType(const OrtMemoryInfo *ptr, OrtMemType *out)
Get the OrtMemType from OrtMemoryInfo.
OrtStatus * AllocatorGetInfo(const OrtAllocator *ort_allocator, const struct OrtMemoryInfo **out)
Calls OrtAllocator::Info function.
OrtStatus * CompareMemoryInfo(const OrtMemoryInfo *info1, const OrtMemoryInfo *info2, int *out)
Compare OrtMemoryInfo objects for equality.
OrtStatus * GetAvailableProviders(char ***out_ptr, int *provider_length)
Get the names of all available providers.
OrtStatus * SynchronizeBoundInputs(OrtIoBinding *binding_ptr)
Synchronize bound inputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * GetOpaqueValue(const char *domain_name, const char *type_name, const OrtValue *in, void *data_container, size_t data_container_size)
Get internal data from an opaque (custom user defined type) OrtValue.
OrtStatus * AllocatorAlloc(OrtAllocator *ort_allocator, size_t size, void **out)
Calls OrtAllocator::Alloc function.
OrtStatus * RunAsync(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *input, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **output, RunAsyncCallbackFn run_async_callback, void *user_data)
Run the model asynchronously in a thread owned by intra op thread pool.
OrtStatus * GetTensorRTProviderOptionsByName(const OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *key, void **ptr)
OrtStatus * RegisterCustomOpsLibrary_V2(OrtSessionOptions *options, const char *library_name)
Register custom ops from a shared library.
OrtStatus * SessionGetOverridableInitializerName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get overridable initializer name.
OrtStatus * GetROCMProviderOptionsAsString(const OrtROCMProviderOptions *rocm_options, OrtAllocator *allocator, char **ptr)
OrtStatus * UnregisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info)
Unregister a custom allocator.
OrtStatus * DisableMemPattern(OrtSessionOptions *options)
Disable the memory pattern optimization.
OrtStatus * UseBlockSparseIndices(OrtValue *ort_value, const int64_t *indices_shape, size_t indices_shape_len, int32_t *indices_data)
OrtStatus * SetEpDynamicOptions(OrtSession *sess, const char *const *keys, const char *const *values, size_t kv_len)
Set DynamicOptions for EPs (Execution Providers)
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:765
OrtStatus * RunWithBinding(OrtSession *session, const OrtRunOptions *run_options, const OrtIoBinding *binding_ptr)
Run a model using Io Bindings for the inputs & outputs.
OrtStatus * CreateDnnlProviderOptions(OrtDnnlProviderOptions **out)
Create an OrtDnnlProviderOptions.
OrtStatus * GetMapKeyType(const OrtMapTypeInfo *map_type_info, enum ONNXTensorElementDataType *out)
Get key type from an OrtMapTypeInfo.
OrtStatus * RunOptionsGetRunLogSeverityLevel(const OrtRunOptions *options, int *log_severity_level)
Get per-run log severity level.
OrtStatus * CastTypeInfoToOptionalTypeInfo(const OrtTypeInfo *type_info, const OrtOptionalTypeInfo **out)
Get Optional Type information from an OrtTypeInfo.
OrtStatus * SessionGetModelMetadata(const OrtSession *session, OrtModelMetadata **out)
Get OrtModelMetadata from an OrtSession.
OrtStatus * 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 sepcific OrtMemoryInfo object....
OrtStatus * EnableOrtCustomOps(OrtSessionOptions *options)
Enable custom operators.
OrtStatus * UpdateEnvWithCustomLogLevel(OrtEnv *ort_env, OrtLoggingLevel log_severity_level)
OrtStatus * CreateValue(const OrtValue *const *in, size_t num_values, enum ONNXType value_type, OrtValue **out)
Create a map or sequence OrtValue.
OrtStatus * SessionOptionsAppendExecutionProvider_VitisAI(OrtSessionOptions *options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Append VitisAI provider to session options.
OrtStatus * RegisterCustomOpsUsingFunction(OrtSessionOptions *options, const char *registration_func_name)
Register custom ops by calling a RegisterCustomOpsFn function.
OrtStatus * RunOptionsSetTerminate(OrtRunOptions *options)
Set terminate flag.
OrtStatus * SetSessionLogVerbosityLevel(OrtSessionOptions *options, int session_log_verbosity_level)
Set session log verbosity level.
OrtStatus * SetSessionLogSeverityLevel(OrtSessionOptions *options, int session_log_severity_level)
Set session log severity level.
OrtStatus * CreateThreadingOptions(OrtThreadingOptions **out)
Create an OrtThreadingOptions.
OrtStatus * UseCsrIndices(OrtValue *ort_value, int64_t *inner_data, size_t inner_num, int64_t *outer_data, size_t outer_num)
OrtStatus * SessionGetOverridableInitializerCount(const OrtSession *session, size_t *out)
Get overridable initializer count.
OrtStatus * GetValueInfoName(const OrtValueInfo *value_info, const char **name)
Get the value name from an OrtValueInfo instance.
OrtStatus * 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.
OrtStatus * CreateAllocator(const OrtSession *session, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Create an allocator for an OrtSession following an OrtMemoryInfo.
OrtStatus * SynchronizeBoundOutputs(OrtIoBinding *binding_ptr)
Synchronize bound outputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * SessionGetOutputCount(const OrtSession *session, size_t *out)
Get output count for a session.
OrtStatus * CastTypeInfoToSequenceTypeInfo(const OrtTypeInfo *type_info, const OrtSequenceTypeInfo **out)
Cast OrtTypeInfo to an OrtSequenceTypeInfo.
OrtStatus * Run(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *inputs, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **outputs)
Run the model in an OrtSession.
OrtStatus * GetValueType(const OrtValue *value, enum ONNXType *out)
Get ONNXType of an OrtValue.
OrtStatus * ShapeInferContext_GetInputTypeShape(const OrtShapeInferContext *context, size_t index, OrtTensorTypeAndShapeInfo **info)
OrtStatus * KernelInfo_GetNodeName(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node name from OrtKernelInfo.
OrtStatus * CreateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 **out)
Create an OrtTensorRTProviderOptionsV2.
OrtStatus * GetDimensions(const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)
Get dimensions in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionGetProfilingStartTimeNs(const OrtSession *session, uint64_t *out)
Return the time that profiling was started.
OrtStatus * RunOptionsUnsetTerminate(OrtRunOptions *options)
Clears the terminate flag.
OrtStatus * CreateOpaqueValue(const char *domain_name, const char *type_name, const void *data_container, size_t data_container_size, OrtValue **out)
Create an opaque (custom user defined type) OrtValue.
OrtStatus * GetSparseTensorValuesTypeAndShape(const OrtValue *ort_value, OrtTensorTypeAndShapeInfo **out)
Returns data type and shape of sparse tensor values (nnz) iff OrtValue contains a SparseTensor.
void(* ReleaseTensorRTProviderOptions)(OrtTensorRTProviderOptionsV2 *input)
Release an OrtTensorRTProviderOptionsV2.
Definition onnxruntime_c_api.h:3008
OrtStatus * ReleaseAvailableProviders(char **ptr, int providers_length)
Release data from OrtApi::GetAvailableProviders. This API will never fail so you can rely on it in a ...
OrtStatus * RunOptionsSetRunTag(OrtRunOptions *options, const char *run_tag)
Set per-run tag.
OrtStatus * CreateIoBinding(OrtSession *session, OrtIoBinding **out)
Create an OrtIoBinding instance.
OrtStatus * SetGlobalIntraOpNumThreads(OrtThreadingOptions *tp_options, int intra_op_num_threads)
Set global intra-op thread count.
OrtStatus * CreateOpAttr(const char *name, const void *data, int len, OrtOpAttrType type, OrtOpAttr **op_attr)
: Create attribute of onnxruntime operator
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)
OrtStatus * ModelMetadataGetVersion(const OrtModelMetadata *model_metadata, int64_t *value)
Get version number from an OrtModelMetadata.
OrtStatus * GetStringTensorContent(const OrtValue *value, void *s, size_t s_len, size_t *offsets, size_t offsets_len)
Get all strings from a string tensor.
OrtStatus * GetBoundOutputNames(const OrtIoBinding *binding_ptr, OrtAllocator *allocator, char **buffer, size_t **lengths, size_t *count)
Get the names of an OrtIoBinding's outputs.
OrtStatus * CreateTensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo **out)
Create an OrtTensorTypeAndShapeInfo object.
OrtStatus * FillSparseTensorCoo(OrtValue *ort_value, const OrtMemoryInfo *data_mem_info, const int64_t *values_shape, size_t values_shape_len, const void *values, const int64_t *indices_data, size_t indices_num)
OrtStatus * SessionEndProfiling(OrtSession *session, OrtAllocator *allocator, char **out)
End profiling and return filename of the profile data.
OrtStatus * ModelMetadataGetProducerName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get producer name from an OrtModelMetadata.
OrtStatus * SessionOptionsSetCustomCreateThreadFn(OrtSessionOptions *options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Set custom thread creation function.
OrtStatus * SetGlobalCustomCreateThreadFn(OrtThreadingOptions *tp_options, OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Set custom thread creation function for global thread pools.
OrtStatus * 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(* ReleaseCUDAProviderOptions)(OrtCUDAProviderOptionsV2 *input)
Release an OrtCUDAProviderOptionsV2.
Definition onnxruntime_c_api.h:3511
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:772
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:417
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:496
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:470
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:465
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:475
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:485
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:448
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:456
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:419
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:479
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:491
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:442
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:436
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:5482
OrtStatus * ModelCompilationOptions_SetOutputModelBuffer(OrtModelCompilationOptions *model_compile_options, OrtAllocator *allocator, void **output_model_buffer_ptr, size_t *output_model_buffer_size_ptr)
Configures model compilation to store the output compiled ONNX model in a buffer.
OrtStatus * ModelCompilationOptions_SetInputModelFromBuffer(OrtModelCompilationOptions *model_compile_options, const void *input_model_data, size_t input_model_data_size)
Sets the buffer that stores the bytes of the loaded ONNX model to compile.
OrtStatus * ModelCompilationOptions_SetInputModelPath(OrtModelCompilationOptions *model_compile_options, const char *input_model_path)
Sets the file path to the input ONNX model to compile.
OrtStatus * ModelCompilationOptions_SetOutputModelExternalInitializersFile(OrtModelCompilationOptions *model_compile_options, const char *external_initializers_file_path, size_t external_initializers_size_threshold)
Optionally sets the file that should store external initializers for the compiled ONNX model....
OrtStatus * CreateModelCompilationOptionsFromSessionOptions(const OrtEnv *env, const OrtSessionOptions *session_options, OrtModelCompilationOptions **out)
Creates an OrtModelCompilationOptions object from an existing OrtSessionOptions object.
OrtStatus * ModelCompilationOptions_SetEpContextEmbedMode(OrtModelCompilationOptions *model_compile_options, bool embed_ep_context_in_model)
Enables or disables the embedding of EPContext binary data into the ep_cache_context attribute of EPC...
OrtStatus * ModelCompilationOptions_SetOutputModelPath(OrtModelCompilationOptions *model_compile_options, const char *output_model_path)
Sets the file path for the output ONNX model generated by CompileModel.
OrtStatus * CompileModel(const OrtEnv *env, const OrtModelCompilationOptions *model_options)
Compiles an input ONNX model with the given compilation options.
Definition onnxruntime_c_api.h:718
char __place_holder
Definition onnxruntime_c_api.h:719
Definition onnxruntime_c_api.h:4970
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5016
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5000
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4988
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5020
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:5053
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5038
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:5050
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4981
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4990
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:4996
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5025
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:5007
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:4977
uint32_t version
Definition onnxruntime_c_api.h:4971
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4987
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:5054
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4999
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4984
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4989
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5011
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:5035
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:5039
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:5028
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:5046
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:5033
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4995
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:621
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:631
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:627
int migraphx_int8_enable
Definition onnxruntime_c_api.h:624
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:629
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:623
int device_id
Definition onnxruntime_c_api.h:622
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:625
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:630
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:628
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:626
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:5068
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:643
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:664
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:661
void * context
Definition onnxruntime_c_api.h:663
const char * cache_dir
Definition onnxruntime_c_api.h:662
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:658
const char * device_id
Definition onnxruntime_c_api.h:660
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:659
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:645
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:665
ROCM Provider Options.
Definition onnxruntime_c_api.h:504
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:524
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:585
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:552
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:566
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:535
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:506
int enable_hip_graph
Definition onnxruntime_c_api.h:568
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:574
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:562
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:543
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:580
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:557
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:529
TensorRT Provider Options.
Definition onnxruntime_c_api.h:593
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:607
void * user_compute_stream
Definition onnxruntime_c_api.h:596
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:594
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:608
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:609
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:597
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:599
int trt_dla_enable
Definition onnxruntime_c_api.h:604
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:602
int has_user_compute_stream
Definition onnxruntime_c_api.h:595
int trt_dla_core
Definition onnxruntime_c_api.h:605
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:603
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:598
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:611
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:606
int trt_fp16_enable
Definition onnxruntime_c_api.h:600
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:610
int trt_int8_enable
Definition onnxruntime_c_api.h:601
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122