ONNX Runtime
Loading...
Searching...
No Matches
onnxruntime_c_api.h
1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the MIT License.
3
4// See docs\c_cxx\README.md on generating the Doxygen documentation from this file
5
31#pragma once
32#include <stdlib.h>
33#include <stdint.h>
34#include <string.h>
35
40#define ORT_API_VERSION 16
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
47// SAL2 Definitions
48#ifndef _WIN32
49#define _In_
50#define _In_z_
51#define _In_opt_
52#define _In_opt_z_
53#define _Out_
54#define _Outptr_
55#define _Out_opt_
56#define _Inout_
57#define _Inout_opt_
58#define _Frees_ptr_opt_
59#define _Ret_maybenull_
60#define _Ret_notnull_
61#define _Check_return_
62#define _Outptr_result_maybenull_
63#define _In_reads_(X)
64#define _Inout_updates_(X)
65#define _Out_writes_(X)
66#define _Inout_updates_all_(X)
67#define _Out_writes_bytes_all_(X)
68#define _Out_writes_all_(X)
69#define _Success_(X)
70#define _Outptr_result_buffer_maybenull_(X)
71#define ORT_ALL_ARGS_NONNULL __attribute__((nonnull))
72#else
73#include <specstrings.h>
74#define ORT_ALL_ARGS_NONNULL
75#endif
76
77#ifdef _WIN32
78// Define ORT_DLL_IMPORT if your program is dynamically linked to Ort.
79// dllexport is not used, we use a .def file.
80#ifdef ORT_DLL_IMPORT
81#define ORT_EXPORT __declspec(dllimport)
82#else
83#define ORT_EXPORT
84#endif
85#define ORT_API_CALL _stdcall
86#define ORT_MUST_USE_RESULT
87#define ORTCHAR_T wchar_t
88#else
89// To make symbols visible on macOS/iOS
90#ifdef __APPLE__
91#define ORT_EXPORT __attribute__((visibility("default")))
92#else
93#define ORT_EXPORT
94#endif
95#define ORT_API_CALL
96#define ORT_MUST_USE_RESULT __attribute__((warn_unused_result))
97#define ORTCHAR_T char
98#endif
99
102#ifndef ORT_TSTR
103#ifdef _WIN32
104#define ORT_TSTR(X) L##X
105// When X is a macro, L##X is not defined. In this case, we need to use ORT_TSTR_ON_MACRO.
106#define ORT_TSTR_ON_MACRO(X) L"" X
107#else
108#define ORT_TSTR(X) X
109#define ORT_TSTR_ON_MACRO(X) X
110#endif
111#endif
112
113// On Windows, ORT_FILE is a wchar_t version of the __FILE__ macro.
114// Otherwise, ORT_FILE is equivalent to __FILE__.
115#ifndef ORT_FILE
116#define ORT_FILE_INTERNAL(x) ORT_TSTR(x)
117#define ORT_FILE ORT_FILE_INTERNAL(__FILE__)
118#endif
119
120// Any pointer marked with _In_ or _Out_, cannot be NULL.
121
122// Windows users should use unicode paths when possible to bypass the MAX_PATH limitation
123// Every pointer marked with _In_ or _Out_, cannot be NULL. Caller should ensure that.
124// for ReleaseXXX(...) functions, they can accept NULL pointer.
125
126#ifdef __cplusplus
127// For any compiler with C++11 support, MSVC 2015 and greater, or Clang version supporting noexcept.
128// Such complex condition is needed because compilers set __cplusplus value differently.
129#ifndef __has_feature
130#define __has_feature(x) 0
131#endif
132#if ((__cplusplus >= 201103L) || (_MSC_VER >= 1900) || (defined(__has_feature) && __has_feature(cxx_noexcept)))
133#define NO_EXCEPTION noexcept
134#else
135#define NO_EXCEPTION throw()
136#endif
137#else
138#define NO_EXCEPTION
139#endif
140
141// __VA_ARGS__ on Windows and Linux are different
142#define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
143
144#define ORT_API_STATUS(NAME, ...) \
145 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
146 NO_EXCEPTION ORT_MUST_USE_RESULT
147
148// XXX: Unfortunately, SAL annotations are known to not work with function pointers
149#define ORT_API2_STATUS(NAME, ...) \
150 _Check_return_ _Ret_maybenull_ OrtStatusPtr(ORT_API_CALL* NAME)(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
151
152// Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
153#define ORT_API_STATUS_IMPL(NAME, ...) \
154 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
155
156#define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
157
158#ifdef __DOXYGEN__
159#undef ORT_API_STATUS
160#define ORT_API_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
161#undef ORT_API2_STATUS
162#define ORT_API2_STATUS(NAME, ...) OrtStatus* NAME(__VA_ARGS__)
163#undef ORT_CLASS_RELEASE
164#define ORT_CLASS_RELEASE(X) void Release##X(Ort##X* input)
165#undef NO_EXCEPTION
166#define NO_EXCEPTION
167#endif
178 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
179 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8, // maps to c type uint8_t
180 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8, // maps to c type int8_t
181 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16, // maps to c type uint16_t
182 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16, // maps to c type int16_t
183 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32, // maps to c type int32_t
184 ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64, // maps to c type int64_t
185 ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING, // maps to c++ type std::string
188 ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE, // maps to c type double
189 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32, // maps to c type uint32_t
190 ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64, // maps to c type uint64_t
191 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64, // complex with float32 real and imaginary components
192 ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128, // complex with float64 real and imaginary components
193 ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16, // Non-IEEE floating-point format based on IEEE754 single-precision
194 // float 8 types were introduced in onnx 1.14, see https://onnx.ai/onnx/technical/float8.html
195 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN, // Non-IEEE floating-point format based on IEEE754 single-precision
196 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ, // Non-IEEE floating-point format based on IEEE754 single-precision
197 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2, // Non-IEEE floating-point format based on IEEE754 single-precision
198 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ // Non-IEEE floating-point format based on IEEE754 single-precision
200
201// Synced with onnx TypeProto oneof
202typedef enum ONNXType {
211
212// These types are synced with internal
213// SparseFormatFlags
214typedef enum OrtSparseFormat {
220
221// Enum allows to query sparse tensor indices
228
233typedef enum OrtLoggingLevel {
240
241typedef enum OrtErrorCode {
255
256typedef enum OrtOpAttrType {
265
267#define ORT_RUNTIME_CLASS(X) \
268 struct Ort##X; \
269 typedef struct Ort##X Ort##X;
270
275// The actual types defined have an Ort prefix
276ORT_RUNTIME_CLASS(Env);
277ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
278ORT_RUNTIME_CLASS(MemoryInfo);
279ORT_RUNTIME_CLASS(IoBinding);
280ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
281ORT_RUNTIME_CLASS(Value);
282ORT_RUNTIME_CLASS(RunOptions);
283ORT_RUNTIME_CLASS(TypeInfo);
284ORT_RUNTIME_CLASS(TensorTypeAndShapeInfo);
285ORT_RUNTIME_CLASS(MapTypeInfo);
286ORT_RUNTIME_CLASS(SequenceTypeInfo);
287ORT_RUNTIME_CLASS(OptionalTypeInfo);
288ORT_RUNTIME_CLASS(SessionOptions);
289ORT_RUNTIME_CLASS(CustomOpDomain);
290ORT_RUNTIME_CLASS(ModelMetadata);
291ORT_RUNTIME_CLASS(ThreadPoolParams);
292ORT_RUNTIME_CLASS(ThreadingOptions);
293ORT_RUNTIME_CLASS(ArenaCfg);
294ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
295ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
296ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
297ORT_RUNTIME_CLASS(CANNProviderOptions);
298ORT_RUNTIME_CLASS(DnnlProviderOptions);
299ORT_RUNTIME_CLASS(Op);
300ORT_RUNTIME_CLASS(OpAttr);
301ORT_RUNTIME_CLASS(Logger);
302
303#ifdef _WIN32
304typedef _Return_type_success_(return == 0) OrtStatus* OrtStatusPtr;
305#else
307#endif
308
315typedef struct OrtAllocator {
316 uint32_t version;
317 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size);
318 void(ORT_API_CALL* Free)(struct OrtAllocator* this_, void* p);
319 const struct OrtMemoryInfo*(ORT_API_CALL* Info)(const struct OrtAllocator* this_);
321
322typedef void(ORT_API_CALL* OrtLoggingFunction)(
323 void* param, OrtLoggingLevel severity, const char* category, const char* logid, const char* code_location,
324 const char* message);
325
335 ORT_ENABLE_ALL = 99
337
338typedef enum ExecutionMode {
342
355
356struct OrtKernelInfo;
358struct OrtKernelContext;
360struct OrtCustomOp;
361typedef struct OrtCustomOp OrtCustomOp;
362
363typedef enum OrtAllocatorType {
368
371// Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
372typedef enum OrtMemType {
377} OrtMemType;
378
386
390 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
391 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
392 OrtCudnnConvAlgoSearchDefault, // default algorithm using CUDNN_CONVOLUTION_FWD_ALGO_IMPLICIT_PRECOMP_GEMM
394
400#ifdef __cplusplus
402 : device_id{},
404 gpu_mem_limit{SIZE_MAX},
410 tunable_op_enable{false},
413#endif
414
419
425
431
439
448
453
458
462
468
474
479
481
487#ifdef __cplusplus
489 : device_id{},
491 gpu_mem_limit{SIZE_MAX},
497 tunable_op_enable{false},
500#endif
501
506
511
517
525
534
539
544
548
554
560
565
567
574 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
575 void* user_compute_stream; // user specified CUDA compute stream.
576 int trt_max_partition_iterations; // maximum iterations for TensorRT parser to get capability
577 int trt_min_subgraph_size; // minimum size of TensorRT subgraphs
578 size_t trt_max_workspace_size; // maximum workspace size for TensorRT.
579 int trt_fp16_enable; // enable TensorRT FP16 precision. Default 0 = false, nonzero = true
580 int trt_int8_enable; // enable TensorRT INT8 precision. Default 0 = false, nonzero = true
581 const char* trt_int8_calibration_table_name; // TensorRT INT8 calibration table name.
582 int trt_int8_use_native_calibration_table; // use native TensorRT generated calibration table. Default 0 = false, nonzero = true
583 int trt_dla_enable; // enable DLA. Default 0 = false, nonzero = true
584 int trt_dla_core; // DLA core number. Default 0
585 int trt_dump_subgraphs; // dump TRT subgraph. Default 0 = false, nonzero = true
586 int trt_engine_cache_enable; // enable engine caching. Default 0 = false, nonzero = true
587 const char* trt_engine_cache_path; // specify engine cache path
588 int trt_engine_decryption_enable; // enable engine decryption. Default 0 = false, nonzero = true
589 const char* trt_engine_decryption_lib_path; // specify engine decryption library path
590 int trt_force_sequential_engine_build; // force building TensorRT engine sequentially. Default 0 = false, nonzero = true
591 // This is the legacy struct and don't add new fields here.
592 // For new field that can be represented by string, please add it in include/onnxruntime/core/providers/tensorrt/tensorrt_provider_options.h
593 // For non-string field, need to create a new separate api to handle it.
595
601 int device_id; // hip device id.
602 int migraphx_fp16_enable; // enable MIGraphX FP16 precision. Default 0 = false, nonzero = true
603 int migraphx_int8_enable; // enable MIGraphX INT8 precision. Default 0 = false, nonzero = true
605
611#ifdef __cplusplus
614 device_id{},
616 cache_dir{},
617 context{},
620#endif
625 const char* device_type;
627 const char* device_id;
629 const char* cache_dir; // path is set to empty by default
630 void* context;
632 unsigned char enable_dynamic_shapes;
634
635struct OrtApi;
636typedef struct OrtApi OrtApi;
637
638struct OrtTrainingApi;
639typedef struct OrtTrainingApi OrtTrainingApi;
640
655 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
656
661 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION;
662};
663
664typedef struct OrtApiBase OrtApiBase;
665
670ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
671
677typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
678
679typedef const struct OrtCustomHandleType {
682
688typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
689
695typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
696
697typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
698
706struct OrtApi {
709
717 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
718
724 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
725
731 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
732
736
745 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
746
758 ORT_API2_STATUS(CreateEnvWithCustomLogger, OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
759 OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
760
768 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
776 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
777
781
791 // TODO: document the path separator convention? '/' vs '\'
792 // TODO: should specify the access characteristics of model_path. Is this read only during the
793 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
794 // and continue to access throughout the OrtSession lifetime?
795 // What sort of access is needed to model_path : read or read/write?
796 ORT_API2_STATUS(CreateSession, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
797 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
798
809 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env, _In_ const void* model_data, size_t model_data_length,
810 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
811
830 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
831 _In_reads_(input_len) const char* const* input_names,
832 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
833 _In_reads_(output_names_len) const char* const* output_names, size_t output_names_len,
834 _Inout_updates_all_(output_names_len) OrtValue** outputs);
835
839
855 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
856
864 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
865 _In_ const ORTCHAR_T* optimized_model_filepath);
866
874 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
875 _Outptr_ OrtSessionOptions** out_options);
876
888 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
889
897 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
898
905 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
906
920 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
921
930 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
931
940 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
941
948 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
949
957 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
958
968 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
969
977 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
978
987 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
988 GraphOptimizationLevel graph_optimization_level);
989
1003 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
1004
1017 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
1018
1022
1030 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
1031
1041 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
1042
1046
1056 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
1057
1074 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
1075
1079
1091 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1092
1104 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
1105
1115 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
1116
1125 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1126
1135 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1136
1145 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
1146
1156 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1157
1167 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1168
1178 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
1179 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
1180
1184
1191 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
1192
1202 ORT_API2_STATUS(RunOptionsSetRunLogVerbosityLevel, _Inout_ OrtRunOptions* options, int log_verbosity_level);
1203
1211 ORT_API2_STATUS(RunOptionsSetRunLogSeverityLevel, _Inout_ OrtRunOptions* options, int log_severity_level);
1212
1222 ORT_API2_STATUS(RunOptionsSetRunTag, _Inout_ OrtRunOptions* options, _In_ const char* run_tag);
1223
1233 ORT_API2_STATUS(RunOptionsGetRunLogVerbosityLevel, _In_ const OrtRunOptions* options,
1234 _Out_ int* log_verbosity_level);
1235
1243 ORT_API2_STATUS(RunOptionsGetRunLogSeverityLevel, _In_ const OrtRunOptions* options, _Out_ int* log_severity_level);
1244
1256 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
1257
1266 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
1267
1276 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
1277
1281
1294 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
1296
1312 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
1313 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
1314 _Outptr_ OrtValue** out);
1315
1323 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
1324
1335 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
1336
1345 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
1346
1356 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
1357
1377 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
1378 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
1379
1383
1392 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
1393 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
1394
1402 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
1403
1407
1415
1424
1433 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
1434
1444 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
1446
1456 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1457
1466 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
1467 size_t dim_values_length);
1468
1477 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
1478 _Out_writes_all_(dim_params_length) const char* dim_params[], size_t dim_params_length);
1479
1496 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
1497
1501
1509 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
1510
1518 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
1519
1527 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
1528
1532
1543 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
1544 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
1545
1556 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
1557 _Outptr_ OrtMemoryInfo** out);
1558
1569 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
1570
1578 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
1579
1582 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
1583
1586 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
1587
1590 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
1591
1595
1597 ORT_API2_STATUS(AllocatorAlloc, _Inout_ OrtAllocator* ort_allocator, size_t size, _Outptr_ void** out);
1599 ORT_API2_STATUS(AllocatorFree, _Inout_ OrtAllocator* ort_allocator, void* p);
1601 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
1602
1611 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
1612
1616
1628 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
1629 _In_ int64_t dim_value);
1630
1634
1635 /* Internal information (not seen in Doxygen)
1636 *
1637 * APIs to support non-tensor types - map and sequence.
1638 * Currently only the following types are supported
1639 * Note: the following types should be kept in sync with data_types.h
1640 * Map types
1641 * =========
1642 * std::map<std::string, std::string>
1643 * std::map<std::string, int64_t>
1644 * std::map<std::string, float>
1645 * std::map<std::string, double>
1646 * std::map<int64_t, std::string>
1647 * std::map<int64_t, int64_t>
1648 * std::map<int64_t, float>
1649 * std::map<int64_t, double>
1650 *
1651 * Sequence types
1652 * ==============
1653 * std::vector<std::string>
1654 * std::vector<int64_t>
1655 * std::vector<float>
1656 * std::vector<double>
1657 * std::vector<std::map<std::string, float>>
1658 * std::vector<std::map<int64_t, float>
1659 */
1660
1675 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
1676 _Outptr_ OrtValue** out);
1677
1688 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
1689
1705 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
1706 enum ONNXType value_type, _Outptr_ OrtValue** out);
1707
1730 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
1731 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
1732
1747 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
1748 _Out_ void* data_container, size_t data_container_size);
1749
1754
1763 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
1764 _Out_ float* out);
1765
1774 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
1775 _Out_ int64_t* out);
1776
1797 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
1798 _Inout_ size_t* size);
1799
1804
1809 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1810
1815 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
1816
1821 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
1822 _Out_ const OrtValue** out);
1823
1828 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
1829 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
1830
1834 ORT_CLASS_RELEASE(Env);
1838 ORT_CLASS_RELEASE(Status);
1842 ORT_CLASS_RELEASE(MemoryInfo);
1846 ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
1850 ORT_CLASS_RELEASE(Value);
1854 ORT_CLASS_RELEASE(RunOptions);
1858 ORT_CLASS_RELEASE(TypeInfo);
1862 ORT_CLASS_RELEASE(TensorTypeAndShapeInfo);
1866 ORT_CLASS_RELEASE(SessionOptions);
1870 ORT_CLASS_RELEASE(CustomOpDomain);
1871
1875
1888 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
1889 _Out_ size_t* len);
1890
1904 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
1905 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
1906
1920 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
1921 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
1922
1926
1938 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
1939
1947 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
1948
1952
1962 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
1963 _Outptr_ OrtTypeInfo** type_info);
1964
1968 ORT_CLASS_RELEASE(MapTypeInfo);
1972 ORT_CLASS_RELEASE(SequenceTypeInfo);
1973
1977
1988 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
1989
1997 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
1998
2002
2011 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
2012 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2013
2022 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
2023 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2024
2033 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
2034 _Outptr_ char** value);
2035
2044 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
2045 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2046
2057 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
2058 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
2059
2067 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
2068
2069 ORT_CLASS_RELEASE(ModelMetadata);
2070
2074
2088 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
2089 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2090
2094
2104 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
2105
2109
2115 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
2116
2117 ORT_CLASS_RELEASE(ThreadingOptions);
2118
2122
2134 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
2135 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
2136
2140
2148 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
2149 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
2150 _In_ int64_t dim_value);
2151
2155
2167 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
2168
2177 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
2178 _In_ int providers_length);
2179
2183
2192 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
2193
2203 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
2204
2213 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
2214
2218
2231 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
2232 _In_z_ const char* config_key, _In_z_ const char* config_value);
2233
2237
2246 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
2247 _Outptr_ OrtAllocator** out);
2248
2251 ORT_CLASS_RELEASE(Allocator);
2252
2256
2267 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
2268
2280 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
2281
2285
2288 ORT_CLASS_RELEASE(IoBinding);
2289
2300 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2301
2312 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
2313
2329 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
2330
2348 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2349 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
2350
2368 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
2369 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
2370
2373 void(ORT_API_CALL* ClearBoundInputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2374
2377 void(ORT_API_CALL* ClearBoundOutputs)(_Inout_ OrtIoBinding* binding_ptr) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
2378
2382
2397 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
2398
2402
2417 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
2418 _In_ const OrtArenaCfg* arena_cfg);
2419
2431 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
2432
2436
2446 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
2447
2451
2463 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
2464
2476 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
2477
2491 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
2492
2496
2511 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
2512 _In_ const OrtValue* val);
2513
2517
2533 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
2534 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
2535
2539
2550 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
2551
2562 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
2563
2574 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
2575
2579
2590 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
2591
2595
2608 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
2609 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
2610
2611 ORT_CLASS_RELEASE(ArenaCfg);
2612
2616
2628 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
2629 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
2630
2634
2645 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
2646
2650
2661 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
2662
2673 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
2674
2679
2702 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
2703 _Out_ float* out, _Inout_ size_t* size);
2704
2726 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
2727 _Out_ int64_t* out, _Inout_ size_t* size);
2728
2732
2764 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
2765 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
2766 _Outptr_ OrtArenaCfg** out);
2767
2771
2784 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
2785 _In_z_ const char* config_key, _In_z_ const char* config_value);
2786
2790
2804
2809 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
2810
2814
2832 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
2833 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2834 _Outptr_ OrtSession** out);
2835
2854 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
2855 _In_ const void* model_data, size_t model_data_length,
2856 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
2857 _Outptr_ OrtSession** out);
2858
2862
2881 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
2882
2886
2894
2910 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
2911 _In_reads_(num_keys) const char* const* provider_options_keys,
2912 _In_reads_(num_keys) const char* const* provider_options_values,
2913 _In_ size_t num_keys);
2914
2926 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
2927
2932 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
2933
2937
2944 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
2945
2949
2965 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
2966
2977 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
2978 _In_ const OrtMemoryInfo* mem_info);
2979
2983
2992 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
2993
3010 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
3011 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
3012
3030 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3031 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3032 _In_ const int64_t* indices_data, size_t indices_num);
3033
3053 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3054 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3055 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
3056 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
3057
3076 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
3077 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
3078 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
3079 _In_ const int32_t* indices_data);
3080
3105 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
3106 _In_ const int64_t* dense_shape, size_t dense_shape_len,
3107 _In_ const int64_t* values_shape, size_t values_shape_len,
3109
3124 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
3125
3142 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
3143 _Inout_ int64_t* outer_data, size_t outer_num);
3144
3158 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
3159
3167 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
3168
3176 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3177
3185 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
3186
3196 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
3197
3207 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
3211
3224 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
3225
3230
3242 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
3243
3247
3253 ORT_API2_STATUS(GetTensorMemoryInfo, _In_ const OrtValue* value, _Out_ const OrtMemoryInfo** mem_info);
3254
3258
3268 ORT_API2_STATUS(GetExecutionProviderApi, _In_ const char* provider_name, _In_ uint32_t version, _Outptr_ const void** provider_api);
3269
3271
3274
3281 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3282
3290 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
3291
3299 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3301
3304
3311 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
3312
3320 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
3321
3329 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
3331
3340 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
3341
3350 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
3351
3354
3375 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
3376
3380
3389 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
3390
3408 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
3409 _In_reads_(num_keys) const char* const* provider_options_keys,
3410 _In_reads_(num_keys) const char* const* provider_options_values,
3411 _In_ size_t num_keys);
3412
3427 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3428
3435 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
3436
3438
3451 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
3452
3474 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
3475 _In_reads_(input_len) const char* const* initializer_names,
3476 _In_reads_(input_len) const OrtValue* const* initializers, size_t initializers_num);
3477
3488 ORT_API2_STATUS(CreateOpAttr,
3489 _In_ const char* name,
3490 _In_ const void* data,
3491 _In_ int len,
3492 _In_ OrtOpAttrType type,
3493 _Outptr_ OrtOpAttr** op_attr);
3494
3495 /* \brief: Release op attribute
3496 *
3497 * \param[in] opAttr Attribute created by OrtApi::CreateOpAttr
3498 *
3499 * \since Version 1.12.
3500 */
3501 ORT_CLASS_RELEASE(OpAttr);
3502
3520 ORT_API2_STATUS(CreateOp,
3521 _In_ const OrtKernelInfo* info,
3522 _In_z_ const char* op_name,
3523 _In_z_ const char* domain,
3524 int version,
3525 _In_reads_(type_constraint_count) const char** type_constraint_names,
3526 _In_reads_(type_constraint_count) const ONNXTensorElementDataType* type_constraint_values,
3527 int type_constraint_count,
3528 _In_reads_(attr_count) const OrtOpAttr* const* attr_values,
3529 int attr_count,
3530 int input_count,
3531 int output_count,
3532 _Outptr_ OrtOp** ort_op);
3533
3546 ORT_API2_STATUS(InvokeOp,
3547 _In_ const OrtKernelContext* context,
3548 _In_ const OrtOp* ort_op,
3549 _In_ const OrtValue* const* input_values,
3550 _In_ int input_count,
3551 _Inout_ OrtValue* const* output_values,
3552 _In_ int output_count);
3553
3554 /* \brief: Release an onnxruntime operator
3555 *
3556 * \param[in] Op Operator created by OrtApi::CreateOp
3557 *
3558 * \since Version 1.12.
3559 */
3560 ORT_CLASS_RELEASE(Op);
3561
3608 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider, _In_ OrtSessionOptions* options,
3609 _In_ const char* provider_name,
3610 _In_reads_(num_keys) const char* const* provider_options_keys,
3611 _In_reads_(num_keys) const char* const* provider_options_values,
3612 _In_ size_t num_keys);
3613
3614 /* \brief: Get a copy of kernel info
3615 *
3616 * \param[in] info Kernel info
3617 * \param[out] info_copy Copy of kernel info
3618 *
3619 * \since Version 1.12.
3620 */
3621 ORT_API2_STATUS(CopyKernelInfo,
3622 _In_ const OrtKernelInfo* info,
3623 _Outptr_ OrtKernelInfo** info_copy);
3624
3625 /* \brief: Release kernel info
3626 *
3627 * \param[in] KernelInfo A copy of kernel info returned by CopyKernelInfo
3628 *
3629 * \since Version 1.12.
3630 */
3631 ORT_CLASS_RELEASE(KernelInfo);
3632
3635
3649 const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
3650
3652
3665 _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
3666
3675 ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
3676
3688 ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
3689 _In_reads_(num_keys) const char* const* provider_options_keys,
3690 _In_reads_(num_keys) const char* const* provider_options_values,
3691 _In_ size_t num_keys);
3692
3706 ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
3707 _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
3708
3715 void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
3716
3717 /* \brief Get OrtDevice type from MemoryInfo
3718 *
3719 * \since Version 1.14
3720 */
3721 void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
3722
3723 /* \brief Update the OrtEnv instance with custom log severity level
3724 *
3725 * \param[in] ort_env The OrtEnv instance being used
3726 * \param[in] log_severity_level The log severity level.
3727 *
3728 * \since Version 1.14.
3729 */
3730 ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
3731
3732 /* \brief Set affinities for intra op threads
3733 *
3734 * Affinity string follows format:
3735 * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
3736 * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
3737 * e.g. 1,2,3;4,5
3738 * 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.
3739 * To ease the configuration, an "interval" is also allowed:
3740 * e.g. 1-8;8-16;17-24
3741 * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
3742 * Note:
3743 * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
3744 * ort does not set affinity on the main thread which is started and managed by the calling app;
3745 * 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,
3746 * 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.
3747 * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
3748 *
3749 * \since Version 1.14
3750 */
3751 ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
3752
3771 ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
3772
3797 ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
3798 _In_ const char* registration_func_name);
3799
3803
3815 ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3816
3828 ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
3829
3854 ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3855 _Inout_ size_t* size);
3856
3882 ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
3883 _Inout_ size_t* size);
3884
3897 ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
3898 _Outptr_ OrtTypeInfo** type_info);
3899
3912 ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
3913 _Outptr_ OrtTypeInfo** type_info);
3914
3927 ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
3928 _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
3929
3934
3950 ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
3951 _In_z_ const char* config_key, _Out_ int* out);
3952
3981 ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
3982 _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
3983
3985
3998 _In_ OrtSessionOptions* options, _In_ const OrtDnnlProviderOptions* dnnl_options);
3999
4008 ORT_API2_STATUS(CreateDnnlProviderOptions, _Outptr_ OrtDnnlProviderOptions** out);
4009
4026 ORT_API2_STATUS(UpdateDnnlProviderOptions, _Inout_ OrtDnnlProviderOptions* dnnl_options,
4027 _In_reads_(num_keys) const char* const* provider_options_keys,
4028 _In_reads_(num_keys) const char* const* provider_options_values,
4029 _In_ size_t num_keys);
4030
4045 ORT_API2_STATUS(GetDnnlProviderOptionsAsString, _In_ const OrtDnnlProviderOptions* dnnl_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4046
4051 void(ORT_API_CALL* ReleaseDnnlProviderOptions)(_Frees_ptr_opt_ OrtDnnlProviderOptions* input);
4052
4056
4079 ORT_API2_STATUS(KernelInfo_GetNodeName, _In_ const OrtKernelInfo* info, _Out_ char* out, _Inout_ size_t* size);
4080
4092 ORT_API2_STATUS(KernelInfo_GetLogger, _In_ const OrtKernelInfo* info, _Outptr_ const OrtLogger** logger);
4093
4098
4110 ORT_API2_STATUS(KernelContext_GetLogger, _In_ const OrtKernelContext* context, _Outptr_ const OrtLogger** logger);
4111
4116
4135 ORT_API2_STATUS(Logger_LogMessage, _In_ const OrtLogger* logger, OrtLoggingLevel log_severity_level,
4136 _In_z_ const char* message, _In_z_ const ORTCHAR_T* file_path, int line_number,
4137 _In_z_ const char* func_name);
4138
4150 ORT_API2_STATUS(Logger_GetLoggingSeverityLevel, _In_ const OrtLogger* logger, _Out_ OrtLoggingLevel* out);
4151
4153
4167 ORT_API2_STATUS(KernelInfoGetConstantInput_tensor, _In_ const OrtKernelInfo* info, size_t index, _Out_ int* is_constant, _Outptr_ const OrtValue** out);
4168
4189 ORT_API2_STATUS(CastTypeInfoToOptionalTypeInfo, _In_ const OrtTypeInfo* type_info,
4190 _Outptr_result_maybenull_ const OrtOptionalTypeInfo** out);
4191
4208 ORT_API2_STATUS(GetOptionalContainedTypeInfo, _In_ const OrtOptionalTypeInfo* optional_type_info,
4209 _Outptr_ OrtTypeInfo** out);
4210
4221 ORT_API2_STATUS(GetResizedStringTensorElementBuffer, _Inout_ OrtValue* value, _In_ size_t index, _In_ size_t length_in_bytes, _Inout_ char** buffer);
4222
4233 ORT_API2_STATUS(KernelContext_GetAllocator, _In_ const OrtKernelContext* context, _In_ const OrtMemoryInfo* mem_info, _Outptr_ OrtAllocator** out);
4234
4241 const char*(ORT_API_CALL* GetBuildInfoString)(void);
4242
4245
4254 ORT_API2_STATUS(CreateROCMProviderOptions, _Outptr_ OrtROCMProviderOptions** out);
4255
4273 ORT_API2_STATUS(UpdateROCMProviderOptions, _Inout_ OrtROCMProviderOptions* rocm_options,
4274 _In_reads_(num_keys) const char* const* provider_options_keys,
4275 _In_reads_(num_keys) const char* const* provider_options_values,
4276 _In_ size_t num_keys);
4277
4292 ORT_API2_STATUS(GetROCMProviderOptionsAsString, _In_ const OrtROCMProviderOptions* rocm_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
4293
4300 void(ORT_API_CALL* ReleaseROCMProviderOptions)(_Frees_ptr_opt_ OrtROCMProviderOptions* input);
4301
4303
4317 ORT_API2_STATUS(CreateAndRegisterAllocatorV2, _Inout_ OrtEnv* env, _In_ const char* provider_type, _In_ const OrtMemoryInfo* mem_info, _In_ const OrtArenaCfg* arena_cfg,
4318 _In_reads_(num_keys) const char* const* provider_options_keys, _In_reads_(num_keys) const char* const* provider_options_values, _In_ size_t num_keys);
4319};
4320
4321/*
4322 * Steps to use a custom op:
4323 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
4324 * 2 Create an OrtCustomOp structure for each op and add them to the domain
4325 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
4326 */
4327
4328// Specifies some characteristics of inputs/outputs of custom ops:
4329// Specify if the inputs/outputs are one of:
4330// 1) Non-optional (input/output must be present in the node)
4331// 2) Optional (input/output may be absent in the node)
4332// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
4333// Only the last input or output of a custom op may be marked as variadic.
4334// The homogeneity of the variadic input or output determines whether all operands must be of the same
4335// tensor element type.
4341
4342/*
4343 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
4344 * the implementor of the custom op.
4345 */
4347 uint32_t version; // Must be initialized to ORT_API_VERSION
4348
4349 // This callback creates the kernel, which is a user defined
4350 // parameter that is passed to the Kernel* callbacks below. It is
4351 // recommended to use CreateKernelV2 which allows for a safe error
4352 // propagation by returning an OrtStatusPtr.
4353 void*(ORT_API_CALL* CreateKernel)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
4354 _In_ const OrtKernelInfo* info);
4355
4356 // Returns the name of the op
4357 const char*(ORT_API_CALL* GetName)(_In_ const struct OrtCustomOp* op);
4358
4359 // Returns the type of the execution provider, return nullptr to use CPU execution provider
4360 const char*(ORT_API_CALL* GetExecutionProviderType)(_In_ const struct OrtCustomOp* op);
4361
4362 // Returns the count and types of the input & output tensors
4363 ONNXTensorElementDataType(ORT_API_CALL* GetInputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4364 size_t(ORT_API_CALL* GetInputTypeCount)(_In_ const struct OrtCustomOp* op);
4365 ONNXTensorElementDataType(ORT_API_CALL* GetOutputType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4366 size_t(ORT_API_CALL* GetOutputTypeCount)(_In_ const struct OrtCustomOp* op);
4367
4368 // Perform a computation step. It is recommended to use
4369 // KernelComputeV2 which allows for a safe error propagation by
4370 // returning an OrtStatusPtr.
4371 void(ORT_API_CALL* KernelCompute)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
4372 void(ORT_API_CALL* KernelDestroy)(_In_ void* op_kernel);
4373
4374 // Returns the characteristics of the input & output tensors
4375 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4376 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4377
4378 // Returns the memory type of the input tensors. This API allows the custom op
4379 // to place the inputs on specific devices. By default, it returns
4380 // OrtMemTypeDefault, which means the input is placed on the default device for
4381 // the execution provider. If the inputs need to be with different memory tyeps,
4382 // this function can be overridden to return the specific memory types.
4383 OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
4384
4385 // Returns the minimum number of input arguments expected for the variadic input.
4386 // Applicable only for custom ops that have a variadic input.
4387 int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
4388
4389 // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
4390 // and false (zero) otherwise.
4391 // Applicable only for custom ops that have a variadic input.
4392 int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
4393
4394 // Returns the minimum number of output values expected for the variadic output.
4395 // Applicable only for custom ops that have a variadic output.
4396 int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
4397
4398 // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
4399 // and false (zero) otherwise.
4400 // Applicable only for custom ops that have a variadic output.
4401 int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
4402
4403 // Create the kernel state which is passed to each compute call.
4404 OrtStatusPtr(ORT_API_CALL* CreateKernelV2)(_In_ const struct OrtCustomOp* op, _In_ const OrtApi* api,
4405 _In_ const OrtKernelInfo* info,
4406 _Out_ void** kernel);
4407
4408 // Perform the computation step.
4409 OrtStatusPtr(ORT_API_CALL* KernelComputeV2)(_In_ void* op_kernel, _In_ OrtKernelContext* context);
4410};
4411
4412/*
4413 * This is the old way to add the CUDA provider to the session, please use SessionOptionsAppendExecutionProvider_CUDA above to access the latest functionality
4414 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
4415 *
4416 * \param device_id CUDA device id, starts from zero.
4417 */
4418ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
4419
4420/*
4421 * This is the old way to add the ROCm provider to the session, please use
4422 * SessionOptionsAppendExecutionProvider_ROCM above to access the latest functionality
4423 * This function always exists, but will only succeed if Onnxruntime was built with
4424 * HIP support and the ROCm provider shared library exists
4425 *
4426 * \param device_id HIP device id, starts from zero.
4427 */
4428ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_ROCM, _In_ OrtSessionOptions* options, int device_id);
4429
4430/*
4431 * This is the old way to add the MIGraphX provider to the session, please use
4432 * SessionOptionsAppendExecutionProvider_MIGraphX above to access the latest functionality
4433 * This function always exists, but will only succeed if Onnxruntime was built with
4434 * HIP support and the MIGraphX provider shared library exists
4435 *
4436 * \param device_id HIP device id, starts from zero.
4437 */
4438ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
4439
4440/*
4441 * This is the old way to add the oneDNN provider to the session, please use
4442 * SessionOptionsAppendExecutionProvider_oneDNN above to access the latest functionality
4443 * This function always exists, but will only succeed if Onnxruntime was built with
4444 * oneDNN support and the oneDNN provider shared library exists
4445 *
4446 * \param use_arena zero: false. non-zero: true.
4447 */
4448ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_Dnnl, _In_ OrtSessionOptions* options, int use_arena);
4449
4450#ifdef __cplusplus
4451}
4452#endif
OrtStatus * OrtSessionOptionsAppendExecutionProvider_MIGraphX(OrtSessionOptions *options, int device_id)
struct OrtMemoryInfo OrtMemoryInfo
Definition: onnxruntime_c_api.h:278
struct OrtKernelInfo OrtKernelInfo
Definition: onnxruntime_c_api.h:357
OrtLoggingLevel
Logging severity levels.
Definition: onnxruntime_c_api.h:233
const struct OrtCustomHandleType * OrtCustomThreadHandle
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition: onnxruntime_c_api.h:381
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition: onnxruntime_c_api.h:322
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition: onnxruntime_c_api.h:695
OrtStatus *(* RegisterCustomOpsFn)(OrtSessionOptions *options, const OrtApiBase *api)
Definition: onnxruntime_c_api.h:697
OrtCustomOpInputOutputCharacteristic
Definition: onnxruntime_c_api.h:4336
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition: onnxruntime_c_api.h:295
struct OrtOpAttr OrtOpAttr
Definition: onnxruntime_c_api.h:300
struct OrtThreadingOptions OrtThreadingOptions
Definition: onnxruntime_c_api.h:292
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition: onnxruntime_c_api.h:286
OrtLanguageProjection
Language projection identifiers /see OrtApi::SetLanguageProjection.
Definition: onnxruntime_c_api.h:346
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition: onnxruntime_c_api.h:298
OrtSparseIndicesFormat
Definition: onnxruntime_c_api.h:222
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition: onnxruntime_c_api.h:294
struct OrtSession OrtSession
Definition: onnxruntime_c_api.h:280
struct OrtCustomOpDomain OrtCustomOpDomain
Definition: onnxruntime_c_api.h:289
struct OrtIoBinding OrtIoBinding
Definition: onnxruntime_c_api.h:279
OrtAllocatorType
Definition: onnxruntime_c_api.h:363
struct OrtOp OrtOp
Definition: onnxruntime_c_api.h:299
struct OrtModelMetadata OrtModelMetadata
Definition: onnxruntime_c_api.h:290
struct OrtTypeInfo OrtTypeInfo
Definition: onnxruntime_c_api.h:283
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition: onnxruntime_c_api.h:284
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition: onnxruntime_c_api.h:296
struct OrtKernelContext OrtKernelContext
Definition: onnxruntime_c_api.h:359
OrtStatus * OrtSessionOptionsAppendExecutionProvider_Dnnl(OrtSessionOptions *options, int use_arena)
OrtCudnnConvAlgoSearch
Algorithm to use for cuDNN Convolution Op.
Definition: onnxruntime_c_api.h:389
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition: onnxruntime_c_api.h:297
struct OrtRunOptions OrtRunOptions
Definition: onnxruntime_c_api.h:282
void(* OrtThreadWorkerFn)(void *ort_worker_fn_param)
Thread work loop function.
Definition: onnxruntime_c_api.h:677
OrtStatus * OrtSessionOptionsAppendExecutionProvider_ROCM(OrtSessionOptions *options, int device_id)
struct OrtOptionalTypeInfo OrtOptionalTypeInfo
Definition: onnxruntime_c_api.h:287
struct OrtSessionOptions OrtSessionOptions
Definition: onnxruntime_c_api.h:288
struct OrtValue OrtValue
Definition: onnxruntime_c_api.h:281
GraphOptimizationLevel
Graph optimization level.
Definition: onnxruntime_c_api.h:331
OrtStatus * OrtStatusPtr
Definition: onnxruntime_c_api.h:306
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition: onnxruntime_c_api.h:372
OrtSparseFormat
Definition: onnxruntime_c_api.h:214
ONNXType
Definition: onnxruntime_c_api.h:202
struct OrtEnv OrtEnv
Definition: onnxruntime_c_api.h:276
OrtErrorCode
Definition: onnxruntime_c_api.h:241
struct OrtStatus OrtStatus
Definition: onnxruntime_c_api.h:277
struct OrtLogger OrtLogger
Definition: onnxruntime_c_api.h:301
struct OrtMapTypeInfo OrtMapTypeInfo
Definition: onnxruntime_c_api.h:285
struct OrtArenaCfg OrtArenaCfg
Definition: onnxruntime_c_api.h:293
ExecutionMode
Definition: onnxruntime_c_api.h:338
OrtStatus * OrtSessionOptionsAppendExecutionProvider_CUDA(OrtSessionOptions *options, int device_id)
OrtOpAttrType
Definition: onnxruntime_c_api.h:256
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:688
ONNXTensorElementDataType
Definition: onnxruntime_c_api.h:176
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:234
@ ORT_LOGGING_LEVEL_INFO
Informational messages.
Definition: onnxruntime_c_api.h:235
@ ORT_LOGGING_LEVEL_ERROR
Error messages.
Definition: onnxruntime_c_api.h:237
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition: onnxruntime_c_api.h:236
@ ORT_LOGGING_LEVEL_FATAL
Fatal error messages (most severe).
Definition: onnxruntime_c_api.h:238
@ OrtMemoryInfoDeviceType_GPU
Definition: onnxruntime_c_api.h:383
@ OrtMemoryInfoDeviceType_FPGA
Definition: onnxruntime_c_api.h:384
@ OrtMemoryInfoDeviceType_CPU
Definition: onnxruntime_c_api.h:382
@ INPUT_OUTPUT_VARIADIC
Definition: onnxruntime_c_api.h:4339
@ INPUT_OUTPUT_REQUIRED
Definition: onnxruntime_c_api.h:4337
@ INPUT_OUTPUT_OPTIONAL
Definition: onnxruntime_c_api.h:4338
@ ORT_PROJECTION_C
Definition: onnxruntime_c_api.h:347
@ ORT_PROJECTION_PYTHON
Definition: onnxruntime_c_api.h:350
@ ORT_PROJECTION_CPLUSPLUS
Definition: onnxruntime_c_api.h:348
@ ORT_PROJECTION_WINML
Definition: onnxruntime_c_api.h:352
@ ORT_PROJECTION_CSHARP
Definition: onnxruntime_c_api.h:349
@ ORT_PROJECTION_JAVA
Definition: onnxruntime_c_api.h:351
@ ORT_PROJECTION_NODEJS
Definition: onnxruntime_c_api.h:353
@ ORT_SPARSE_COO_INDICES
Definition: onnxruntime_c_api.h:223
@ ORT_SPARSE_BLOCK_SPARSE_INDICES
Definition: onnxruntime_c_api.h:226
@ ORT_SPARSE_CSR_OUTER_INDICES
Definition: onnxruntime_c_api.h:225
@ ORT_SPARSE_CSR_INNER_INDICES
Definition: onnxruntime_c_api.h:224
@ OrtDeviceAllocator
Definition: onnxruntime_c_api.h:365
@ OrtArenaAllocator
Definition: onnxruntime_c_api.h:366
@ OrtInvalidAllocator
Definition: onnxruntime_c_api.h:364
@ OrtCudnnConvAlgoSearchDefault
Definition: onnxruntime_c_api.h:392
@ OrtCudnnConvAlgoSearchExhaustive
Definition: onnxruntime_c_api.h:390
@ OrtCudnnConvAlgoSearchHeuristic
Definition: onnxruntime_c_api.h:391
@ ORT_ENABLE_BASIC
Definition: onnxruntime_c_api.h:333
@ ORT_ENABLE_ALL
Definition: onnxruntime_c_api.h:335
@ ORT_DISABLE_ALL
Definition: onnxruntime_c_api.h:332
@ ORT_ENABLE_EXTENDED
Definition: onnxruntime_c_api.h:334
@ OrtMemTypeCPUInput
Any CPU memory used by non-CPU execution provider.
Definition: onnxruntime_c_api.h:373
@ OrtMemTypeCPU
Temporary CPU accessible memory allocated by non-CPU execution provider, i.e. CUDA_PINNED.
Definition: onnxruntime_c_api.h:375
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition: onnxruntime_c_api.h:376
@ OrtMemTypeCPUOutput
CPU accessible memory outputted by non-CPU execution provider, i.e. CUDA_PINNED.
Definition: onnxruntime_c_api.h:374
@ ORT_SPARSE_CSRC
Definition: onnxruntime_c_api.h:217
@ ORT_SPARSE_COO
Definition: onnxruntime_c_api.h:216
@ ORT_SPARSE_BLOCK_SPARSE
Definition: onnxruntime_c_api.h:218
@ ORT_SPARSE_UNDEFINED
Definition: onnxruntime_c_api.h:215
@ ONNX_TYPE_SEQUENCE
Definition: onnxruntime_c_api.h:205
@ ONNX_TYPE_MAP
Definition: onnxruntime_c_api.h:206
@ ONNX_TYPE_OPAQUE
Definition: onnxruntime_c_api.h:207
@ ONNX_TYPE_UNKNOWN
Definition: onnxruntime_c_api.h:203
@ ONNX_TYPE_TENSOR
Definition: onnxruntime_c_api.h:204
@ ONNX_TYPE_SPARSETENSOR
Definition: onnxruntime_c_api.h:208
@ ONNX_TYPE_OPTIONAL
Definition: onnxruntime_c_api.h:209
@ ORT_NO_SUCHFILE
Definition: onnxruntime_c_api.h:245
@ ORT_OK
Definition: onnxruntime_c_api.h:242
@ ORT_INVALID_ARGUMENT
Definition: onnxruntime_c_api.h:244
@ ORT_EP_FAIL
Definition: onnxruntime_c_api.h:253
@ ORT_NOT_IMPLEMENTED
Definition: onnxruntime_c_api.h:251
@ ORT_RUNTIME_EXCEPTION
Definition: onnxruntime_c_api.h:248
@ ORT_ENGINE_ERROR
Definition: onnxruntime_c_api.h:247
@ ORT_FAIL
Definition: onnxruntime_c_api.h:243
@ ORT_INVALID_PROTOBUF
Definition: onnxruntime_c_api.h:249
@ ORT_NO_MODEL
Definition: onnxruntime_c_api.h:246
@ ORT_INVALID_GRAPH
Definition: onnxruntime_c_api.h:252
@ ORT_MODEL_LOADED
Definition: onnxruntime_c_api.h:250
@ ORT_PARALLEL
Definition: onnxruntime_c_api.h:340
@ ORT_SEQUENTIAL
Definition: onnxruntime_c_api.h:339
@ ORT_OP_ATTR_INT
Definition: onnxruntime_c_api.h:258
@ ORT_OP_ATTR_FLOATS
Definition: onnxruntime_c_api.h:261
@ ORT_OP_ATTR_STRINGS
Definition: onnxruntime_c_api.h:263
@ ORT_OP_ATTR_UNDEFINED
Definition: onnxruntime_c_api.h:257
@ ORT_OP_ATTR_INTS
Definition: onnxruntime_c_api.h:259
@ ORT_OP_ATTR_STRING
Definition: onnxruntime_c_api.h:262
@ ORT_OP_ATTR_FLOAT
Definition: onnxruntime_c_api.h:260
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
Definition: onnxruntime_c_api.h:185
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32
Definition: onnxruntime_c_api.h:183
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32
Definition: onnxruntime_c_api.h:189
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16
Definition: onnxruntime_c_api.h:181
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED
Definition: onnxruntime_c_api.h:177
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX128
Definition: onnxruntime_c_api.h:192
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2FNUZ
Definition: onnxruntime_c_api.h:198
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64
Definition: onnxruntime_c_api.h:190
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64
Definition: onnxruntime_c_api.h:184
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E5M2
Definition: onnxruntime_c_api.h:197
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL
Definition: onnxruntime_c_api.h:186
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16
Definition: onnxruntime_c_api.h:187
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8
Definition: onnxruntime_c_api.h:179
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16
Definition: onnxruntime_c_api.h:182
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE
Definition: onnxruntime_c_api.h:188
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8
Definition: onnxruntime_c_api.h:180
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition: onnxruntime_c_api.h:178
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FN
Definition: onnxruntime_c_api.h:195
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16
Definition: onnxruntime_c_api.h:193
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_COMPLEX64
Definition: onnxruntime_c_api.h:191
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT8E4M3FNUZ
Definition: onnxruntime_c_api.h:196
Memory allocation interface.
Definition: onnxruntime_c_api.h:315
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition: onnxruntime_c_api.h:318
const struct OrtMemoryInfo *(* Info)(const struct OrtAllocator *this_)
Return a pointer to an OrtMemoryInfo that describes this allocator.
Definition: onnxruntime_c_api.h:319
uint32_t version
Must be initialized to ORT_API_VERSION.
Definition: onnxruntime_c_api.h:316
void *(* Alloc)(struct OrtAllocator *this_, size_t size)
Returns a pointer to an allocated block of size bytes.
Definition: onnxruntime_c_api.h:317
The helper interface to get the right version of OrtApi.
Definition: onnxruntime_c_api.h:645
const char *(* GetVersionString)(void)
Returns a null terminated string of the version of the Onnxruntime library (eg: "1....
Definition: onnxruntime_c_api.h:661
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition: onnxruntime_c_api.h:655
The C API.
Definition: onnxruntime_c_api.h:706
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:4051
OrtStatus * TensorAt(OrtValue *value, const int64_t *location_values, size_t location_values_count, void **out)
Direct memory access to a specified tensor element.
OrtStatus * KernelInfoGetAttribute_float(const OrtKernelInfo *info, const char *name, float *out)
Get a float stored as an attribute in the graph node.
OrtStatus * GetCANNProviderOptionsAsString(const OrtCANNProviderOptions *cann_options, OrtAllocator *allocator, char **ptr)
Get serialized CANN provider options string.
OrtStatus * InvokeOp(const OrtKernelContext *context, const OrtOp *ort_op, const OrtValue *const *input_values, int input_count, OrtValue *const *output_values, int output_count)
: Invoke the operator created by OrtApi::CreateOp The inputs must follow the order as specified in on...
OrtStatus * HasSessionConfigEntry(const OrtSessionOptions *options, const char *config_key, int *out)
Checks if the given session configuration entry exists.
const char *(* GetBuildInfoString)(void)
Returns a null terminated string of the build info including git info and cxx flags.
Definition: onnxruntime_c_api.h:4241
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 * CreateAndRegisterAllocatorV2(OrtEnv *env, const char *provider_type, const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Create an allocator with specific type and register it with the OrtEnv This API enhance CreateAndRegi...
OrtStatus * SessionGetOutputName(const OrtSession *session, size_t index, OrtAllocator *allocator, char **value)
Get output name.
OrtStatus * SessionOptionsAppendExecutionProvider_TensorRT(OrtSessionOptions *options, const OrtTensorRTProviderOptions *tensorrt_options)
Append TensorRT provider to session options.
const OrtTrainingApi *(* GetTrainingApi)(uint32_t version)
Gets the Training C Api struct.
Definition: onnxruntime_c_api.h:3649
OrtStatus * SetIntraOpNumThreads(OrtSessionOptions *options, int intra_op_num_threads)
Sets the number of threads used to parallelize the execution within nodes.
OrtStatus * GetTypeInfo(const OrtValue *value, OrtTypeInfo **out)
Get type information of an OrtValue.
OrtStatus * CastTypeInfoToMapTypeInfo(const OrtTypeInfo *type_info, const OrtMapTypeInfo **out)
Get detailed map information from an OrtTypeInfo.
OrtStatus * KernelContext_GetLogger(const OrtKernelContext *context, const OrtLogger **logger)
Get the runtime logger from OrtKernelContext.
OrtStatus * SetGlobalCustomThreadCreationOptions(OrtThreadingOptions *tp_options, void *ort_custom_thread_creation_options)
Set custom thread creation options for global thread pools.
OrtStatus * AddSessionConfigEntry(OrtSessionOptions *options, const char *config_key, const char *config_value)
Set a session configuration entry as a pair of strings.
OrtStatus * SetGlobalDenormalAsZero(OrtThreadingOptions *tp_options)
Set threading flush-to-zero and denormal-as-zero.
void(* ClearBoundInputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Inputs for an OrtIoBinding.
Definition: onnxruntime_c_api.h:2373
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:3721
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 * Logger_LogMessage(const OrtLogger *logger, OrtLoggingLevel log_severity_level, const char *message, const char *file_path, int line_number, const char *func_name)
Logs a message at the given severity level using the provided OrtLogger.
OrtStatus * CreateEnvWithCustomLogger(OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel log_severity_level, const char *logid, OrtEnv **out)
Create an OrtEnv.
OrtStatus * MemoryInfoGetName(const OrtMemoryInfo *ptr, const char **out)
Get name from OrtMemoryInfo.
OrtStatus * Logger_GetLoggingSeverityLevel(const OrtLogger *logger, OrtLoggingLevel *out)
Get the logging severity level of the OrtLogger.
OrtStatus * GetExecutionProviderApi(const char *provider_name, uint32_t version, const void **provider_api)
Get a pointer to the requested version of the Execution Provider specific API extensions to the OrtAp...
OrtStatus * KernelContext_GetOutputCount(const OrtKernelContext *context, size_t *out)
Used for custom operators, get the output count of a kernel.
OrtStatus * GetTensorShapeElementCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get total number of elements in a tensor shape from an OrtTensorTypeAndShapeInfo.
OrtStatus * CastTypeInfoToTensorInfo(const OrtTypeInfo *type_info, const OrtTensorTypeAndShapeInfo **out)
Get OrtTensorTypeAndShapeInfo from an OrtTypeInfo.
OrtStatus * GetOptionalContainedTypeInfo(const OrtOptionalTypeInfo *optional_type_info, OrtTypeInfo **out)
Get OrtTypeInfo for the allowed contained type from an OrtOptionalTypeInfo.
OrtStatus * CreateOp(const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, int type_constraint_count, const OrtOpAttr *const *attr_values, int attr_count, int input_count, int output_count, OrtOp **ort_op)
: Create onnxruntime native operator
OrtStatus * MemoryInfoGetType(const OrtMemoryInfo *ptr, OrtAllocatorType *out)
Get the OrtAllocatorType from OrtMemoryInfo.
OrtStatus * HasValue(const OrtValue *value, int *out)
Sets out to 1 iff an optional type OrtValue has an element, 0 otherwise (OrtValue is None) Use this A...
OrtStatus * CreateEnvWithGlobalThreadPools(OrtLoggingLevel log_severity_level, const char *logid, const OrtThreadingOptions *tp_options, OrtEnv **out)
Create an OrtEnv.
OrtStatus * KernelContext_GetAllocator(const OrtKernelContext *context, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Get Allocator from KernelContext for a specific memoryInfo. Please use C API ReleaseAllocator to rele...
OrtStatus * KernelInfoGetConstantInput_tensor(const OrtKernelInfo *info, size_t index, int *is_constant, const OrtValue **out)
Get a OrtValue tensor stored as a constant initializer in the graph node.
OrtStatus * GetCUDAProviderOptionsAsString(const OrtCUDAProviderOptionsV2 *cuda_options, OrtAllocator *allocator, char **ptr)
OrtStatus * UpdateCUDAProviderOptions(OrtCUDAProviderOptionsV2 *cuda_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a CUDA Execution Provider.
OrtStatus * CopyKernelInfo(const OrtKernelInfo *info, OrtKernelInfo **info_copy)
OrtStatus * GetTensorRTProviderOptionsAsString(const OrtTensorRTProviderOptionsV2 *tensorrt_options, OrtAllocator *allocator, char **ptr)
Get serialized TensorRT provider options string.
OrtStatus * SessionOptionsSetCustomThreadCreationOptions(OrtSessionOptions *options, void *ort_custom_thread_creation_options)
Set creation options for custom thread.
OrtStatus * GetDimensionsCount(const OrtTensorTypeAndShapeInfo *info, size_t *out)
Get dimension count in OrtTensorTypeAndShapeInfo.
void(* ReleaseROCMProviderOptions)(OrtROCMProviderOptions *input)
Release an OrtROCMProviderOptions.
Definition: onnxruntime_c_api.h:4300
OrtStatus * UpdateROCMProviderOptions(OrtROCMProviderOptions *rocm_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a ROCm Execution Provider.
OrtStatus * KernelInfo_GetInputName(const OrtKernelInfo *info, size_t index, char *out, size_t *size)
Get the name of a OrtKernelInfo's input.
OrtStatus * RegisterCustomOpsLibrary(OrtSessionOptions *options, const char *library_path, void **library_handle)
OrtStatus * SetCurrentGpuDeviceId(int device_id)
Set current GPU device ID.
OrtStatus * GetOnnxTypeFromTypeInfo(const OrtTypeInfo *type_info, enum ONNXType *out)
Get ONNXType from OrtTypeInfo.
OrtStatus * 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:3715
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 * CreateROCMProviderOptions(OrtROCMProviderOptions **out)
Create an OrtROCMProviderOptions.
OrtStatus * ModelMetadataLookupCustomMetadataMap(const OrtModelMetadata *model_metadata, OrtAllocator *allocator, const char *key, char **value)
Return data for a key in the custom metadata map in an OrtModelMetadata.
OrtStatus * RunOptionsSetRunLogSeverityLevel(OrtRunOptions *options, int log_severity_level)
Set per-run log severity level.
OrtStatus * 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:731
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 * GetResizedStringTensorElementBuffer(OrtValue *value, size_t index, size_t length_in_bytes, char **buffer)
Set a single string in a string tensor Do not zero terminate the string data.
OrtStatus * DisableCpuMemArena(OrtSessionOptions *options)
Disable the memory arena on CPU.
void(* ClearBoundOutputs)(OrtIoBinding *binding_ptr) __attribute__((nonnull))
Clears any previously set Outputs for an OrtIoBinding.
Definition: onnxruntime_c_api.h:2377
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 * GetROCMProviderOptionsAsString(const OrtROCMProviderOptions *rocm_options, OrtAllocator *allocator, char **ptr)
OrtStatus * UnregisterAllocator(OrtEnv *env, const OrtMemoryInfo *mem_info)
Unregister a custom allocator.
OrtStatus * DisableMemPattern(OrtSessionOptions *options)
Disable the memory pattern optimization.
OrtStatus * UseBlockSparseIndices(OrtValue *ort_value, const int64_t *indices_shape, size_t indices_shape_len, int32_t *indices_data)
OrtStatus *(* CreateStatus)(OrtErrorCode code, const char *msg) __attribute__((nonnull))
Create an OrtStatus from a null terminated string.
Definition: onnxruntime_c_api.h:717
OrtStatus * RunWithBinding(OrtSession *session, const OrtRunOptions *run_options, const OrtIoBinding *binding_ptr)
Run a model using Io Bindings for the inputs & outputs.
OrtStatus * CreateDnnlProviderOptions(OrtDnnlProviderOptions **out)
Create an OrtDnnlProviderOptions.
OrtStatus * GetMapKeyType(const OrtMapTypeInfo *map_type_info, enum ONNXTensorElementDataType *out)
Get key type from an OrtMapTypeInfo.
OrtStatus * RunOptionsGetRunLogSeverityLevel(const OrtRunOptions *options, int *log_severity_level)
Get per-run log severity level.
OrtStatus * CastTypeInfoToOptionalTypeInfo(const OrtTypeInfo *type_info, const OrtOptionalTypeInfo **out)
Get Optional Type information from an OrtTypeInfo.
OrtStatus * SessionGetModelMetadata(const OrtSession *session, OrtModelMetadata **out)
Get OrtModelMetadata from an OrtSession.
OrtStatus * GetCurrentGpuDeviceId(int *device_id)
Get current GPU device ID.
OrtStatus * SessionGetOutputTypeInfo(const OrtSession *session, size_t index, OrtTypeInfo **type_info)
Get output type information.
OrtStatus * 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 * KernelInfo_GetLogger(const OrtKernelInfo *info, const OrtLogger **logger)
Get the session logger from OrtKernelInfo.
OrtStatus * UpdateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 *tensorrt_options, const char *const *provider_options_keys, const char *const *provider_options_values, size_t num_keys)
Set options in a TensorRT Execution Provider.
OrtStatus * KernelInfoGetAttribute_tensor(const OrtKernelInfo *info, const char *name, OrtAllocator *allocator, OrtValue **out)
Get a OrtValue tensor stored as an attribute in the graph node.
OrtStatus * EnableMemPattern(OrtSessionOptions *options)
Enable the memory pattern optimization.
OrtStatus * SetOptimizedModelFilePath(OrtSessionOptions *options, const char *optimized_model_filepath)
Set filepath to save optimized model after graph level transformations.
OrtStatus * CreateAllocator(const OrtSession *session, const OrtMemoryInfo *mem_info, OrtAllocator **out)
Create an allocator for an OrtSession following an OrtMemoryInfo.
OrtStatus * SynchronizeBoundOutputs(OrtIoBinding *binding_ptr)
Synchronize bound outputs. The call may be necessary for some providers, such as cuda,...
OrtStatus * SessionGetOutputCount(const OrtSession *session, size_t *out)
Get output count for a session.
OrtStatus * CastTypeInfoToSequenceTypeInfo(const OrtTypeInfo *type_info, const OrtSequenceTypeInfo **out)
Cast OrtTypeInfo to an OrtSequenceTypeInfo.
OrtStatus * Run(OrtSession *session, const OrtRunOptions *run_options, const char *const *input_names, const OrtValue *const *inputs, size_t input_len, const char *const *output_names, size_t output_names_len, OrtValue **outputs)
Run the model in an OrtSession.
OrtStatus * GetValueType(const OrtValue *value, enum ONNXType *out)
Get ONNXType of an OrtValue.
OrtStatus * KernelInfo_GetNodeName(const OrtKernelInfo *info, char *out, size_t *size)
Get the graph node name from OrtKernelInfo.
OrtStatus * CreateTensorRTProviderOptions(OrtTensorRTProviderOptionsV2 **out)
Create an OrtTensorRTProviderOptionsV2.
OrtStatus * GetDimensions(const OrtTensorTypeAndShapeInfo *info, int64_t *dim_values, size_t dim_values_length)
Get dimensions in OrtTensorTypeAndShapeInfo.
OrtStatus * SessionGetProfilingStartTimeNs(const OrtSession *session, uint64_t *out)
Return the time that profiling was started.
OrtStatus * RunOptionsUnsetTerminate(OrtRunOptions *options)
Clears the terminate flag.
OrtStatus * CreateOpaqueValue(const char *domain_name, const char *type_name, const void *data_container, size_t data_container_size, OrtValue **out)
Create an opaque (custom user defined type) OrtValue.
OrtStatus * GetSparseTensorValuesTypeAndShape(const OrtValue *ort_value, OrtTensorTypeAndShapeInfo **out)
Returns data type and shape of sparse tensor values (nnz) iff OrtValue contains a SparseTensor.
void(* ReleaseTensorRTProviderOptions)(OrtTensorRTProviderOptionsV2 *input)
Release an OrtTensorRTProviderOptionsV2.
Definition: onnxruntime_c_api.h:2932
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:3435
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:724
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:399
int tunable_op_max_tuning_duration_ms
Max tuning duration time limit for each instance of TunableOp. Defaults to 0 to disable the limit.
Definition: onnxruntime_c_api.h:478
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition: onnxruntime_c_api.h:452
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:447
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition: onnxruntime_c_api.h:457
int tunable_op_enable
Enable TunableOp for using. Set it to 1/0 to enable/disable TunableOp. Otherwise, it is disabled by d...
Definition: onnxruntime_c_api.h:467
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:430
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition: onnxruntime_c_api.h:438
OrtCUDAProviderOptions()
Definition: onnxruntime_c_api.h:401
OrtArenaCfg * default_memory_arena_cfg
CUDA memory arena configuration parameters.
Definition: onnxruntime_c_api.h:461
int tunable_op_tuning_enable
Enable TunableOp for tuning. Set it to 1/0 to enable/disable TunableOp tuning. Otherwise,...
Definition: onnxruntime_c_api.h:473
OrtCudnnConvAlgoSearch cudnn_conv_algo_search
CUDA Convolution algorithm search configuration. See enum OrtCudnnConvAlgoSearch for more details....
Definition: onnxruntime_c_api.h:424
int device_id
CUDA device Id Defaults to 0.
Definition: onnxruntime_c_api.h:418
Definition: onnxruntime_c_api.h:679
char __place_holder
Definition: onnxruntime_c_api.h:680
Definition: onnxruntime_c_api.h:4346
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4392
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4376
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4364
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4396
const char *(* GetName)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4357
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4366
void(* KernelDestroy)(void *op_kernel)
Definition: onnxruntime_c_api.h:4372
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4401
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4383
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition: onnxruntime_c_api.h:4353
uint32_t version
Definition: onnxruntime_c_api.h:4347
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4363
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4375
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4360
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition: onnxruntime_c_api.h:4365
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition: onnxruntime_c_api.h:4387
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition: onnxruntime_c_api.h:4404
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition: onnxruntime_c_api.h:4409
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition: onnxruntime_c_api.h:4371
MIGraphX Provider Options.
Definition: onnxruntime_c_api.h:600
int migraphx_int8_enable
Definition: onnxruntime_c_api.h:603
int migraphx_fp16_enable
Definition: onnxruntime_c_api.h:602
int device_id
Definition: onnxruntime_c_api.h:601
OpenVINO Provider Options.
Definition: onnxruntime_c_api.h:610
unsigned char enable_opencl_throttling
0 = disabled, nonzero = enabled
Definition: onnxruntime_c_api.h:631
size_t num_of_threads
0 = Use default number of threads
Definition: onnxruntime_c_api.h:628
void * context
Definition: onnxruntime_c_api.h:630
unsigned char enable_vpu_fast_compile
0 = disabled, nonzero = enabled
Definition: onnxruntime_c_api.h:626
const char * cache_dir
Definition: onnxruntime_c_api.h:629
const char * device_type
Device type string.
Definition: onnxruntime_c_api.h:625
const char * device_id
Definition: onnxruntime_c_api.h:627
OrtOpenVINOProviderOptions()
Definition: onnxruntime_c_api.h:612
unsigned char enable_dynamic_shapes
0 = disabled, nonzero = enabled
Definition: onnxruntime_c_api.h:632
ROCM Provider Options.
Definition: onnxruntime_c_api.h:486
int device_id
ROCM device Id Defaults to 0.
Definition: onnxruntime_c_api.h:505
int tunable_op_max_tuning_duration_ms
Max tuning duration time limit for each instance of TunableOp. Defaults to 0 to disable the limit.
Definition: onnxruntime_c_api.h:564
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:533
OrtArenaCfg * default_memory_arena_cfg
ROCM memory arena configuration parameters.
Definition: onnxruntime_c_api.h:547
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:516
OrtROCMProviderOptions()
Definition: onnxruntime_c_api.h:488
int tunable_op_enable
Enable TunableOp for using. Set it to 1/0 to enable/disable TunableOp. Otherwise, it is disabled by d...
Definition: onnxruntime_c_api.h:553
void * user_compute_stream
User provided compute stream. If provided, please set has_user_compute_stream to 1.
Definition: onnxruntime_c_api.h:543
int arena_extend_strategy
Strategy used to grow the memory arena 0 = kNextPowerOfTwo 1 = kSameAsRequested Defaults to 0.
Definition: onnxruntime_c_api.h:524
int tunable_op_tuning_enable
Enable TunableOp for tuning. Set it to 1/0 to enable/disable TunableOp tuning. Otherwise,...
Definition: onnxruntime_c_api.h:559
int has_user_compute_stream
Flag indicating if there is a user provided compute stream Defaults to 0.
Definition: onnxruntime_c_api.h:538
int miopen_conv_exhaustive_search
ROCM MIOpen Convolution algorithm exaustive search option. Defaults to 0 (false).
Definition: onnxruntime_c_api.h:510
TensorRT Provider Options.
Definition: onnxruntime_c_api.h:572
int trt_engine_cache_enable
Definition: onnxruntime_c_api.h:586
void * user_compute_stream
Definition: onnxruntime_c_api.h:575
int device_id
CUDA device id (0 = default device)
Definition: onnxruntime_c_api.h:573
const char * trt_engine_cache_path
Definition: onnxruntime_c_api.h:587
int trt_engine_decryption_enable
Definition: onnxruntime_c_api.h:588
int trt_max_partition_iterations
Definition: onnxruntime_c_api.h:576
size_t trt_max_workspace_size
Definition: onnxruntime_c_api.h:578
int trt_dla_enable
Definition: onnxruntime_c_api.h:583
const char * trt_int8_calibration_table_name
Definition: onnxruntime_c_api.h:581
int has_user_compute_stream
Definition: onnxruntime_c_api.h:574
int trt_dla_core
Definition: onnxruntime_c_api.h:584
int trt_int8_use_native_calibration_table
Definition: onnxruntime_c_api.h:582
int trt_min_subgraph_size
Definition: onnxruntime_c_api.h:577
int trt_force_sequential_engine_build
Definition: onnxruntime_c_api.h:590
int trt_dump_subgraphs
Definition: onnxruntime_c_api.h:585
int trt_fp16_enable
Definition: onnxruntime_c_api.h:579
const char * trt_engine_decryption_lib_path
Definition: onnxruntime_c_api.h:589
int trt_int8_enable
Definition: onnxruntime_c_api.h:580
The Training C API that holds onnxruntime training function pointers.
Definition: onnxruntime_training_c_api.h:122