OnnxRuntime
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
24#pragma once
25#include <stdlib.h>
26#include <stdint.h>
27#include <string.h>
28
33#define ORT_API_VERSION 15
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
40// SAL2 Definitions
41#ifndef _WIN32
42#define _In_
43#define _In_z_
44#define _In_opt_
45#define _In_opt_z_
46#define _Out_
47#define _Outptr_
48#define _Out_opt_
49#define _Inout_
50#define _Inout_opt_
51#define _Frees_ptr_opt_
52#define _Ret_maybenull_
53#define _Ret_notnull_
54#define _Check_return_
55#define _Outptr_result_maybenull_
56#define _In_reads_(X)
57#define _Inout_updates_all_(X)
58#define _Out_writes_bytes_all_(X)
59#define _Out_writes_all_(X)
60#define _Success_(X)
61#define _Outptr_result_buffer_maybenull_(X)
62#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
63#else
64#include <specstrings.h>
65#define ORT_ALL_ARGS_NONNULL
66#endif
67
68#ifdef _WIN32
69// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
70// dllexport is not used, we use a .def file.
71#ifdef ORT_DLL_IMPORT
72#define ORT_EXPORT __declspec(dllimport)
73#else
74#define ORT_EXPORT
75#endif
76#define ORT_API_CALL _stdcall
77#define ORT_MUST_USE_RESULT
78#define ORTCHAR_T wchar_t
79#else
80// To make symbols visible on macOS/iOS
81#ifdef __APPLE__
82#define ORT_EXPORT __attribute__((visibility("default")))
83#else
84#define ORT_EXPORT
85#endif
86#define ORT_API_CALL
87#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
88#define ORTCHAR_T char
89#endif
90
91#ifndef ORT_TSTR
92#ifdef _WIN32
93#define ORT_TSTR(X) L##X
94#else
95#define ORT_TSTR(X) X
96#endif
97#endif
98
99// Any pointer marked with _In_ or _Out_, cannot be NULL.
100
101// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
102// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
103// for ReleaseXXX(...) functions, they can accept NULL pointer.
104
105#ifdef __cplusplus
106// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
107// Such complex condition is needed because compilers set __cplusplus value differently.
108#ifndef __has_feature
109#define __has_feature(x) 0
110#endif
111#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
112#define NO_EXCEPTION noexcept
113#else
114#define NO_EXCEPTION throw()
115#endif
116#else
117#define NO_EXCEPTION
118#endif
119
120// __VA_ARGS__ on Windows and Linux are different
121#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
122
123#define ORT_API_STATUS(NAME, ...) \
124 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
125 NO_EXCEPTION ORT_MUST_USE_RESULT
126
127// XXX: Unfortunately, SAL annotations are known to not work with function pointers
128#define ORT_API2_STATUS(NAME, ...) \
129 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
130
131// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
132#define ORT_API_STATUS_IMPL(NAME, ...) \
133 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
134
135#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
136
137#ifdef __DOXYGEN__
138#undef ORT_API_STATUS
139#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
140#undef ORT_API2_STATUS
141#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
142#undef ORT_CLASS_RELEASE
143#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
144#undef NO_EXCEPTION
145#define NO_EXCEPTION
146#endif
157 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
158 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
159 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
160 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
161 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
162 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
163 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
164 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
167 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
168 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
169 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
170 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
171 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
172 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16 // Non-IEEE floating-point format based on IEEE754 single-precision
174
175// Synced with onnx TypeProto oneof
176typedef enum ONNXType {
185
186// These types are synced with internal
187// SparseFormatFlags
188typedef enum OrtSparseFormat {
194
195// Enum allows to query sparse tensor indices
202
207typedef enum OrtLoggingLevel {
214
215typedef enum OrtErrorCode {
229
230typedef enum OrtOpAttrType {
239
241#define ORT_RUNTIME_CLASS(X) \
242 struct Ort##X; \
243 typedef struct Ort##X Ort##X;
244
249// The actual types defined have an Ort prefix
250ORT_RUNTIME_CLASS(Env);
251ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
252ORT_RUNTIME_CLASS(MemoryInfo);
253ORT_RUNTIME_CLASS(IoBinding);
254ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
255ORT_RUNTIME_CLASS(Value);
256ORT_RUNTIME_CLASS(RunOptions);
257ORT_RUNTIME_CLASS(TypeInfo);
258ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
259ORT_RUNTIME_CLASS(SessionOptions);
260ORT_RUNTIME_CLASS(CustomOpDomain);
261ORT_RUNTIME_CLASS(MapTypeInfo);
262ORT_RUNTIME_CLASS(SequenceTypeInfo);
263ORT_RUNTIME_CLASS(ModelMetadata);
264ORT_RUNTIME_CLASS(ThreadPoolParams);
265ORT_RUNTIME_CLASS(ThreadingOptions);
266ORT_RUNTIME_CLASS(ArenaCfg);
267ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
268ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
269ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
270ORT_RUNTIME_CLASS(CANNProviderOptions);
271ORT_RUNTIME_CLASS(DnnlProviderOptions);
272ORT_RUNTIME_CLASS(Op);
273ORT_RUNTIME_CLASS(OpAttr);
274
275#ifdef _WIN32
276typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
277#else
279#endif
280
287typedef struct OrtAllocator {
288 uint32_t version;
289 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
290 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
291 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
293
294typedef void(ORT_API_CALL* OrtLoggingFunction)(
295 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
296 const char* message);
297
307 ORT_ENABLE_ALL = 99
309
310typedef enum ExecutionMode {
314
327
328struct OrtKernelInfo;
330struct OrtKernelContext;
332struct OrtCustomOp;
333typedef struct OrtCustomOp OrtCustomOp;
334
335typedef enum OrtAllocatorType {
340
343// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
344typedef enum OrtMemType {
349} OrtMemType;
350
358
362 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
363 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
364 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
366
372#ifdef __cplusplus
374 : device_id{},
376 gpu_mem_limit{SIZE_MAX},
382 tunable_op_enabled{false} {}
383#endif
384
389
395
401
409
418
423
428
432
438
440
446#ifdef __cplusplus
448 : device_id{},
450 gpu_mem_limit{SIZE_MAX},
456 tunable_op_enabled{false} {}
457#endif
458
463
468
474
482
491
496
501
505
511
513
520 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
521 void* user_compute_stream; // user specified CUDA compute stream.
522 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
523 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
524 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
525 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
526 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
527 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
528 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
529 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
530 int trt_dla_core; // DLA core number. Default 0
531 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
532 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
533 const char* trt_engine_cache_path; // specify engine cache path
534 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
535 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
536 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
537 // This is the legacy struct and don't add new fields here.
538 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
539 // For non-string field, need to create a new separate api to handle it.
541
547 int device_id; // hip device id.
548 int migraphx_fp16_enable; // enable MIGraphX FP16 precision. Default 0 = false, nonzero = true
549 int migraphx_int8_enable; // enable MIGraphX INT8 precision. Default 0 = false, nonzero = true
551
557#ifdef __cplusplus
561#endif
566 const char* device_type;
568 const char* device_id;
570 const char* cache_dir; // path is set to empty by default
571 void* context;
573 unsigned char enable_dynamic_shapes;
575
576struct OrtApi;
577typedef struct OrtApi OrtApi;
578
579struct OrtTrainingApi;
581
593 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
594 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
595};
596typedef struct OrtApiBase OrtApiBase;
597
602ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
603
609typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
610
611typedef const struct OrtCustomHandleType {
614
620typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
621
627typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
628
629typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
630
638struct OrtApi {
641
649 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
650
656 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
657
663 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
664
668
677 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
678
690 ORT_API2_STATUS(CreateEnvWithCustomLogger, OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
691 OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
692
700 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
708 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
709
713
723 // TODO: document the path separator convention? '/' vs '\'
724 // TODO: should specify the access characteristics of model_path. Is this read only during the
725 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
726 // and continue to access throughout the OrtSession lifetime?
727 // What sort of access is needed to model_path : read or read/write?
728 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
729 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
730
741 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env, _In_ const void* model_data, size_t model_data_length,
742 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
743
762 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
763 _In_reads_(input_len) const char* const* input_names,
764 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
765 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
766 _Inout_updates_all_(output_names_len) OrtValue** outputs);
767
771
787 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
788
796 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
797 _In_ const ORTCHAR_T* optimized_model_filepath);
798
806 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
807 _Outptr_ OrtSessionOptions** out_options);
808
820 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
821
829 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
830
837 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
838
852 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
853
862 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
863
872 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
873
880 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
881
889 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
890
900 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
901
909 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
910
919 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
920 GraphOptimizationLevel graph_optimization_level);
921
935 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
936
949 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
950
954
962 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
963
973 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
974
978
988 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
989
1006 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1007
1011
1023 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1024
1036 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1037
1047 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1048
1057 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1058
1067 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1068
1077 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1078
1088 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1089
1099 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1100
1110 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1111 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1112
1116
1123 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1124
1134 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1135
1143 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1144
1154 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1155
1165 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1166 _Out_ int* log_verbosity_level);
1167
1175 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1176
1188 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1189
1198 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1199
1208 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1209
1213
1226 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1228
1244 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1245 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1246 _Outptr_ OrtValue** out);
1247
1255 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1256
1267 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1268
1277 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1278
1288 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1289
1309 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1310 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1311
1315
1323 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1324 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1325
1333 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1334
1338
1346
1355
1364 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1365
1375 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1377
1387 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1388
1397 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1398 size_t dim_values_length);
1399
1408 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1409 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1410
1427 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1428
1432
1440 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
1441
1449 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
1450
1458 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
1459
1463
1474 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
1475 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
1476
1487 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
1488 _Outptr_ OrtMemoryInfo** out);
1489
1500 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
1501
1509 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
1510
1513 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
1514
1517 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
1518
1521 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
1522
1526
1528 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
1530 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
1532 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
1533
1542 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
1543
1547
1559 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
1560 _In_ int64_t dim_value);
1561
1565
1566 /* Internal information (not seen in Doxygen)
1567 *
1568 * APIs to support non-tensor types - map and sequence.
1569 * Currently only the following types are supported
1570 * Note: the following types should be kept in sync with data_types.h
1571 * Map types
1572 * =========
1573 * std::map<std::string, std::string>
1574 * std::map<std::string, int64_t>
1575 * std::map<std::string, float>
1576 * std::map<std::string, double>
1577 * std::map<int64_t, std::string>
1578 * std::map<int64_t, int64_t>
1579 * std::map<int64_t, float>
1580 * std::map<int64_t, double>
1581 *
1582 * Sequence types
1583 * ==============
1584 * std::vector<std::string>
1585 * std::vector<int64_t>
1586 * std::vector<float>
1587 * std::vector<double>
1588 * std::vector<std::map<std::string, float>>
1589 * std::vector<std::map<int64_t, float>
1590 */
1591
1606 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
1607 _Outptr_ OrtValue** out);
1608
1619 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
1620
1636 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
1637 enum ONNXType value_type, _Outptr_ OrtValue** out);
1638
1661 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
1662 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
1663
1678 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
1679 _Out_ void* data_container, size_t data_container_size);
1680
1685
1694 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
1695 _Out_ float* out);
1696
1705 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
1706 _Out_ int64_t* out);
1707
1728 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
1729 _Inout_ size_t* size);
1730
1735
1740 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1741
1746 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1747
1752 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
1753 _Out_ const OrtValue** out);
1754
1759 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
1760 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
1761
1765 ORT_CLASS_RELEASE(Env);
1769 ORT_CLASS_RELEASE(Status);
1773 ORT_CLASS_RELEASE(MemoryInfo);
1777 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
1781 ORT_CLASS_RELEASE(Value);
1785 ORT_CLASS_RELEASE(RunOptions);
1789 ORT_CLASS_RELEASE(TypeInfo);
1793 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
1797 ORT_CLASS_RELEASE(SessionOptions);
1801 ORT_CLASS_RELEASE(CustomOpDomain);
1802
1806
1819 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
1820 _Out_ size_t* len);
1821
1834 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
1835 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
1836
1849 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
1850 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
1851
1855
1867 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
1868
1876 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
1877
1881
1891 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
1892 _Outptr_ OrtTypeInfo** type_info);
1893
1897 ORT_CLASS_RELEASE(MapTypeInfo);
1901 ORT_CLASS_RELEASE(SequenceTypeInfo);
1902
1906
1917 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
1918
1926 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
1927
1931
1940 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
1941 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1942
1951 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
1952 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1953
1962 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
1963 _Outptr_ char** value);
1964
1973 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
1974 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1975
1986 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
1987 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
1988
1996 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
1997
1998 ORT_CLASS_RELEASE(ModelMetadata);
1999
2003
2017 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2018 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2019
2023
2033 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2034
2038
2044 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2045
2046 ORT_CLASS_RELEASE(ThreadingOptions);
2047
2051
2063 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2064 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2065
2069
2077 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2078 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2079 _In_ int64_t dim_value);
2080
2084
2096 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2097
2106 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2107 _In_ int providers_length);
2108
2112
2121 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2122
2132 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2133
2142 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2143
2147
2160 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2161 _In_z_ const char* config_key, _In_z_ const char* config_value);
2162
2166
2175 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2176 _Outptr_ OrtAllocator** out);
2177
2180 ORT_CLASS_RELEASE(Allocator);
2181
2185
2196 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2197
2209 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2210
2214
2217 ORT_CLASS_RELEASE(IoBinding);
2218
2229 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2230
2241 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2242
2258 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2259
2277 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2278 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2279
2297 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2298 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2299
2302 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2303
2306 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2307
2311
2326 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2327
2331
2346 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2347 _In_ const OrtArenaCfg* arena_cfg);
2348
2360 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2361
2365
2375 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2376
2380
2392 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2393
2405 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
2406
2420 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
2421
2425
2440 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
2441 _In_ const OrtValue* val);
2442
2446
2462 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
2463 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2464
2468
2479 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
2480
2491 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
2492
2503 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
2504
2508
2519 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
2520
2524
2537 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
2538 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
2539
2540 ORT_CLASS_RELEASE(ArenaCfg);
2541
2545
2557 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
2558 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2559
2563
2574 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
2575
2579
2590 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
2591
2602 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
2603
2608
2631 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2632 _Out_ float* out, _Inout_ size_t* size);
2633
2655 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2656 _Out_ int64_t* out, _Inout_ size_t* size);
2657
2661
2689 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
2690 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
2691 _Outptr_ OrtArenaCfg** out);
2692
2696
2709 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
2710 _In_z_ const char* config_key, _In_z_ const char* config_value);
2711
2715
2729
2734 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
2735
2739
2757 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
2758 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2759 _Outptr_ OrtSession** out);
2760
2779 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
2780 _In_ const void* model_data, size_t model_data_length,
2781 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2782 _Outptr_ OrtSession** out);
2783
2787
2806 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
2807
2811
2819
2835 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
2836 _In_reads_(num_keys) const char* const* provider_options_keys,
2837 _In_reads_(num_keys) const char* const* provider_options_values,
2838 _In_ size_t num_keys);
2839
2851 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
2852
2857 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
2858
2862
2869 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
2870
2874
2890 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
2891
2902 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
2903 _In_ const OrtMemoryInfo* mem_info);
2904
2908
2917 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
2918
2935 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
2936 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
2937
2955 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
2956 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
2957 _In_ const int64_t* indices_data, size_t indices_num);
2958
2978 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
2979 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
2980 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
2981 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
2982
3001 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3002 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3003 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3004 _In_ const int32_t* indices_data);
3005
3030 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3031 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3032 _In_ const int64_t* values_shape, size_t values_shape_len,
3034
3049 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3050
3067 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3068 _Inout_ int64_t* outer_data, size_t outer_num);
3069
3083 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3084
3092 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3093
3101 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3102
3110 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3111
3121 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3122
3132 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3136
3149 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3150
3155
3167 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3168
3172
3178 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3179
3183
3193 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3194
3196
3199
3206 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3207
3215 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3216
3224 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3226
3229
3236 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3237
3245 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3246
3254 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3256
3265 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3266
3275 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3276
3279
3300 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3301
3305
3314 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3315
3333 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3334 _In_reads_(num_keys) const char* const* provider_options_keys,
3335 _In_reads_(num_keys) const char* const* provider_options_values,
3336 _In_ size_t num_keys);
3337
3352 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3353
3360 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3361
3363
3376 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3377
3399 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
3400 _In_reads_(input_len) const char* const* initializer_names,
3401 _In_reads_(input_len) const OrtValue* const* initializers, size_t initializers_num);
3402
3413 ORT_API2_STATUS(CreateOpAttr,
3414 _In_ const char* name,
3415 _In_ const void* data,
3416 _In_ int len,
3417 _In_ OrtOpAttrType type,
3418 _Outptr_ OrtOpAttr** op_attr);
3419
3420 /* \brief: Release op attribute
3421 *
3422 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
3423 *
3424 * \since Version 1.12.
3425 */
3426 ORT_CLASS_RELEASE(OpAttr);
3427
3445 ORT_API2_STATUS(CreateOp,
3446 _In_ const OrtKernelInfo* info,
3447 _In_ const char* op_name,
3448 _In_ const char* domain,
3449 _In_ int version,
3450 _In_opt_ const char** type_constraint_names,
3451 _In_opt_ const ONNXTensorElementDataType* type_constraint_values,
3452 _In_opt_ int type_constraint_count,
3453 _In_opt_ const OrtOpAttr* const* attr_values,
3454 _In_opt_ int attr_count,
3455 _In_ int input_count,
3456 _In_ int output_count,
3457 _Outptr_ OrtOp** ort_op);
3458
3471 ORT_API2_STATUS(InvokeOp,
3472 _In_ const OrtKernelContext* context,
3473 _In_ const OrtOp* ort_op,
3474 _In_ const OrtValue* const* input_values,
3475 _In_ int input_count,
3476 _Inout_ OrtValue* const* output_values,
3477 _In_ int output_count);
3478
3479 /* \brief: Release an onnxruntime operator
3480 *
3481 * \param[in] Op Operator created by OrtApi::CreateOp
3482 *
3483 * \since Version 1.12.
3484 */
3485 ORT_CLASS_RELEASE(Op);
3486
3521 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
3522 _In_ const char* provider_name,
3523 _In_reads_(num_keys) const char* const* provider_options_keys,
3524 _In_reads_(num_keys) const char* const* provider_options_values,
3525 _In_ size_t num_keys);
3526
3527 /* \brief: Get a copy of kernel info
3528 *
3529 * \param[in] info Kernel info
3530 * \param[out] info_copy Copy of kernel info
3531 *
3532 * \since Version 1.12.
3533 */
3534 ORT_API2_STATUS(CopyKernelInfo,
3535 _In_ const OrtKernelInfo* info,
3536 _Outptr_ OrtKernelInfo** info_copy);
3537
3538 /* \brief: Release kernel info
3539 *
3540 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
3541 *
3542 * \since Version 1.12.
3543 */
3544 ORT_CLASS_RELEASE(KernelInfo);
3545
3546 /* \brief: Get the training C Api
3547 *
3548 * \param[in] version Must be ::ORT_API_VERSION
3549 * \return The ::OrtTrainingApi for the version requested.
3550 * nullptr will be returned and no error message will be printed if the training api is not supported with
3551 * this build.
3552 * nullptr will be returned and an error message will be printed if the provided version is unsupported, for
3553 * example when using a runtime older than the version created with this header file.
3554 *
3555 * \since Version 1.13
3556 */
3557 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
3558
3571 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
3572
3581 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
3582
3594 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
3595 _In_reads_(num_keys) const char* const* provider_options_keys,
3596 _In_reads_(num_keys) const char* const* provider_options_values,
3597 _In_ size_t num_keys);
3598
3612 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
3613 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3614
3621 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
3622
3623 /* \brief Get OrtDevice type from MemoryInfo
3624 *
3625 * \since Version 1.14
3626 */
3627 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
3628
3629 /* \brief Update the OrtEnv instance with custom log severity level
3630 *
3631 * \param[in] ort_env The OrtEnv instance being used
3632 * \param[in] log_severity_level The log severity level.
3633 *
3634 * \since Version 1.14.
3635 */
3636 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
3637
3638 /* \brief Set affinities for intra op threads
3639 *
3640 * Affinity string follows format:
3641 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
3642 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
3643 * e.g. 1,2,3;4,5
3644 * 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.
3645 * To ease the configuration, an "interval" is also allowed:
3646 * e.g. 1-8;8-16;17-24
3647 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
3648 * Note:
3649 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
3650 * ort does not set affinity on the main thread which is started and managed by the calling app;
3651 * 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,
3652 * 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.
3653 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
3654 *
3655 * \since Version 1.14
3656 */
3657 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
3658
3677 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
3678
3703 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
3704 _In_ const char* registration_func_name);
3705
3709
3721 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3722
3734 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3735
3760 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3761 _Inout_ size_t* size);
3762
3788 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3789 _Inout_ size_t* size);
3790
3803 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
3804 _Outptr_ OrtTypeInfo** type_info);
3805
3818 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
3819 _Outptr_ OrtTypeInfo** type_info);
3820
3833 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
3834 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
3835
3840
3856 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
3857 _In_z_ const char* config_key, _Out_ int* out);
3858
3887 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
3888 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
3889
3891
3904 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
3905
3914 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
3915
3932 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
3933 _In_reads_(num_keys) const char* const* provider_options_keys,
3934 _In_reads_(num_keys) const char* const* provider_options_values,
3935 _In_ size_t num_keys);
3936
3951 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3952
3957 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
3958
3959#ifdef __cplusplus
3960 OrtApi(const OrtApi&) = delete; // Prevent users from accidentally copying the API structure, it should always be passed as a pointer
3961#endif
3962};
3963
3964/*
3965 * Steps to use a custom op:
3966 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
3967 * 2 Create an OrtCustomOp structure for each op and add them to the domain
3968 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
3969 */
3970
3971// Specifies some characteristics of inputs/outputs of custom ops:
3972// Specify if the inputs/outputs are one of:
3973// 1) Non-optional (input/output must be present in the node)
3974// 2) Optional (input/output may be absent in the node)
3975// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
3976// Only the last input or output of a custom op may be marked as variadic.
3977// The homogeneity of the variadic input or output determines whether all operands must be of the same
3978// tensor element type.
3984
3985/*
3986 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
3987 * the implementor of the custom op.
3988 */
3990 uint32_t version; // Must be initialized to ORT_API_VERSION
3991
3992 // This callback creates the kernel, which is a user defined parameter that is passed to the Kernel* callbacks below.
3993 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
3994 _In_ const OrtKernelInfo* info);
3995
3996 // Returns the name of the op
3997 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
3998
3999 // Returns the type of the execution provider, return nullptr to use CPU execution provider
4000 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
4001
4002 // Returns the count and types of the input & output tensors
4003 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4004 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
4005 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4006 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
4007
4008 // Op kernel callbacks
4009 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
4010 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
4011
4012 // Returns the characteristics of the input & output tensors
4013 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4014 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4015
4016 // Returns the memory type of the input tensors. This API allows the custom op
4017 // to place the inputs on specific devices. By default, it returns
4018 // OrtMemTypeDefault, which means the input is placed on the default device for
4019 // the execution provider. If the inputs need to be with different memory tyeps,
4020 // this function can be overridden to return the specific memory types.
4021 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4022
4023 // Returns the minimum number of input arguments expected for the variadic input.
4024 // Applicable only for custom ops that have a variadic input.
4025 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
4026
4027 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
4028 // and false (zero) otherwise.
4029 // Applicable only for custom ops that have a variadic input.
4030 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
4031
4032 // Returns the minimum number of output values expected for the variadic output.
4033 // Applicable only for custom ops that have a variadic output.
4034 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
4035
4036 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
4037 // and false (zero) otherwise.
4038 // Applicable only for custom ops that have a variadic output.
4039 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
4040};
4041
4042/*
4043 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
4044 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
4045 *
4046 * \param device_id CUDA device id, starts from zero.
4047 */
4048ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
4049
4050/*
4051 * This is the old way to add the MIGraphX provider to the session, please use
4052 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
4053 * This function always exists, but will only succeed if Onnxruntime was built with
4054 * HIP support and the MIGraphX provider shared library exists
4055 *
4056 * \param device_id HIP device id, starts from zero.
4057 */
4058ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
4059
4060/*
4061 * This is the old way to add the oneDNN provider to the session, please use
4062 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
4063 * This function always exists, but will only succeed if Onnxruntime was built with
4064 * oneDNN support and the oneDNN provider shared library exists
4065 *
4066 * \param use_arena zero: false. non-zero: true.
4067 */
4068ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
4069
4070#ifdef __cplusplus
4071}
4072#endif
4073
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition: onnxruntime_c_api.h:252
struct OrtKernelInfo OrtKernelInfo
Definition: onnxruntime_c_api.h:329
OrtLoggingLevel
Logging severity levels.
Definition: onnxruntime_c_api.h:207
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition: onnxruntime_c_api.h:353
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition: onnxruntime_c_api.h:294
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition: onnxruntime_c_api.h:627
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition: onnxruntime_c_api.h:629
OrtCustomOpInputOutputCharacteristic
Definition: onnxruntime_c_api.h:3979
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition: onnxruntime_c_api.h:268
struct OrtOpAttr OrtOpAttr
Definition: onnxruntime_c_api.h:273
struct OrtThreadingOptions OrtThreadingOptions
Definition: onnxruntime_c_api.h:265
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition: onnxruntime_c_api.h:262
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition: onnxruntime_c_api.h:318
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition: onnxruntime_c_api.h:271
OrtSparseIndicesFormat
Definition: onnxruntime_c_api.h:196
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition: onnxruntime_c_api.h:267
struct OrtSession OrtSession
Definition: onnxruntime_c_api.h:254
struct OrtCustomOpDomain OrtCustomOpDomain
Definition: onnxruntime_c_api.h:260
struct OrtIoBinding OrtIoBinding
Definition: onnxruntime_c_api.h:253
OrtAllocatorType
Definition: onnxruntime_c_api.h:335
struct OrtOp OrtOp
Definition: onnxruntime_c_api.h:272
struct OrtModelMetadata OrtModelMetadata
Definition: onnxruntime_c_api.h:263
struct OrtTypeInfo OrtTypeInfo
Definition: onnxruntime_c_api.h:257
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition: onnxruntime_c_api.h:258
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition: onnxruntime_c_api.h:269
struct OrtKernelContext OrtKernelContext
Definition: onnxruntime_c_api.h:331
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition: onnxruntime_c_api.h:361
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition: onnxruntime_c_api.h:270
struct OrtRunOptions OrtRunOptions
Definition: onnxruntime_c_api.h:256
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition: onnxruntime_c_api.h:609
struct OrtSessionOptions OrtSessionOptions
Definition: onnxruntime_c_api.h:259
struct OrtValue OrtValue
Definition: onnxruntime_c_api.h:255
GraphOptimizationLevel
Graph optimization level.
Definition: onnxruntime_c_api.h:303
OrtStatus * OrtStatusPtr
Definition: onnxruntime_c_api.h:278
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition: onnxruntime_c_api.h:344
OrtSparseFormat
Definition: onnxruntime_c_api.h:188
ONNXType
Definition: onnxruntime_c_api.h:176
struct OrtEnv OrtEnv
Definition: onnxruntime_c_api.h:250
OrtErrorCode
Definition: onnxruntime_c_api.h:215
struct OrtStatus OrtStatus
Definition: onnxruntime_c_api.h:251
struct OrtTrainingApi OrtTrainingApi
Definition: onnxruntime_c_api.h:580
struct OrtMapTypeInfo OrtMapTypeInfo
Definition: onnxruntime_c_api.h:261
struct OrtArenaCfg OrtArenaCfg
Definition: onnxruntime_c_api.h:266
ExecutionMode
Definition: onnxruntime_c_api.h:310
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition: onnxruntime_c_api.h:230
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:620
ONNXTensorElementDataType
Definition: onnxruntime_c_api.h:155
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:208
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition: onnxruntime_c_api.h:209
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition: onnxruntime_c_api.h:211
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition: onnxruntime_c_api.h:210
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition: onnxruntime_c_api.h:212
@ OrtMemoryInfoDeviceType_GPU
Definition: onnxruntime_c_api.h:355
@ OrtMemoryInfoDeviceType_FPGA
Definition: onnxruntime_c_api.h:356
@ OrtMemoryInfoDeviceType_CPU
Definition: onnxruntime_c_api.h:354
@ INPUT_OUTPUT_VARIADIC
Definition: onnxruntime_c_api.h:3982
@ INPUT_OUTPUT_REQUIRED
Definition: onnxruntime_c_api.h:3980
@ INPUT_OUTPUT_OPTIONAL
Definition: onnxruntime_c_api.h:3981
@ ORT_PROJECTION_C
Definition: onnxruntime_c_api.h:319
@ ORT_PROJECTION_PYTHON
Definition: onnxruntime_c_api.h:322
@ ORT_PROJECTION_CPLUSPLUS
Definition: onnxruntime_c_api.h:320
@ ORT_PROJECTION_WINML
Definition: onnxruntime_c_api.h:324
@ ORT_PROJECTION_CSHARP
Definition: onnxruntime_c_api.h:321
@ ORT_PROJECTION_JAVA
Definition: onnxruntime_c_api.h:323
@ ORT_PROJECTION_NODEJS
Definition: onnxruntime_c_api.h:325
@ ORT_SPARSE_COO_INDICES
Definition: onnxruntime_c_api.h:197
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition: onnxruntime_c_api.h:200
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition: onnxruntime_c_api.h:199
@ ORT_SPARSE_CSR_INNER_INDICES
Definition: onnxruntime_c_api.h:198
@ OrtDeviceAllocator
Definition: onnxruntime_c_api.h:337
@ OrtArenaAllocator
Definition: onnxruntime_c_api.h:338
@ OrtInvalidAllocator
Definition: onnxruntime_c_api.h:336
@ OrtCudnnConvAlgoSearchDefault
Definition: onnxruntime_c_api.h:364
@ OrtCudnnConvAlgoSearchExhaustive
Definition: onnxruntime_c_api.h:362
@ OrtCudnnConvAlgoSearchHeuristic
Definition: onnxruntime_c_api.h:363
@ ORT_ENABLE_BASIC
Definition: onnxruntime_c_api.h:305
@ ORT_ENABLE_ALL
Definition: onnxruntime_c_api.h:307
@ ORT_DISABLE_ALL
Definition: onnxruntime_c_api.h:304
@ ORT_ENABLE_EXTENDED
Definition: onnxruntime_c_api.h:306
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition: onnxruntime_c_api.h:345
@ OrtMemTypeCPU
Temporary CPU accessible memory allocated by non-CPU execution provider, i.e. CUDA_PINNED.
Definition: onnxruntime_c_api.h:347
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition: onnxruntime_c_api.h:348
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. CUDA_PINNED.
Definition: onnxruntime_c_api.h:346
@ ORT_SPARSE_CSRC
Definition: onnxruntime_c_api.h:191
@ ORT_SPARSE_COO
Definition: onnxruntime_c_api.h:190
@ ORT_SPARSE_BLOCK_SPARSE
Definition: onnxruntime_c_api.h:192
@ ORT_SPARSE_UNDEFINED
Definition: onnxruntime_c_api.h:189
@ ONNX_TYPE_SEQUENCE
Definition: onnxruntime_c_api.h:179
@ ONNX_TYPE_MAP
Definition: onnxruntime_c_api.h:180
@ ONNX_TYPE_OPAQUE
Definition: onnxruntime_c_api.h:181
@ ONNX_TYPE_UNKNOWN
Definition: onnxruntime_c_api.h:177
@ ONNX_TYPE_TENSOR
Definition: onnxruntime_c_api.h:178
@ ONNX_TYPE_SPARSETENSOR
Definition: onnxruntime_c_api.h:182
@ ONNX_TYPE_OPTIONAL
Definition: onnxruntime_c_api.h:183
@ ORT_NO_SUCHFILE
Definition: onnxruntime_c_api.h:219
@ ORT_OK
Definition: onnxruntime_c_api.h:216
@ ORT_INVALID_ARGUMENT
Definition: onnxruntime_c_api.h:218
@ ORT_EP_FAIL
Definition: onnxruntime_c_api.h:227
@ ORT_NOT_IMPLEMENTED
Definition: onnxruntime_c_api.h:225
@ ORT_RUNTIME_EXCEPTION
Definition: onnxruntime_c_api.h:222
@ ORT_ENGINE_ERROR
Definition: onnxruntime_c_api.h:221
@ ORT_FAIL
Definition: onnxruntime_c_api.h:217
@ ORT_INVALID_PROTOBUF
Definition: onnxruntime_c_api.h:223
@ ORT_NO_MODEL
Definition: onnxruntime_c_api.h:220
@ ORT_INVALID_GRAPH
Definition: onnxruntime_c_api.h:226
@ ORT_MODEL_LOADED
Definition: onnxruntime_c_api.h:224
@ ORT_PARALLEL
Definition: onnxruntime_c_api.h:312
@ ORT_SEQUENTIAL
Definition: onnxruntime_c_api.h:311
@ ORT_OP_ATTR_INT
Definition: onnxruntime_c_api.h:232
@ ORT_OP_ATTR_FLOATS
Definition: onnxruntime_c_api.h:235
@ ORT_OP_ATTR_STRINGS
Definition: onnxruntime_c_api.h:237
@ ORT_OP_ATTR_UNDEFINED
Definition: onnxruntime_c_api.h:231
@ ORT_OP_ATTR_INTS
Definition: onnxruntime_c_api.h:233
@ ORT_OP_ATTR_STRING
Definition: onnxruntime_c_api.h:236
@ ORT_OP_ATTR_FLOAT
Definition: onnxruntime_c_api.h:234
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition: onnxruntime_c_api.h:164
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition: onnxruntime_c_api.h:162
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition: onnxruntime_c_api.h:168
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition: onnxruntime_c_api.h:160
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition: onnxruntime_c_api.h:156
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition: onnxruntime_c_api.h:171
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition: onnxruntime_c_api.h:169
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition: onnxruntime_c_api.h:163
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition: onnxruntime_c_api.h:165
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition: onnxruntime_c_api.h:166
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition: onnxruntime_c_api.h:158
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition: onnxruntime_c_api.h:161
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition: onnxruntime_c_api.h:167
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition: onnxruntime_c_api.h:159
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition: onnxruntime_c_api.h:157
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition: onnxruntime_c_api.h:172
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition: onnxruntime_c_api.h:170
Memory allocation interface.
Definition: onnxruntime_c_api.h:287
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition: onnxruntime_c_api.h:290
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition: onnxruntime_c_api.h:291
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition: onnxruntime_c_api.h:288
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition: onnxruntime_c_api.h:289
The helper interface to get the right version of OrtApi.
Definition: onnxruntime_c_api.h:586
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition: onnxruntime_c_api.h:594
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition: onnxruntime_c_api.h:593
The C API.
Definition: onnxruntime_c_api.h:638
OrtStatus * SetGlobalIntraOpThreadAffinity(OrtThreadingOptions *tp_options, const char *affinity_string)
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:3957
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.
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 * 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 * 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)
Definition: onnxruntime_c_api.h:3557
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 * 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:2302
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 * 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 * 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:3627
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 * AddExternalInitializers(OrtSessionOptions *options, const char *const *initializer_names, const OrtValue *const *initializers, size_t initializers_num)
Replace initialized Tensors with external data with the data provided in initializers.
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 * CreateEnvWithCustomLogger(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * MemoryInfoGetName(const OrtMemoryInfo *ptr, const char **out)
Get name from OrtMemoryInfo.
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 * 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 * 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.
OrtStatus * KernelInfo_GetInputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's input.
OrtStatus * RegisterCustomOpsLibrary(OrtSessionOptions *options, const char *library_path, void **library_handle)
OrtApi(const OrtApi &)=delete
OrtStatus * SetCurrentGpuDeviceId(int device_id)
Set current GPU device ID.
OrtStatus * GetOnnxTypeFromTypeInfo(const OrtTypeInfo *type_info, enum ONNXType *out)
Get ONNXType from OrtTypeInfo.
OrtStatus * GetDenotationFromTypeInfo(const OrtTypeInfo *type_info, const char **const denotation, size_t *len)
Get denotation from type information.
void(* ReleaseCANNProviderOptions)(OrtCANNProviderOptions *input)
Release an OrtCANNProviderOptions.
Definition: onnxruntime_c_api.h:3621
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 * 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 * 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 * ModelMetadataGetGraphName(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, char **value)
Get graph name from an OrtModelMetadata.
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 * 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 * 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:663
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 * 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 * 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 * 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:2306
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 * 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 * 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:649
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 * 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 * 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 * 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 * 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 * 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:2857
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:3360
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:656
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:371
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition: onnxruntime_c_api.h:422
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:417
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition: onnxruntime_c_api.h:427
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:400
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition: onnxruntime_c_api.h:408
int tunable_op_enabled
Enable TunableOp. Set it to 1 to enable TunableOp. Otherwise, it is disabled by default....
Definition: onnxruntime_c_api.h:437
OrtCUDAProviderOptions()
Definition: onnxruntime_c_api.h:373
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition: onnxruntime_c_api.h:431
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition: onnxruntime_c_api.h:394
int device_id
CUDA device Id Defaults to 0.
Definition: onnxruntime_c_api.h:388
Definition: onnxruntime_c_api.h:611
char __place_holder
Definition: onnxruntime_c_api.h:612
Definition: onnxruntime_c_api.h:3989
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4030
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4014
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4004
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4034
const char *(* GetName)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:3997
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4006
void(* KernelDestroy)(void *op_kernel)
Definition: onnxruntime_c_api.h:4010
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4039
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4021
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition: onnxruntime_c_api.h:3993
uint32_t version
Definition: onnxruntime_c_api.h:3990
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4003
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4013
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4000
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4005
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4025
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition: onnxruntime_c_api.h:4009
MIGraphX Provider Options.
Definition: onnxruntime_c_api.h:546
int migraphx_int8_enable
Definition: onnxruntime_c_api.h:549
int migraphx_fp16_enable
Definition: onnxruntime_c_api.h:548
int device_id
Definition: onnxruntime_c_api.h:547
OpenVINO Provider Options.
Definition: onnxruntime_c_api.h:556
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition: onnxruntime_c_api.h:572
size_t num_of_threads
0 = Use default number of threads
Definition: onnxruntime_c_api.h:569
void * context
Definition: onnxruntime_c_api.h:571
unsigned char enable_vpu_fast_compile
0 = disabled, nonzero = enabled
Definition: onnxruntime_c_api.h:567
const char * cache_dir
Definition: onnxruntime_c_api.h:570
const char * device_type
Device type string.
Definition: onnxruntime_c_api.h:566
const char * device_id
Definition: onnxruntime_c_api.h:568
OrtOpenVINOProviderOptions()
Definition: onnxruntime_c_api.h:558
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition: onnxruntime_c_api.h:573
ROCM Provider Options.
Definition: onnxruntime_c_api.h:445
int device_id
ROCM device Id Defaults to 0.
Definition: onnxruntime_c_api.h:462
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:490
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition: onnxruntime_c_api.h:504
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:473
OrtROCMProviderOptions()
Definition: onnxruntime_c_api.h:447
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition: onnxruntime_c_api.h:500
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition: onnxruntime_c_api.h:481
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition: onnxruntime_c_api.h:495
int tunable_op_enabled
Enable TunableOp. Set it to 1 to enable TunableOp. Otherwise, it is disabled by default....
Definition: onnxruntime_c_api.h:510
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exaustive search option. Defaults to 0 (false).
Definition: onnxruntime_c_api.h:467
TensorRT Provider Options.
Definition: onnxruntime_c_api.h:518
int trt_engine_cache_enable
Definition: onnxruntime_c_api.h:532
void * user_compute_stream
Definition: onnxruntime_c_api.h:521
int device_id
CUDA device id (0 = default device)
Definition: onnxruntime_c_api.h:519
const char * trt_engine_cache_path
Definition: onnxruntime_c_api.h:533
int trt_engine_decryption_enable
Definition: onnxruntime_c_api.h:534
int trt_max_partition_iterations
Definition: onnxruntime_c_api.h:522
size_t trt_max_workspace_size
Definition: onnxruntime_c_api.h:524
int trt_dla_enable
Definition: onnxruntime_c_api.h:529
const char * trt_int8_calibration_table_name
Definition: onnxruntime_c_api.h:527
int has_user_compute_stream
Definition: onnxruntime_c_api.h:520
int trt_dla_core
Definition: onnxruntime_c_api.h:530
int trt_int8_use_native_calibration_table
Definition: onnxruntime_c_api.h:528
int trt_min_subgraph_size
Definition: onnxruntime_c_api.h:523
int trt_force_sequential_engine_build
Definition: onnxruntime_c_api.h:536
int trt_dump_subgraphs
Definition: onnxruntime_c_api.h:531
int trt_fp16_enable
Definition: onnxruntime_c_api.h:525
const char * trt_engine_decryption_lib_path
Definition: onnxruntime_c_api.h:535
int trt_int8_enable
Definition: onnxruntime_c_api.h:526