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 20
42
43#ifdef __cplusplus
44extern "C" {
45#endif
46
48// SAL2 Definitions
49#ifndef _WIN32
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
259
269
271#define ORT_RUNTIME_CLASS(X) \
272 struct Ort##X; \
273 typedef struct Ort##X Ort##X
274
279// The actual types defined have an Ort prefix
280ORT_RUNTIME_CLASS(Env);
281ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
282ORT_RUNTIME_CLASS(MemoryInfo);
283ORT_RUNTIME_CLASS(IoBinding);
284ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
285ORT_RUNTIME_CLASS(Value);
286ORT_RUNTIME_CLASS(RunOptions);
287ORT_RUNTIME_CLASS(TypeInfo);
288ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
289ORT_RUNTIME_CLASS(MapTypeInfo);
290ORT_RUNTIME_CLASS(SequenceTypeInfo);
291ORT_RUNTIME_CLASS(OptionalTypeInfo);
292ORT_RUNTIME_CLASS(SessionOptions);
293ORT_RUNTIME_CLASS(CustomOpDomain);
294ORT_RUNTIME_CLASS(ModelMetadata);
295ORT_RUNTIME_CLASS(ThreadPoolParams);
296ORT_RUNTIME_CLASS(ThreadingOptions);
297ORT_RUNTIME_CLASS(ArenaCfg);
298ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
299ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
300ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
301ORT_RUNTIME_CLASS(CANNProviderOptions);
302ORT_RUNTIME_CLASS(DnnlProviderOptions);
303ORT_RUNTIME_CLASS(Op);
304ORT_RUNTIME_CLASS(OpAttr);
305ORT_RUNTIME_CLASS(Logger);
306ORT_RUNTIME_CLASS(ShapeInferContext);
307ORT_RUNTIME_CLASS(LoraAdapter);
308
309#ifdef _WIN32
310typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
311#else
313#endif
314
321typedef struct OrtAllocator {
322 uint32_t version;
323 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
324 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
325 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
331 void*(ORT_API_CALL* Reserve)(struct OrtAllocator* this_, size_t size);
333
334typedef void(ORT_API_CALL* OrtLoggingFunction)(
335 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
336 const char* message);
337
349
354
367
368struct OrtKernelInfo;
370struct OrtKernelContext;
372struct OrtCustomOp;
374
380
383// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
390
398
402 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
403 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
404 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
406
493
582
589 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
590 void* user_compute_stream; // user specified CUDA compute stream.
591 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
592 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
593 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
594 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
595 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
596 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
597 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
598 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
599 int trt_dla_core; // DLA core number. Default 0
600 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
601 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
602 const char* trt_engine_cache_path; // specify engine cache path
603 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
604 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
605 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
606 // This is the legacy struct and don't add new fields here.
607 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
608 // For non-string field, need to create a new separate api to handle it.
610
616 int device_id; // hip device id.
617 int migraphx_fp16_enable; // MIGraphX FP16 precision. Default 0 = false, nonzero = true
618 int migraphx_int8_enable; // MIGraphX INT8 precision. Default 0 = false, nonzero = true
619 int migraphx_use_native_calibration_table; // MIGraphx INT8 cal table. Default 0 = false, noznero = true
620 const char* migraphx_int8_calibration_table_name; // MIGraphx INT8 calibration table name
621 int migraphx_save_compiled_model; // migraphx save compiled model. Default 0 = false, noznero = true
622 const char* migraphx_save_model_path; // migraphx model path name
623 int migraphx_load_compiled_model; // migraphx int8 cal table. Default 0 = false, noznero = true
624 const char* migraphx_load_model_path; // migraphx model path name
625 bool migraphx_exhaustive_tune; // migraphx tuned compile Default = false
627
633#ifdef __cplusplus
642#endif
647 const char* device_type;
649 const char* device_id;
651 const char* cache_dir; // path is set to empty by default
652 void* context;
654 unsigned char enable_dynamic_shapes;
656
657struct OrtApi;
658typedef struct OrtApi OrtApi;
659
660struct OrtTrainingApi;
662
677 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
678
683 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
684};
685
686typedef struct OrtApiBase OrtApiBase;
687
692ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
693
699typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
700
704
710typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
711
717typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
718
719typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
720
728typedef void (*RunAsyncCallbackFn)(void* user_data, OrtValue** outputs, size_t num_outputs, OrtStatusPtr status);
729
737struct OrtApi {
740
748 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
749
755 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
756
762 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
763
767
778 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
779
794 ORT_API2_STATUS(CreateEnvWithCustomLogger, _In_ OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
795 _In_ OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
796
804 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
812 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
813
817
827 // TODO: document the path separator convention? '/' vs '\'
828 // TODO: should specify the access characteristics of model_path. Is this read only during the
829 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
830 // and continue to access throughout the OrtSession lifetime?
831 // What sort of access is needed to model_path : read or read/write?
832 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
833 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
834
845 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env, _In_ const void* model_data, size_t model_data_length,
846 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
847
866 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
867 _In_reads_(input_len) const char* const* input_names,
868 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
869 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
870 _Inout_updates_all_(output_names_len) OrtValue** outputs);
871
875
891 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
892
900 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
901 _In_ const ORTCHAR_T* optimized_model_filepath);
902
910 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
911 _Outptr_ OrtSessionOptions** out_options);
912
924 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
925
933 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
934
941 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
942
956 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
957
966 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
967
976 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
977
984 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
985
993 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
994
1004 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
1005
1013 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
1014
1023 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
1024 GraphOptimizationLevel graph_optimization_level);
1025
1039 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1040
1053 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1054
1058
1066 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1067
1077 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1078
1082
1092 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1093
1110 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1111
1115
1127 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1128
1140 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1141
1151 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1152
1161 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1162
1171 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1172
1181 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1182
1192 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1193
1203 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1204
1214 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1215 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1216
1220
1227 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1228
1238 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1239
1247 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1248
1258 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1259
1269 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1270 _Out_ int* log_verbosity_level);
1271
1279 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1280
1292 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1293
1302 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1303
1312 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1313
1317
1330 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1332
1348 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1349 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1350 _Outptr_ OrtValue** out);
1351
1359 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1360
1371 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1372
1381 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1382
1392 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1393
1413 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1414 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1415
1419
1428 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1429 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1430
1438 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1439
1443
1451
1460
1469 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1470
1480 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1482
1492 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1493
1502 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1503 size_t dim_values_length);
1504
1513 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1514 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1515
1532 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1533
1537
1545 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
1546
1554 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
1555
1563 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
1564
1568
1579 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
1580 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
1581
1592 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
1593 _Outptr_ OrtMemoryInfo** out);
1594
1605 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
1606
1614 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
1615
1618 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
1619
1622 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
1623
1626 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
1627
1631
1633 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
1635 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
1637 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
1638
1647 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
1648
1652
1664 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
1665 _In_ int64_t dim_value);
1666
1670
1671 /* Internal information (not seen in Doxygen)
1672 *
1673 * APIs to support non-tensor types - map and sequence.
1674 * Currently only the following types are supported
1675 * Note: the following types should be kept in sync with data_types.h
1676 * Map types
1677 * =========
1678 * std::map<std::string, std::string>
1679 * std::map<std::string, int64_t>
1680 * std::map<std::string, float>
1681 * std::map<std::string, double>
1682 * std::map<int64_t, std::string>
1683 * std::map<int64_t, int64_t>
1684 * std::map<int64_t, float>
1685 * std::map<int64_t, double>
1686 *
1687 * Sequence types
1688 * ==============
1689 * std::vector<std::string>
1690 * std::vector<int64_t>
1691 * std::vector<float>
1692 * std::vector<double>
1693 * std::vector<std::map<std::string, float>>
1694 * std::vector<std::map<int64_t, float>
1695 */
1696
1711 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
1712 _Outptr_ OrtValue** out);
1713
1724 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
1725
1741 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
1742 enum ONNXType value_type, _Outptr_ OrtValue** out);
1743
1766 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
1767 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
1768
1783 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
1784 _Out_ void* data_container, size_t data_container_size);
1785
1790
1799 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
1800 _Out_ float* out);
1801
1810 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
1811 _Out_ int64_t* out);
1812
1833 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
1834 _Inout_ size_t* size);
1835
1840
1845 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1846
1851 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1852
1864 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
1865 _Out_ const OrtValue** out);
1866
1880 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
1881 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
1882
1886 ORT_CLASS_RELEASE(Env);
1890 ORT_CLASS_RELEASE(Status);
1894 ORT_CLASS_RELEASE(MemoryInfo);
1898 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
1902 ORT_CLASS_RELEASE(Value);
1906 ORT_CLASS_RELEASE(RunOptions);
1910 ORT_CLASS_RELEASE(TypeInfo);
1914 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
1918 ORT_CLASS_RELEASE(SessionOptions);
1922 ORT_CLASS_RELEASE(CustomOpDomain);
1923
1927
1940 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
1941 _Out_ size_t* len);
1942
1956 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
1957 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
1958
1972 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
1973 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
1974
1978
1990 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
1991
1999 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
2000
2004
2014 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
2015 _Outptr_ OrtTypeInfo** type_info);
2016
2020 ORT_CLASS_RELEASE(MapTypeInfo);
2024 ORT_CLASS_RELEASE(SequenceTypeInfo);
2025
2029
2040 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
2041
2049 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
2050
2054
2063 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2064 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2065
2074 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2075 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2076
2085 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2086 _Outptr_ char** value);
2087
2096 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2097 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2098
2109 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2110 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2111
2119 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2120
2121 ORT_CLASS_RELEASE(ModelMetadata);
2122
2126
2140 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2141 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2142
2146
2156 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2157
2161
2167 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2168
2169 ORT_CLASS_RELEASE(ThreadingOptions);
2170
2174
2186 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2187 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2188
2192
2200 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2201 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2202 _In_ int64_t dim_value);
2203
2207
2219 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2220
2229 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2230 _In_ int providers_length);
2231
2235
2244 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2245
2255 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2256
2265 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2266
2270
2283 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2284 _In_z_ const char* config_key, _In_z_ const char* config_value);
2285
2289
2298 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2299 _Outptr_ OrtAllocator** out);
2300
2303 ORT_CLASS_RELEASE(Allocator);
2304
2308
2319 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2320
2332 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2333
2337
2340 ORT_CLASS_RELEASE(IoBinding);
2341
2352 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2353
2364 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2365
2381 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2382
2400 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2401 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2402
2420 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2421 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2422
2425 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2426
2429 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2430
2434
2449 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2450
2454
2469 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2470 _In_ const OrtArenaCfg* arena_cfg);
2471
2483 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2484
2488
2498 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2499
2503
2515 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2516
2528 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
2529
2543 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
2544
2548
2563 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
2564 _In_ const OrtValue* val);
2565
2569
2585 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
2586 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2587
2591
2602 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
2603
2614 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
2615
2626 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
2627
2631
2642 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
2643
2647
2660 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
2661 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
2662
2663 ORT_CLASS_RELEASE(ArenaCfg);
2664
2668
2680 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
2681 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2682
2686
2697 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
2698
2702
2713 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
2714
2725 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
2726
2731
2754 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2755 _Out_ float* out, _Inout_ size_t* size);
2756
2778 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2779 _Out_ int64_t* out, _Inout_ size_t* size);
2780
2784
2816 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
2817 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
2818 _Outptr_ OrtArenaCfg** out);
2819
2823
2836 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
2837 _In_z_ const char* config_key, _In_z_ const char* config_value);
2838
2842
2856
2861 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
2862
2866
2884 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
2885 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2886 _Outptr_ OrtSession** out);
2887
2906 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
2907 _In_ const void* model_data, size_t model_data_length,
2908 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2909 _Outptr_ OrtSession** out);
2910
2914
2933 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
2934
2938
2946
2962 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
2963 _In_reads_(num_keys) const char* const* provider_options_keys,
2964 _In_reads_(num_keys) const char* const* provider_options_values,
2965 _In_ size_t num_keys);
2966
2978 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
2979
2984 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
2985
2989
2996 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
2997
3001
3017 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
3018
3029 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
3030 _In_ const OrtMemoryInfo* mem_info);
3031
3035
3044 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
3045
3062 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3063 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3064
3082 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3083 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3084 _In_ const int64_t* indices_data, size_t indices_num);
3085
3105 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3106 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3107 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3108 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3109
3128 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3129 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3130 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3131 _In_ const int32_t* indices_data);
3132
3157 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3158 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3159 _In_ const int64_t* values_shape, size_t values_shape_len,
3161
3176 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3177
3194 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3195 _Inout_ int64_t* outer_data, size_t outer_num);
3196
3210 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3211
3219 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3220
3228 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3229
3237 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3238
3248 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3249
3259 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3263
3276 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3277
3282
3294 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3295
3299
3305 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3306
3310
3320 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3321
3323
3326
3333 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3334
3342 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3343
3351 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3353
3356
3363 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3364
3372 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3373
3381 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3383
3392 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3393
3402 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3403
3406
3427 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3428
3432
3441 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3442
3460 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3461 _In_reads_(num_keys) const char* const* provider_options_keys,
3462 _In_reads_(num_keys) const char* const* provider_options_values,
3463 _In_ size_t num_keys);
3464
3479 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3480
3487 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3488
3490
3503 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3504
3526 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
3527 _In_reads_(num_initializers) const char* const* initializer_names,
3528 _In_reads_(num_initializers) const OrtValue* const* initializers, size_t num_initializers);
3529
3540 ORT_API2_STATUS(CreateOpAttr,
3541 _In_ const char* name,
3542 _In_ const void* data,
3543 _In_ int len,
3544 _In_ OrtOpAttrType type,
3545 _Outptr_ OrtOpAttr** op_attr);
3546
3547 /* \brief: Release op attribute
3548 *
3549 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
3550 *
3551 * \since Version 1.12.
3552 */
3553 ORT_CLASS_RELEASE(OpAttr);
3554
3572 ORT_API2_STATUS(CreateOp,
3573 _In_ const OrtKernelInfo* info,
3574 _In_z_ const char* op_name,
3575 _In_z_ const char* domain,
3576 int version,
3577 _In_reads_(type_constraint_count) const char** type_constraint_names,
3578 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
3579 int type_constraint_count,
3580 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
3581 int attr_count,
3582 int input_count,
3583 int output_count,
3584 _Outptr_ OrtOp** ort_op);
3585
3598 ORT_API2_STATUS(InvokeOp,
3599 _In_ const OrtKernelContext* context,
3600 _In_ const OrtOp* ort_op,
3601 _In_ const OrtValue* const* input_values,
3602 _In_ int input_count,
3603 _Inout_ OrtValue* const* output_values,
3604 _In_ int output_count);
3605
3606 /* \brief: Release an onnxruntime operator
3607 *
3608 * \param[in] Op Operator created by OrtApi::CreateOp
3609 *
3610 * \since Version 1.12.
3611 */
3612 ORT_CLASS_RELEASE(Op);
3613
3683 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
3684 _In_ const char* provider_name,
3685 _In_reads_(num_keys) const char* const* provider_options_keys,
3686 _In_reads_(num_keys) const char* const* provider_options_values,
3687 _In_ size_t num_keys);
3688
3689 /* \brief: Get a copy of kernel info
3690 *
3691 * \param[in] info Kernel info
3692 * \param[out] info_copy Copy of kernel info
3693 *
3694 * \since Version 1.12.
3695 */
3696 ORT_API2_STATUS(CopyKernelInfo,
3697 _In_ const OrtKernelInfo* info,
3698 _Outptr_ OrtKernelInfo** info_copy);
3699
3700 /* \brief: Release kernel info
3701 *
3702 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
3703 *
3704 * \since Version 1.12.
3705 */
3706 ORT_CLASS_RELEASE(KernelInfo);
3707
3710
3724 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
3725
3727
3740 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
3741
3750 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
3751
3763 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
3764 _In_reads_(num_keys) const char* const* provider_options_keys,
3765 _In_reads_(num_keys) const char* const* provider_options_values,
3766 _In_ size_t num_keys);
3767
3781 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
3782 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3783
3790 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
3791
3792 /* \brief Get OrtDevice type from MemoryInfo
3793 *
3794 * \since Version 1.14
3795 */
3796 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
3797
3798 /* \brief Update the OrtEnv instance with custom log severity level
3799 *
3800 * \param[in] ort_env The OrtEnv instance being used
3801 * \param[in] log_severity_level The log severity level.
3802 *
3803 * \since Version 1.14.
3804 */
3805 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
3806
3807 /* \brief Set affinities for intra op threads
3808 *
3809 * Affinity string follows format:
3810 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
3811 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
3812 * e.g. 1,2,3;4,5
3813 * 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.
3814 * To ease the configuration, an "interval" is also allowed:
3815 * e.g. 1-8;8-16;17-24
3816 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
3817 * Note:
3818 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
3819 * ort does not set affinity on the main thread which is started and managed by the calling app;
3820 * 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,
3821 * 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.
3822 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
3823 *
3824 * \since Version 1.14
3825 */
3826 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
3827
3846 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
3847
3872 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
3873 _In_ const char* registration_func_name);
3874
3878
3890 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3891
3903 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3904
3929 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3930 _Inout_ size_t* size);
3931
3957 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3958 _Inout_ size_t* size);
3959
3972 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
3973 _Outptr_ OrtTypeInfo** type_info);
3974
3987 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
3988 _Outptr_ OrtTypeInfo** type_info);
3989
4002 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
4003 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
4004
4009
4025 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
4026 _In_z_ const char* config_key, _Out_ int* out);
4027
4056 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
4057 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
4058
4060
4073 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
4074
4083 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4084
4101 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4102 _In_reads_(num_keys) const char* const* provider_options_keys,
4103 _In_reads_(num_keys) const char* const* provider_options_values,
4104 _In_ size_t num_keys);
4105
4120 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4121
4126 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4127
4131
4154 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_ char* out, _Inout_ size_t* size);
4155
4167 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4168
4173
4185 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4186
4191
4210 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4211 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4212 _In_z_ const char* func_name);
4213
4225 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4226
4228
4242 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4243
4264 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4265 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4266
4283 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4284 _Outptr_ OrtTypeInfo** out);
4285
4296 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4297
4308 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4309
4316 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4317
4320
4329 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4330
4348 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4349 _In_reads_(num_keys) const char* const* provider_options_keys,
4350 _In_reads_(num_keys) const char* const* provider_options_values,
4351 _In_ size_t num_keys);
4352
4367 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4368
4375 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
4376
4390 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type, _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
4391 _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);
4392
4411 ORT_API2_STATUS(RunAsync, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
4412 _In_reads_(input_len) const char* const* input_names,
4413 _In_reads_(input_len) const OrtValue* const* input, size_t input_len,
4414 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
4415 _Inout_updates_all_(output_names_len) OrtValue** output,
4416 _In_ RunAsyncCallbackFn run_async_callback, _In_opt_ void* user_data);
4417
4430 ORT_API2_STATUS(UpdateTensorRTProviderOptionsWithValue, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _In_ void* value);
4431
4442 ORT_API2_STATUS(GetTensorRTProviderOptionsByName, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _In_ const char* key, _Outptr_ void** ptr);
4443
4456 ORT_API2_STATUS(UpdateCUDAProviderOptionsWithValue, _Inout_ OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _In_ void* value);
4457
4468 ORT_API2_STATUS(GetCUDAProviderOptionsByName, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _In_ const char* key, _Outptr_ void** ptr);
4469
4481 ORT_API2_STATUS(KernelContext_GetResource, _In_ const OrtKernelContext* context, _In_ int resource_version,
4482 _In_ int resource_id, _Outptr_ void** resource);
4483
4501 ORT_API2_STATUS(SetUserLoggingFunction, _Inout_ OrtSessionOptions* options,
4502 _In_ OrtLoggingFunction user_logging_function, _In_opt_ void* user_logging_param);
4503
4512 ORT_API2_STATUS(ShapeInferContext_GetInputCount, _In_ const OrtShapeInferContext* context, _Out_ size_t* out);
4513
4523 ORT_API2_STATUS(ShapeInferContext_GetInputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _Outptr_ OrtTensorTypeAndShapeInfo** info);
4524
4534 ORT_API2_STATUS(ShapeInferContext_GetAttribute, _In_ const OrtShapeInferContext* context, _In_ const char* attr_name, _Outptr_ const OrtOpAttr** attr);
4535
4545 ORT_API2_STATUS(ShapeInferContext_SetOutputTypeShape, _In_ const OrtShapeInferContext* context, _In_ size_t index, _In_ const OrtTensorTypeAndShapeInfo* info);
4546
4556 ORT_API2_STATUS(SetSymbolicDimensions, _In_ OrtTensorTypeAndShapeInfo* info, _In_ const char* dim_params[], _In_ size_t dim_params_length);
4557
4569 ORT_API2_STATUS(ReadOpAttr, _In_ const OrtOpAttr* op_attr, _In_ OrtOpAttrType type, _Inout_ void* data, _In_ size_t len, _Out_ size_t* out);
4570
4581 ORT_API2_STATUS(SetDeterministicCompute, _Inout_ OrtSessionOptions* options, bool value);
4582
4594 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);
4595
4608 _In_ OrtSessionOptions* options,
4609 _In_reads_(num_keys) const char* const* provider_options_keys,
4610 _In_reads_(num_keys) const char* const* provider_options_values,
4611 _In_ size_t num_keys);
4612
4625 _In_ OrtSessionOptions* options,
4626 _In_reads_(num_keys) const char* const* provider_options_keys,
4627 _In_reads_(num_keys) const char* const* provider_options_values,
4628 _In_ size_t num_keys);
4629
4638 ORT_API2_STATUS(KernelContext_GetScratchBuffer, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _In_ size_t count_or_bytes, _Outptr_ void** out);
4639
4648 ORT_API2_STATUS(KernelInfoGetAllocator, _In_ const OrtKernelInfo* info, _In_ OrtMemType mem_type, _Outptr_ OrtAllocator** out);
4649
4669 ORT_API2_STATUS(AddExternalInitializersFromFilesInMemory, _In_ OrtSessionOptions* options,
4670 _In_reads_(num_external_initializer_files) const ORTCHAR_T* const* external_initializer_file_names,
4671 _In_reads_(num_external_initializer_files) char* const* external_initializer_file_buffer_array,
4672 _In_reads_(num_external_initializer_files) const size_t* external_initializer_file_lengths,
4673 size_t num_external_initializer_files);
4674
4689 ORT_API2_STATUS(CreateLoraAdapter, const ORTCHAR_T* adapter_file_path, _In_ OrtAllocator* allocator,
4690 _Outptr_ OrtLoraAdapter** out);
4691
4705 ORT_API2_STATUS(CreateLoraAdapterFromArray, _In_ const void* bytes, size_t num_bytes, _In_ OrtAllocator* allocator,
4706 _Outptr_ OrtLoraAdapter** out);
4707
4710 ORT_CLASS_RELEASE(LoraAdapter);
4711
4724 ORT_API2_STATUS(RunOptionsAddActiveLoraAdapter, _Inout_ OrtRunOptions* options, _In_ const OrtLoraAdapter* adapter);
4725};
4726
4727/*
4728 * Steps to use a custom op:
4729 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
4730 * 2 Create an OrtCustomOp structure for each op and add them to the domain
4731 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
4732 */
4733
4734// Specifies some characteristics of inputs/outputs of custom ops:
4735// Specify if the inputs/outputs are one of:
4736// 1) Non-optional (input/output must be present in the node)
4737// 2) Optional (input/output may be absent in the node)
4738// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
4739// Only the last input or output of a custom op may be marked as variadic.
4740// The homogeneity of the variadic input or output determines whether all operands must be of the same
4741// tensor element type.
4747
4748/*
4749 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
4750 * the implementor of the custom op.
4751 */
4753 uint32_t version; // Must be initialized to ORT_API_VERSION
4754
4755 // This callback creates the kernel, which is a user defined
4756 // parameter that is passed to the Kernel* callbacks below. It is
4757 // recommended to use CreateKernelV2 which allows for a safe error
4758 // propagation by returning an OrtStatusPtr.
4759 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
4760 _In_ const OrtKernelInfo* info);
4761
4762 // Returns the name of the op
4763 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
4764
4765 // Returns the type of the execution provider, return nullptr to use CPU execution provider
4766 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
4767
4768 // Returns the count and types of the input & output tensors
4769 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4770 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
4771 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4772 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
4773
4774 // Perform a computation step. It is recommended to use
4775 // KernelComputeV2 which allows for a safe error propagation by
4776 // returning an OrtStatusPtr.
4777 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
4778 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
4779
4780 // Returns the characteristics of the input & output tensors
4781 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4782 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4783
4784 // Returns the memory type of the input tensors. This API allows the custom op
4785 // to place the inputs on specific devices. By default, it returns
4786 // OrtMemTypeDefault, which means the input is placed on the default device for
4787 // the execution provider. If the inputs need to be with different memory tyeps,
4788 // this function can be overridden to return the specific memory types.
4789 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4790
4791 // Returns the minimum number of input arguments expected for the variadic input.
4792 // Applicable only for custom ops that have a variadic input.
4793 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
4794
4795 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
4796 // and false (zero) otherwise.
4797 // Applicable only for custom ops that have a variadic input.
4798 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
4799
4800 // Returns the minimum number of output values expected for the variadic output.
4801 // Applicable only for custom ops that have a variadic output.
4802 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
4803
4804 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
4805 // and false (zero) otherwise.
4806 // Applicable only for custom ops that have a variadic output.
4807 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
4808
4809 // Create the kernel state which is passed to each compute call.
4810 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
4811 _In_ const OrtKernelInfo* info,
4812 _Out_ void** kernel);
4813
4814 // Perform the computation step.
4815 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
4816
4817 OrtStatusPtr(ORT_API_CALL* InferOutputShapeFn)(_In_ const struct OrtCustomOp* op, _In_ OrtShapeInferContext*);
4818
4819 // Get start range
4820 int(ORT_API_CALL* GetStartVersion)(_In_ const struct OrtCustomOp* op);
4821 int(ORT_API_CALL* GetEndVersion)(_In_ const struct OrtCustomOp* op);
4822
4823 // Get the inplace_map that defines which output can reuse which input
4824 // Callers will provide 2 raw int* and pass in their address, this function will fill these 2 arrays
4825 // when return, output (*output_index)[i] may reuse the input (*input_index[i]).
4826 // The return value is the size of these 2 arrays.
4827 // Callers are responsible to delete these 2 arrays after use by calling OrtCustomOp::ReleaseMayInplace().
4828 size_t(ORT_API_CALL* GetMayInplace)(_Out_ int** input_index, _Out_ int** output_index);
4829
4830 // Release the pointer input_index and output_index allocated from GetMayInplace() function.
4831 // If GetMayInplace() is defined, this function MUST be defined as well.
4832 void(ORT_API_CALL* ReleaseMayInplace)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
4833
4834 // Same as GetMayInplace() and ReleaseMayInplace()
4835 size_t(ORT_API_CALL* GetAliasMap)(_Out_ int** input_index, _Out_ int** output_index);
4836 void(ORT_API_CALL* ReleaseAliasMap)(_Frees_ptr_opt_ int* input_index, _Frees_ptr_opt_ int* output_index);
4837};
4838
4839/*
4840 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
4841 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
4842 *
4843 * \param device_id CUDA device id, starts from zero.
4844 */
4845ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
4846
4847/*
4848 * This is the old way to add the ROCm provider to the session, please use
4849 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
4850 * This function always exists, but will only succeed if Onnxruntime was built with
4851 * HIP support and the ROCm provider shared library exists
4852 *
4853 * \param device_id HIP device id, starts from zero.
4854 */
4855ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
4856
4857/*
4858 * This is the old way to add the MIGraphX provider to the session, please use
4859 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
4860 * This function always exists, but will only succeed if Onnxruntime was built with
4861 * HIP support and the MIGraphX provider shared library exists
4862 *
4863 * \param device_id HIP device id, starts from zero.
4864 */
4865ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
4866
4867/*
4868 * This is the old way to add the oneDNN provider to the session, please use
4869 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
4870 * This function always exists, but will only succeed if Onnxruntime was built with
4871 * oneDNN support and the oneDNN provider shared library exists
4872 *
4873 * \param use_arena zero: false. non-zero: true.
4874 */
4875ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
4876
4877/*
4878 * This is the old way to add the TensorRT provider to the session, please use SessionOptionsAppendExecutionProvider_TensorRT_V2 above to access the latest functionality
4879 * This function always exists, but will only succeed if Onnxruntime was built with TensorRT support and the TensorRT provider shared library exists
4880 *
4881 * \param device_id CUDA device id, starts from zero.
4882 */
4883ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Tensorrt, _In_ OrtSessionOptions* options, int device_id);
4884
4885#ifdef __cplusplus
4886}
4887#endif
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:282
struct OrtLoraAdapter OrtLoraAdapter
Definition onnxruntime_c_api.h:307
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:369
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:393
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:306
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:334
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:717
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition onnxruntime_c_api.h:719
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:4742
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:299
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:304
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:296
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:290
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition onnxruntime_c_api.h:358
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:302
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:226
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:298
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:284
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:293
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:283
OrtAllocatorType
Definition onnxruntime_c_api.h:375
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:303
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:294
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:287
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:288
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:300
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:371
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition onnxruntime_c_api.h:401
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:301
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:728
struct OrtRunOptions OrtRunOptions
Definition onnxruntime_c_api.h:286
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition onnxruntime_c_api.h:699
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition onnxruntime_c_api.h:291
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:292
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:285
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:343
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:312
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:384
OrtSparseFormat
Definition onnxruntime_c_api.h:218
ONNXType
Definition onnxruntime_c_api.h:206
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:280
OrtErrorCode
Definition onnxruntime_c_api.h:245
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:281
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:305
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:289
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:297
ExecutionMode
Definition onnxruntime_c_api.h:350
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition onnxruntime_c_api.h:260
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:710
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:395
@ OrtMemoryInfoDeviceType_FPGA
Definition onnxruntime_c_api.h:396
@ OrtMemoryInfoDeviceType_CPU
Definition onnxruntime_c_api.h:394
@ INPUT_OUTPUT_VARIADIC
Definition onnxruntime_c_api.h:4745
@ INPUT_OUTPUT_REQUIRED
Definition onnxruntime_c_api.h:4743
@ INPUT_OUTPUT_OPTIONAL
Definition onnxruntime_c_api.h:4744
@ ORT_PROJECTION_C
Definition onnxruntime_c_api.h:359
@ ORT_PROJECTION_PYTHON
Definition onnxruntime_c_api.h:362
@ ORT_PROJECTION_CPLUSPLUS
Definition onnxruntime_c_api.h:360
@ ORT_PROJECTION_WINML
Definition onnxruntime_c_api.h:364
@ ORT_PROJECTION_CSHARP
Definition onnxruntime_c_api.h:361
@ ORT_PROJECTION_JAVA
Definition onnxruntime_c_api.h:363
@ ORT_PROJECTION_NODEJS
Definition onnxruntime_c_api.h:365
@ 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:377
@ OrtArenaAllocator
Definition onnxruntime_c_api.h:378
@ OrtInvalidAllocator
Definition onnxruntime_c_api.h:376
@ OrtCudnnConvAlgoSearchDefault
Definition onnxruntime_c_api.h:404
@ OrtCudnnConvAlgoSearchExhaustive
Definition onnxruntime_c_api.h:402
@ OrtCudnnConvAlgoSearchHeuristic
Definition onnxruntime_c_api.h:403
@ ORT_ENABLE_BASIC
Definition onnxruntime_c_api.h:345
@ ORT_ENABLE_ALL
Definition onnxruntime_c_api.h:347
@ ORT_DISABLE_ALL
Definition onnxruntime_c_api.h:344
@ ORT_ENABLE_EXTENDED
Definition onnxruntime_c_api.h:346
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition onnxruntime_c_api.h:385
@ OrtMemTypeCPU
Temporary CPU accessible memory allocated by non-CPU execution provider, i.e. CUDA_PINNED.
Definition onnxruntime_c_api.h:387
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:388
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. CUDA_PINNED.
Definition onnxruntime_c_api.h:386
@ 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_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:352
@ ORT_SEQUENTIAL
Definition onnxruntime_c_api.h:351
@ ORT_OP_ATTR_INT
Definition onnxruntime_c_api.h:262
@ ORT_OP_ATTR_FLOATS
Definition onnxruntime_c_api.h:265
@ ORT_OP_ATTR_STRINGS
Definition onnxruntime_c_api.h:267
@ ORT_OP_ATTR_UNDEFINED
Definition onnxruntime_c_api.h:261
@ ORT_OP_ATTR_INTS
Definition onnxruntime_c_api.h:263
@ ORT_OP_ATTR_STRING
Definition onnxruntime_c_api.h:266
@ ORT_OP_ATTR_FLOAT
Definition onnxruntime_c_api.h:264
@ 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:321
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:324
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition onnxruntime_c_api.h:325
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition onnxruntime_c_api.h:322
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition onnxruntime_c_api.h:323
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:331
The helper interface to get the right version of OrtApi.
Definition onnxruntime_c_api.h:667
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition onnxruntime_c_api.h:683
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:677
The C API.
Definition onnxruntime_c_api.h:737
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:4126
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:4316
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.
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:3724
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:2425
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:3796
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 * 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...
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:4375
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:3790
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 * 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 * 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:762
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:2429
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 *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition onnxruntime_c_api.h:748
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 * 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:2984
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:3487
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:755
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:411
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:490
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:464
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:459
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:469
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:479
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:442
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:450
OrtCUDAProviderOptions()
Definition onnxruntime_c_api.h:413
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition onnxruntime_c_api.h:473
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:485
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition onnxruntime_c_api.h:436
int device_id
CUDA device Id Defaults to 0.
Definition onnxruntime_c_api.h:430
Definition onnxruntime_c_api.h:701
char __place_holder
Definition onnxruntime_c_api.h:702
Definition onnxruntime_c_api.h:4752
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4798
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4782
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4770
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4802
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:4835
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4820
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:4832
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4763
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4772
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:4778
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4807
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4789
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:4759
uint32_t version
Definition onnxruntime_c_api.h:4753
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4769
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:4836
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4781
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4766
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4771
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4793
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:4817
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4821
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:4810
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:4828
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4815
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4777
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:615
bool migraphx_exhaustive_tune
Definition onnxruntime_c_api.h:625
int migraphx_save_compiled_model
Definition onnxruntime_c_api.h:621
int migraphx_int8_enable
Definition onnxruntime_c_api.h:618
int migraphx_load_compiled_model
Definition onnxruntime_c_api.h:623
int migraphx_fp16_enable
Definition onnxruntime_c_api.h:617
int device_id
Definition onnxruntime_c_api.h:616
int migraphx_use_native_calibration_table
Definition onnxruntime_c_api.h:619
const char * migraphx_load_model_path
Definition onnxruntime_c_api.h:624
const char * migraphx_save_model_path
Definition onnxruntime_c_api.h:622
const char * migraphx_int8_calibration_table_name
Definition onnxruntime_c_api.h:620
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:632
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:653
size_t num_of_threads
0 = Use default number of threads
Definition onnxruntime_c_api.h:650
void * context
Definition onnxruntime_c_api.h:652
const char * cache_dir
Definition onnxruntime_c_api.h:651
const char * device_type
Device type string.
Definition onnxruntime_c_api.h:647
const char * device_id
Definition onnxruntime_c_api.h:649
unsigned char enable_npu_fast_compile
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:648
OrtOpenVINOProviderOptions()
Definition onnxruntime_c_api.h:634
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition onnxruntime_c_api.h:654
ROCM Provider Options.
Definition onnxruntime_c_api.h:498
int device_id
ROCM device Id Defaults to 0.
Definition onnxruntime_c_api.h:518
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:579
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:546
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition onnxruntime_c_api.h:560
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:529
OrtROCMProviderOptions()
Definition onnxruntime_c_api.h:500
int enable_hip_graph
Definition onnxruntime_c_api.h:562
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:568
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition onnxruntime_c_api.h:556
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition onnxruntime_c_api.h:537
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:574
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition onnxruntime_c_api.h:551
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exaustive search option. Defaults to 0 (false).
Definition onnxruntime_c_api.h:523
TensorRT Provider Options.
Definition onnxruntime_c_api.h:587
int trt_engine_cache_enable
Definition onnxruntime_c_api.h:601
void * user_compute_stream
Definition onnxruntime_c_api.h:590
int device_id
CUDA device id (0 = default device)
Definition onnxruntime_c_api.h:588
const char * trt_engine_cache_path
Definition onnxruntime_c_api.h:602
int trt_engine_decryption_enable
Definition onnxruntime_c_api.h:603
int trt_max_partition_iterations
Definition onnxruntime_c_api.h:591
size_t trt_max_workspace_size
Definition onnxruntime_c_api.h:593
int trt_dla_enable
Definition onnxruntime_c_api.h:598
const char * trt_int8_calibration_table_name
Definition onnxruntime_c_api.h:596
int has_user_compute_stream
Definition onnxruntime_c_api.h:589
int trt_dla_core
Definition onnxruntime_c_api.h:599
int trt_int8_use_native_calibration_table
Definition onnxruntime_c_api.h:597
int trt_min_subgraph_size
Definition onnxruntime_c_api.h:592
int trt_force_sequential_engine_build
Definition onnxruntime_c_api.h:605
int trt_dump_subgraphs
Definition onnxruntime_c_api.h:600
int trt_fp16_enable
Definition onnxruntime_c_api.h:594
const char * trt_engine_decryption_lib_path
Definition onnxruntime_c_api.h:604
int trt_int8_enable
Definition onnxruntime_c_api.h:595
The Training C API that holds onnxruntime training function pointers.
Definition onnxruntime_training_c_api.h:122