26#include "onnxruntime_c_api.h"
27#include "onnxruntime_float16.h"
36#include <unordered_map>
40#ifdef ORT_NO_EXCEPTIONS
57 const char*
what() const noexcept
override {
return message_.c_str(); }
64#ifdef ORT_NO_EXCEPTIONS
67#ifndef ORT_CXX_API_THROW
68#define ORT_CXX_API_THROW(string, code) \
70 std::cerr << Ort::Exception(string, code) \
77#define ORT_CXX_API_THROW(string, code) \
78 throw Ort::Exception(string, code)
91#ifdef ORT_API_MANUAL_INIT
111#if defined(_MSC_VER) && !defined(__clang__)
115#pragma warning(disable : 26426)
118#if defined(_MSC_VER) && !defined(__clang__)
164struct Float16_t : onnxruntime_float16::Float16Impl<Float16_t> {
171 constexpr explicit Float16_t(uint16_t v)
noexcept { val = v; }
174 using Base = onnxruntime_float16::Float16Impl<Float16_t>;
192 explicit Float16_t(
float v)
noexcept { val = Base::ToUint16Impl(v); }
198 float ToFloat() const noexcept {
return Base::ToFloatImpl(); }
204 using Base::IsNegative;
216 using Base::IsFinite;
222 using Base::IsPositiveInfinity;
228 using Base::IsNegativeInfinity;
234 using Base::IsInfinity;
240 using Base::IsNaNOrZero;
246 using Base::IsNormal;
252 using Base::IsSubnormal;
279 explicit operator float() const noexcept {
return ToFloat(); }
281 using Base::operator==;
282 using Base::operator!=;
283 using Base::operator<;
286static_assert(
sizeof(Float16_t) ==
sizeof(uint16_t),
"Sizes must match");
306struct BFloat16_t : onnxruntime_float16::BFloat16Impl<BFloat16_t> {
315 constexpr explicit BFloat16_t(uint16_t v)
noexcept { val = v; }
318 using Base = onnxruntime_float16::BFloat16Impl<BFloat16_t>;
333 explicit BFloat16_t(
float v)
noexcept { val = Base::ToUint16Impl(v); }
339 float ToFloat() const noexcept {
return Base::ToFloatImpl(); }
345 using Base::IsNegative;
357 using Base::IsFinite;
363 using Base::IsPositiveInfinity;
369 using Base::IsNegativeInfinity;
375 using Base::IsInfinity;
381 using Base::IsNaNOrZero;
387 using Base::IsNormal;
393 using Base::IsSubnormal;
420 explicit operator float() const noexcept {
return ToFloat(); }
429static_assert(
sizeof(
BFloat16_t) ==
sizeof(uint16_t),
"Sizes must match");
440 constexpr operator uint8_t() const noexcept {
return value; }
446static_assert(
sizeof(Float8E4M3FN_t) ==
sizeof(uint8_t),
"Sizes must match");
457 constexpr operator uint8_t() const noexcept {
return value; }
463static_assert(
sizeof(Float8E4M3FNUZ_t) ==
sizeof(uint8_t),
"Sizes must match");
474 constexpr operator uint8_t() const noexcept {
return value; }
480static_assert(
sizeof(Float8E5M2_t) ==
sizeof(uint8_t),
"Sizes must match");
491 constexpr operator uint8_t() const noexcept {
return value; }
497static_assert(
sizeof(Float8E5M2FNUZ_t) ==
sizeof(uint8_t),
"Sizes must match");
502#define ORT_DEFINE_RELEASE(NAME) \
503 inline void OrtRelease(Ort##NAME* ptr) { GetApi().Release##NAME(ptr); }
524ORT_DEFINE_RELEASE(
Op);
527#undef ORT_DEFINE_RELEASE
636struct AllocatorWithDefaultOptions;
653 explicit Status(std::nullptr_t)
noexcept {}
656 explicit Status(
const std::exception&)
noexcept;
699 explicit Env(std::nullptr_t) {}
850 std::unordered_map<std::string, std::string> flat_configs_;
864struct ConstSessionOptionsImpl : Base<T> {
870 std::string GetConfigEntry(
const char* config_key)
const;
871 bool HasConfigEntry(
const char* config_key)
const;
872 std::string GetConfigEntryOrDefault(
const char* config_key,
const std::string& def);
876struct SessionOptionsImpl : ConstSessionOptionsImpl<T> {
877 using B = ConstSessionOptionsImpl<T>;
880 SessionOptionsImpl& SetIntraOpNumThreads(
int intra_op_num_threads);
881 SessionOptionsImpl& SetInterOpNumThreads(
int inter_op_num_threads);
883 SessionOptionsImpl& SetDeterministicCompute(
bool value);
885 SessionOptionsImpl& EnableCpuMemArena();
886 SessionOptionsImpl& DisableCpuMemArena();
888 SessionOptionsImpl& SetOptimizedModelFilePath(
const ORTCHAR_T* optimized_model_file);
890 SessionOptionsImpl& EnableProfiling(
const ORTCHAR_T* profile_file_prefix);
891 SessionOptionsImpl& DisableProfiling();
893 SessionOptionsImpl& EnableOrtCustomOps();
895 SessionOptionsImpl& EnableMemPattern();
896 SessionOptionsImpl& DisableMemPattern();
898 SessionOptionsImpl& SetExecutionMode(
ExecutionMode execution_mode);
900 SessionOptionsImpl& SetLogId(
const char* logid);
901 SessionOptionsImpl& SetLogSeverityLevel(
int level);
905 SessionOptionsImpl& DisablePerSessionThreads();
907 SessionOptionsImpl& AddConfigEntry(
const char* config_key,
const char* config_value);
909 SessionOptionsImpl& AddInitializer(
const char* name,
const OrtValue* ort_val);
910 SessionOptionsImpl& AddExternalInitializers(
const std::vector<std::string>& names,
const std::vector<Value>& ort_values);
911 SessionOptionsImpl& AddExternalInitializersFromFilesInMemory(
const std::vector<std::basic_string<ORTCHAR_T>>& external_initializer_file_names,
912 const std::vector<char*>& external_initializer_file_buffer_array,
913 const std::vector<size_t>& external_initializer_file_lengths);
920 SessionOptionsImpl& AppendExecutionProvider_OpenVINO_V2(
const std::unordered_map<std::string, std::string>& provider_options = {});
929 SessionOptionsImpl& AppendExecutionProvider(
const std::string& provider_name,
930 const std::unordered_map<std::string, std::string>& provider_options = {});
933 SessionOptionsImpl& SetCustomThreadCreationOptions(
void* ort_custom_thread_creation_options);
939 SessionOptionsImpl& RegisterCustomOpsLibrary(
const ORTCHAR_T* library_name,
const CustomOpConfigs& custom_op_configs = {});
941 SessionOptionsImpl& RegisterCustomOpsUsingFunction(
const char* function_name);
944 SessionOptionsImpl& AppendExecutionProvider_VitisAI(
const std::unordered_map<std::string, std::string>& provider_options = {});
1037template <
typename T>
1081template <
typename T>
1103 std::vector<Value>
Run(
const RunOptions& run_options,
const char*
const* input_names,
const Value* input_values,
size_t input_count,
1104 const char*
const* output_names,
size_t output_count);
1109 void Run(
const RunOptions& run_options,
const char*
const* input_names,
const Value* input_values,
size_t input_count,
1110 const char*
const* output_names,
Value* output_values,
size_t output_count);
1134 const char*
const* output_names,
Value* output_values,
size_t output_count,
RunAsyncCallbackFn callback,
void* user_data);
1167template <
typename T>
1178 template <
typename U>
1198template <
typename T>
1212 [[deprecated(
"use GetShape()")]]
void GetDimensions(int64_t* values,
size_t values_count)
const;
1233template <
typename T>
1254template <
typename T>
1267template <
typename T>
1289template <
typename T>
1345template <
typename T>
1353 template <
typename R>
1392 template <
typename R>
1449#if !defined(DISABLE_SPARSE_TENSORS)
1483 template <
typename R>
1500 template <
typename R>
1506template <
typename T>
1516 template <
typename R>
1532 template <
typename R>
1533 R&
At(
const std::vector<int64_t>& location);
1563#if !defined(DISABLE_SPARSE_TENSORS)
1584 void UseCsrIndices(int64_t* inner_data,
size_t inner_num, int64_t* outer_data,
size_t outer_num);
1606 const int64_t* indices_data,
size_t indices_num);
1621 const int64_t* inner_indices_data,
size_t inner_indices_num,
1622 const int64_t* outer_indices_data,
size_t outer_indices_num);
1635 const Shape& indices_shape,
1636 const int32_t* indices_data);
1670 template <
typename T>
1696 template <
typename T>
1739 template <
typename T>
1742#if !defined(DISABLE_SPARSE_TENSORS)
1753 template <
typename T>
1755 const Shape& values_shape);
1785 template <
typename T>
1818 void* get() {
return p_; }
1819 size_t size()
const {
return size_; }
1828template <
typename T>
1829struct AllocatorImpl : Base<T> {
1833 void* Alloc(
size_t size);
1834 MemoryAllocation GetAllocation(
size_t size);
1836 ConstMemoryInfo GetInfo()
const;
1860namespace binding_utils {
1866template <
typename T>
1877template <
typename T>
1920 ArenaCfg(
size_t max_mem,
int arena_extend_strategy,
int initial_chunk_size_bytes,
int max_dead_bytes_per_chunk);
1942#define ORT_CXX_LOG(logger, message_severity, message) \
1944 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1945 Ort::ThrowOnError(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
1946 static_cast<const char*>(__FUNCTION__), message)); \
1958#define ORT_CXX_LOG_NOEXCEPT(logger, message_severity, message) \
1960 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1961 static_cast<void>(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
1962 static_cast<const char*>(__FUNCTION__), message)); \
1977#define ORT_CXX_LOGF(logger, message_severity, ...) \
1979 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1980 Ort::ThrowOnError(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
1981 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
1996#define ORT_CXX_LOGF_NOEXCEPT(logger, message_severity, ...) \
1998 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1999 static_cast<void>(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
2000 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
2061 const
char* func_name, const
char* message) const noexcept;
2077 template <typename... Args>
2079 const
char* func_name, const
char* format, Args&&... args) const noexcept;
2107 void ParallelFor(
void (*fn)(
void*,
size_t),
size_t total,
size_t num_batch,
void* usr_data)
const;
2116namespace attr_utils {
2117void GetAttr(
const OrtKernelInfo* p,
const char* name,
float&);
2118void GetAttr(
const OrtKernelInfo* p,
const char* name, int64_t&);
2119void GetAttr(
const OrtKernelInfo* p,
const char* name, std::string&);
2120void GetAttrs(
const OrtKernelInfo* p,
const char* name, std::vector<float>&);
2121void GetAttrs(
const OrtKernelInfo* p,
const char* name, std::vector<int64_t>&);
2124template <
typename T>
2125struct KernelInfoImpl :
Base<T> {
2131 template <
typename R>
2132 R GetAttribute(
const char* name)
const {
2134 attr_utils::GetAttr(this->p_, name, val);
2138 template <
typename R>
2139 std::vector<R> GetAttributes(
const char* name)
const {
2140 std::vector<R> result;
2141 attr_utils::GetAttrs(this->p_, name, result);
2145 Value GetTensorAttribute(
const char* name,
OrtAllocator* allocator)
const;
2147 size_t GetInputCount()
const;
2148 size_t GetOutputCount()
const;
2150 std::string GetInputName(
size_t index)
const;
2151 std::string GetOutputName(
size_t index)
const;
2153 TypeInfo GetInputTypeInfo(
size_t index)
const;
2154 TypeInfo GetOutputTypeInfo(
size_t index)
const;
2156 ConstValue GetTensorConstantInput(
size_t index,
int* is_constant)
const;
2158 std::string GetNodeName()
const;
2159 Logger GetLogger()
const;
2182 explicit Op(std::nullptr_t) {}
2187 int version,
const char** type_constraint_names,
2189 size_t type_constraint_count,
2190 const OpAttr* attr_values,
2192 size_t input_count,
size_t output_count);
2195 const Value* input_values,
2197 Value* output_values,
2198 size_t output_count);
2202 const OrtValue*
const* input_values,
2205 size_t output_count);
2222 if (is_int_ == dim.is_int_) {
2224 return i_ == dim.
i_;
2226 return std::string{s_} == std::string{dim.
s_};
2234 const char*
AsSym()
const {
return s_; }
2236 static constexpr int INVALID_INT_DIM = -2;
2246 using Shape = std::vector<SymbolicInteger>;
2272 const OrtOpAttr* GetAttrHdl(
const char* attr_name)
const;
2275 std::vector<Shape> input_shapes_;
2280#define MAX_CUSTOM_OP_END_VER (1UL << 31) - 1
2282template <
typename TOp,
typename TKernel,
bool WithStatus = false>
2297#if defined(_MSC_VER) && !defined(__clang__)
2298#pragma warning(push)
2299#pragma warning(disable : 26409)
2302#if defined(_MSC_VER) && !defined(__clang__)
2312#ifdef __cpp_if_constexpr
2313 if constexpr (WithStatus) {
2318 return static_cast<const TOp*
>(this_)->CreateKernelV2(*api, info, op_kernel);
2321 return static_cast<TKernel*
>(op_kernel)->ComputeV2(context);
2329 static_cast<TKernel*
>(op_kernel)->Compute(context);
2333 SetShapeInferFn<TOp>(0);
2336 return static_cast<const TOp*
>(this_)->start_ver_;
2340 return static_cast<const TOp*
>(this_)->end_ver_;
2355 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
2359 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
2395 return std::vector<std::string>{};
2398 template <
typename C>
2402 return C::InferOutputShape(ctx);
2407 template <
typename C>
2417 int end_ver_ = MAX_CUSTOM_OP_END_VER;
2422#include "onnxruntime_cxx_inline.h"
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:282
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:369
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:237
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:393
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:306
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:334
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:717
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:4742
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:299
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:304
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:296
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:290
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:302
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:226
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:298
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:293
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:283
OrtAllocatorType
Definition onnxruntime_c_api.h:375
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:303
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:294
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:287
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:288
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:300
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:371
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:301
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:728
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:292
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:285
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:343
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:312
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:384
OrtSparseFormat
Definition onnxruntime_c_api.h:218
ONNXType
Definition onnxruntime_c_api.h:206
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:280
OrtErrorCode
Definition onnxruntime_c_api.h:245
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:281
#define ORT_API_VERSION
The API version defined in this header.
Definition onnxruntime_c_api.h:41
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:305
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:289
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:297
ExecutionMode
Definition onnxruntime_c_api.h:350
OrtOpAttrType
Definition onnxruntime_c_api.h:260
OrtCustomThreadHandle(* OrtCustomCreateThreadFn)(void *ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void *ort_worker_fn_param)
Ort custom thread creation function.
Definition onnxruntime_c_api.h:710
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:177
const OrtApiBase * OrtGetApiBase(void)
The Onnxruntime library's entry point to access the C API.
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:240
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:388
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:179
std::vector< Value > GetOutputValuesHelper(const OrtIoBinding *binding, OrtAllocator *)
std::vector< std::string > GetOutputNamesHelper(const OrtIoBinding *binding, OrtAllocator *)
void OrtRelease(OrtAllocator *ptr)
Definition onnxruntime_cxx_api.h:505
std::string MakeCustomOpConfigEntryKey(const char *custom_op_name, const char *config)
All C++ Onnxruntime APIs are defined inside this namespace.
Definition onnxruntime_cxx_api.h:47
std::unique_ptr< char, detail::AllocatedFree > AllocatedStringPtr
unique_ptr typedef used to own strings allocated by OrtAllocators and release them at the end of the ...
Definition onnxruntime_cxx_api.h:646
detail::ConstSessionOptionsImpl< detail::Unowned< const OrtSessionOptions > > ConstSessionOptions
Definition onnxruntime_cxx_api.h:949
detail::KernelInfoImpl< detail::Unowned< const OrtKernelInfo > > ConstKernelInfo
Definition onnxruntime_cxx_api.h:2164
const OrtApi & GetApi() noexcept
This returns a reference to the OrtApi interface in use.
Definition onnxruntime_cxx_api.h:124
detail::AllocatorImpl< detail::Unowned< OrtAllocator > > UnownedAllocator
Definition onnxruntime_cxx_api.h:1857
detail::SessionOptionsImpl< detail::Unowned< OrtSessionOptions > > UnownedSessionOptions
Definition onnxruntime_cxx_api.h:948
std::string GetBuildInfoString()
This function returns the onnxruntime build information: including git branch, git commit id,...
std::string GetVersionString()
This function returns the onnxruntime version string.
std::vector< std::string > GetAvailableProviders()
This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representin...
Ort::Status(*)(Ort::ShapeInferContext &) ShapeInferFn
Definition onnxruntime_cxx_api.h:2278
Wrapper around OrtAllocator.
Definition onnxruntime_cxx_api.h:1852
Allocator(const Session &session, const OrtMemoryInfo *)
Allocator(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1853
Wrapper around OrtAllocator default instance that is owned by Onnxruntime.
Definition onnxruntime_cxx_api.h:1844
AllocatorWithDefaultOptions(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1845
AllocatorWithDefaultOptions()
it is a structure that represents the configuration of an arena based allocator
Definition onnxruntime_cxx_api.h:1910
ArenaCfg(std::nullptr_t)
Create an empty ArenaCfg object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1911
ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk)
bfloat16 (Brain Floating Point) data type
Definition onnxruntime_cxx_api.h:306
bool operator==(const BFloat16_t &rhs) const noexcept
onnxruntime_float16::BFloat16Impl< BFloat16_t > Base
Definition onnxruntime_cxx_api.h:318
static constexpr BFloat16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of bfloat16.
Definition onnxruntime_cxx_api.h:327
bool operator!=(const BFloat16_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:425
BFloat16_t(float v) noexcept
__ctor from float. Float is converted into bfloat16 16-bit representation.
Definition onnxruntime_cxx_api.h:333
float ToFloat() const noexcept
Converts bfloat16 to float.
Definition onnxruntime_cxx_api.h:339
bool operator<(const BFloat16_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:2283
OrtCustomOpInputOutputCharacteristic GetOutputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:2358
OrtCustomOpInputOutputCharacteristic GetInputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:2354
OrtMemType GetInputMemoryType(size_t) const
Definition onnxruntime_cxx_api.h:2363
std::vector< std::string > GetSessionConfigKeys() const
Definition onnxruntime_cxx_api.h:2394
bool GetVariadicInputHomogeneity() const
Definition onnxruntime_cxx_api.h:2375
int GetVariadicInputMinArity() const
Definition onnxruntime_cxx_api.h:2369
void SetShapeInferFn(...)
Definition onnxruntime_cxx_api.h:2408
CustomOpBase()
Definition onnxruntime_cxx_api.h:2284
bool GetVariadicOutputHomogeneity() const
Definition onnxruntime_cxx_api.h:2387
int GetVariadicOutputMinArity() const
Definition onnxruntime_cxx_api.h:2381
decltype(&C::InferOutputShape) SetShapeInferFn(decltype(&C::InferOutputShape))
Definition onnxruntime_cxx_api.h:2399
const char * GetExecutionProviderType() const
Definition onnxruntime_cxx_api.h:2350
void GetSessionConfigs(std::unordered_map< std::string, std::string > &out, ConstSessionOptions options) const
Class that represents session configuration entries for one or more custom operators.
Definition onnxruntime_cxx_api.h:821
~CustomOpConfigs()=default
CustomOpConfigs & AddConfig(const char *custom_op_name, const char *config_key, const char *config_value)
Adds a session configuration entry/value for a specific custom operator.
CustomOpConfigs & operator=(CustomOpConfigs &&o)=default
CustomOpConfigs(CustomOpConfigs &&o)=default
CustomOpConfigs()=default
const std::unordered_map< std::string, std::string > & GetFlattenedConfigs() const
Returns a flattened map of custom operator configuration entries and their values.
CustomOpConfigs(const CustomOpConfigs &)=default
CustomOpConfigs & operator=(const CustomOpConfigs &)=default
Custom Op Domain.
Definition onnxruntime_cxx_api.h:730
CustomOpDomain(std::nullptr_t)
Create an empty CustomOpDomain object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:731
CustomOpDomain(const char *domain)
Wraps OrtApi::CreateCustomOpDomain.
void Add(const OrtCustomOp *op)
Wraps CustomOpDomain_Add.
The Env (Environment)
Definition onnxruntime_cxx_api.h:698
Env & EnableTelemetryEvents()
Wraps OrtApi::EnableTelemetryEvents.
Env(OrtEnv *p)
C Interop Helper.
Definition onnxruntime_cxx_api.h:715
Env & CreateAndRegisterAllocatorV2(const std::string &provider_type, const OrtMemoryInfo *mem_info, const std::unordered_map< std::string, std::string > &options, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocatorV2.
Env(std::nullptr_t)
Create an empty Env object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:699
Env(OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnv.
Env(const OrtThreadingOptions *tp_options, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnvWithGlobalThreadPools.
Env(const OrtThreadingOptions *tp_options, OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools.
Env(OrtLoggingLevel logging_level, const char *logid, OrtLoggingFunction logging_function, void *logger_param)
Wraps OrtApi::CreateEnvWithCustomLogger.
Env & CreateAndRegisterAllocator(const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocator.
Env & UpdateEnvWithCustomLogLevel(OrtLoggingLevel log_severity_level)
Wraps OrtApi::UpdateEnvWithCustomLogLevel.
Env & DisableTelemetryEvents()
Wraps OrtApi::DisableTelemetryEvents.
All C++ methods that can fail will throw an exception of this type.
Definition onnxruntime_cxx_api.h:53
const char * what() const noexcept override
Definition onnxruntime_cxx_api.h:57
OrtErrorCode GetOrtErrorCode() const
Definition onnxruntime_cxx_api.h:56
Exception(std::string &&string, OrtErrorCode code)
Definition onnxruntime_cxx_api.h:54
IEEE 754 half-precision floating point data type.
Definition onnxruntime_cxx_api.h:164
Float16_t()=default
Default constructor.
Float16_t(float v) noexcept
__ctor from float. Float is converted into float16 16-bit representation.
Definition onnxruntime_cxx_api.h:192
onnxruntime_float16::Float16Impl< Float16_t > Base
Definition onnxruntime_cxx_api.h:174
float ToFloat() const noexcept
Converts float16 to float.
Definition onnxruntime_cxx_api.h:198
static constexpr Float16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of float16.
Definition onnxruntime_cxx_api.h:186
float8e4m3fn (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:436
uint8_t value
Definition onnxruntime_cxx_api.h:437
constexpr Float8E4M3FN_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:439
constexpr bool operator==(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:442
constexpr Float8E4M3FN_t() noexcept
Definition onnxruntime_cxx_api.h:438
constexpr bool operator!=(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:443
float8e4m3fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:453
constexpr bool operator==(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:459
uint8_t value
Definition onnxruntime_cxx_api.h:454
constexpr Float8E4M3FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:455
constexpr bool operator!=(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:460
constexpr Float8E4M3FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:456
float8e5m2 (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:470
constexpr Float8E5M2_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:473
uint8_t value
Definition onnxruntime_cxx_api.h:471
constexpr bool operator!=(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:477
constexpr Float8E5M2_t() noexcept
Definition onnxruntime_cxx_api.h:472
constexpr bool operator==(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:476
float8e5m2fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:487
constexpr Float8E5M2FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:489
constexpr Float8E5M2FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:490
constexpr bool operator!=(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:494
constexpr bool operator==(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:493
uint8_t value
Definition onnxruntime_cxx_api.h:488
Definition onnxruntime_cxx_api.h:85
static const OrtApi * api_
Definition onnxruntime_cxx_api.h:86
Wrapper around OrtIoBinding.
Definition onnxruntime_cxx_api.h:1899
UnownedIoBinding GetUnowned() const
Definition onnxruntime_cxx_api.h:1903
ConstIoBinding GetConst() const
Definition onnxruntime_cxx_api.h:1902
IoBinding(Session &session)
IoBinding(std::nullptr_t)
Create an empty object for convenience. Sometimes, we want to initialize members later.
Definition onnxruntime_cxx_api.h:1900
This class wraps a raw pointer OrtKernelContext* that is being passed to the custom kernel Compute() ...
Definition onnxruntime_cxx_api.h:2092
KernelContext(OrtKernelContext *context)
ConstValue GetInput(size_t index) const
OrtKernelContext * GetOrtKernelContext() const
Definition onnxruntime_cxx_api.h:2106
void ParallelFor(void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data) const
OrtAllocator * GetAllocator(const OrtMemoryInfo &memory_info) const
void * GetGPUComputeStream() const
size_t GetInputCount() const
size_t GetOutputCount() const
UnownedValue GetOutput(size_t index, const std::vector< int64_t > &dims) const
UnownedValue GetOutput(size_t index, const int64_t *dim_values, size_t dim_count) const
This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelIn...
Definition onnxruntime_cxx_api.h:2172
KernelInfo(OrtKernelInfo *info)
Take ownership of the instance.
ConstKernelInfo GetConst() const
Definition onnxruntime_cxx_api.h:2175
KernelInfo(std::nullptr_t)
Create an empty instance to initialize later.
Definition onnxruntime_cxx_api.h:2173
This class represents an ONNX Runtime logger that can be used to log information with an associated s...
Definition onnxruntime_cxx_api.h:2014
Logger(Logger &&v) noexcept=default
Logger & operator=(Logger &&v) noexcept=default
Logger & operator=(const Logger &)=default
Logger(const Logger &)=default
Logger(std::nullptr_t)
Definition onnxruntime_cxx_api.h:2023
Logger(const OrtLogger *logger)
OrtLoggingLevel GetLoggingSeverityLevel() const noexcept
LoraAdapter holds a set of Lora Parameters loaded from a single file.
Definition onnxruntime_cxx_api.h:741
static LoraAdapter CreateLoraAdapter(const std::basic_string< char > &adapter_path, OrtAllocator *allocator)
Wraps OrtApi::CreateLoraAdapter.
LoraAdapter(std::nullptr_t)
Definition onnxruntime_cxx_api.h:745
static LoraAdapter CreateLoraAdapterFromArray(const void *bytes, size_t num_bytes, OrtAllocator *allocator)
Wraps OrtApi::CreateLoraAdapterFromArray.
Wrapper around OrtMapTypeInfo.
Definition onnxruntime_cxx_api.h:1282
ConstMapTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1285
MapTypeInfo(OrtMapTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1284
MapTypeInfo(std::nullptr_t)
Create an empty MapTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1283
Represents native memory allocation coming from one of the OrtAllocators registered with OnnxRuntime....
Definition onnxruntime_cxx_api.h:1810
MemoryAllocation(MemoryAllocation &&) noexcept
MemoryAllocation & operator=(const MemoryAllocation &)=delete
MemoryAllocation(const MemoryAllocation &)=delete
MemoryAllocation(OrtAllocator *allocator, void *p, size_t size)
size_t size() const
Definition onnxruntime_cxx_api.h:1819
Wrapper around OrtMemoryInfo.
Definition onnxruntime_cxx_api.h:1189
MemoryInfo(const char *name, OrtAllocatorType type, int id, OrtMemType mem_type)
MemoryInfo(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1191
MemoryInfo(OrtMemoryInfo *p)
Take ownership of a pointer created by C Api.
Definition onnxruntime_cxx_api.h:1192
static MemoryInfo CreateCpu(OrtAllocatorType type, OrtMemType mem_type1)
ConstMemoryInfo GetConst() const
Definition onnxruntime_cxx_api.h:1194
This struct provides life time management for custom op attribute.
Definition onnxruntime_cxx_api.h:1930
OpAttr(const char *name, const void *data, int len, OrtOpAttrType type)
Create and own custom defined operation.
Definition onnxruntime_cxx_api.h:2181
Op(OrtOp *)
Take ownership of the OrtOp.
static Op Create(const OrtKernelInfo *info, const char *op_name, const char *domain, int version, const char **type_constraint_names, const ONNXTensorElementDataType *type_constraint_values, size_t type_constraint_count, const OpAttr *attr_values, size_t attr_count, size_t input_count, size_t output_count)
Op(std::nullptr_t)
Create an empty Operator object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2182
void Invoke(const OrtKernelContext *context, const OrtValue *const *input_values, size_t input_count, OrtValue *const *output_values, size_t output_count)
void Invoke(const OrtKernelContext *context, const Value *input_values, size_t input_count, Value *output_values, size_t output_count)
RunOptions.
Definition onnxruntime_cxx_api.h:769
int GetRunLogSeverityLevel() const
Wraps OrtApi::RunOptionsGetRunLogSeverityLevel.
RunOptions & SetTerminate()
Terminates all currently executing Session::Run calls that were made using this RunOptions instance.
RunOptions & SetRunTag(const char *run_tag)
wraps OrtApi::RunOptionsSetRunTag
RunOptions & AddActiveLoraAdapter(const LoraAdapter &adapter)
Add the LoraAdapter to the list of active adapters. The setting does not affect RunWithBinding() call...
RunOptions & UnsetTerminate()
Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without ...
int GetRunLogVerbosityLevel() const
Wraps OrtApi::RunOptionsGetRunLogVerbosityLevel.
RunOptions(std::nullptr_t)
Create an empty RunOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:770
RunOptions & SetRunLogVerbosityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel.
RunOptions & SetRunLogSeverityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogSeverityLevel.
RunOptions & AddConfigEntry(const char *config_key, const char *config_value)
Wraps OrtApi::AddRunConfigEntry.
const char * GetRunTag() const
Wraps OrtApi::RunOptionsGetRunTag.
RunOptions()
Wraps OrtApi::CreateRunOptions.
Wrapper around OrtSequenceTypeInfo.
Definition onnxruntime_cxx_api.h:1247
SequenceTypeInfo(std::nullptr_t)
Create an empty SequenceTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1248
ConstSequenceTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1250
SequenceTypeInfo(OrtSequenceTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1249
Wrapper around OrtSession.
Definition onnxruntime_cxx_api.h:1153
Session(std::nullptr_t)
Create an empty Session object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1154
UnownedSession GetUnowned() const
Definition onnxruntime_cxx_api.h:1163
Session(const Env &env, const char *model_path, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Wraps OrtApi::CreateSessionWithPrepackedWeightsContainer.
Session(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Wraps OrtApi::CreateSessionFromArrayWithPrepackedWeightsContainer.
Session(const Env &env, const char *model_path, const SessionOptions &options)
Wraps OrtApi::CreateSession.
ConstSession GetConst() const
Definition onnxruntime_cxx_api.h:1162
Session(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options)
Wraps OrtApi::CreateSessionFromArray.
Wrapper around OrtSessionOptions.
Definition onnxruntime_cxx_api.h:954
SessionOptions(std::nullptr_t)
Create an empty SessionOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:955
UnownedSessionOptions GetUnowned() const
Definition onnxruntime_cxx_api.h:958
SessionOptions()
Wraps OrtApi::CreateSessionOptions.
ConstSessionOptions GetConst() const
Definition onnxruntime_cxx_api.h:959
SessionOptions(OrtSessionOptions *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:957
Definition onnxruntime_cxx_api.h:2212
SymbolicInteger & operator=(const SymbolicInteger &)=default
SymbolicInteger(const SymbolicInteger &)=default
int64_t AsInt() const
Definition onnxruntime_cxx_api.h:2233
int64_t i_
Definition onnxruntime_cxx_api.h:2240
const char * s_
Definition onnxruntime_cxx_api.h:2241
bool operator==(const SymbolicInteger &dim) const
Definition onnxruntime_cxx_api.h:2221
SymbolicInteger & operator=(SymbolicInteger &&)=default
SymbolicInteger(SymbolicInteger &&)=default
const char * AsSym() const
Definition onnxruntime_cxx_api.h:2234
SymbolicInteger(int64_t i)
Definition onnxruntime_cxx_api.h:2213
SymbolicInteger(const char *s)
Definition onnxruntime_cxx_api.h:2214
bool IsInt() const
Definition onnxruntime_cxx_api.h:2232
Provide access to per-node attributes and input shapes, so one could compute and set output shapes.
Definition onnxruntime_cxx_api.h:2211
Ints GetAttrInts(const char *attr_name)
Strings GetAttrStrings(const char *attr_name)
Status SetOutputShape(size_t indice, const Shape &shape, ONNXTensorElementDataType type=ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT)
std::vector< SymbolicInteger > Shape
Definition onnxruntime_cxx_api.h:2246
std::vector< float > Floats
Definition onnxruntime_cxx_api.h:2263
std::string GetAttrString(const char *attr_name)
std::vector< int64_t > Ints
Definition onnxruntime_cxx_api.h:2258
ShapeInferContext(const OrtApi *ort_api, OrtShapeInferContext *ctx)
int64_t GetAttrInt(const char *attr_name)
size_t GetInputCount() const
Definition onnxruntime_cxx_api.h:2252
std::vector< std::string > Strings
Definition onnxruntime_cxx_api.h:2268
Floats GetAttrFloats(const char *attr_name)
const Shape & GetInputShape(size_t indice) const
Definition onnxruntime_cxx_api.h:2250
float GetAttrFloat(const char *attr_name)
The Status that holds ownership of OrtStatus received from C API Use it to safely destroy OrtStatus* ...
Definition onnxruntime_cxx_api.h:652
OrtErrorCode GetErrorCode() const
Status(const char *message, OrtErrorCode code) noexcept
Creates status instance out of null-terminated string message.
bool IsOK() const noexcept
Returns true if instance represents an OK (non-error) status.
Status(OrtStatus *status) noexcept
Takes ownership of OrtStatus instance returned from the C API.
std::string GetErrorMessage() const
Status(const Exception &) noexcept
Creates status instance out of exception.
Status(const std::exception &) noexcept
Creates status instance out of exception.
Status(std::nullptr_t) noexcept
Create an empty object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:653
Wrapper around OrtTensorTypeAndShapeInfo.
Definition onnxruntime_cxx_api.h:1226
TensorTypeAndShapeInfo(std::nullptr_t)
Create an empty TensorTypeAndShapeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1227
ConstTensorTypeAndShapeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1229
TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1228
The ThreadingOptions.
Definition onnxruntime_cxx_api.h:667
ThreadingOptions & SetGlobalCustomThreadCreationOptions(void *ort_custom_thread_creation_options)
Wraps OrtApi::SetGlobalCustomThreadCreationOptions.
ThreadingOptions()
Wraps OrtApi::CreateThreadingOptions.
ThreadingOptions & SetGlobalInterOpNumThreads(int inter_op_num_threads)
Wraps OrtApi::SetGlobalInterOpNumThreads.
ThreadingOptions & SetGlobalCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn)
Wraps OrtApi::SetGlobalCustomCreateThreadFn.
ThreadingOptions & SetGlobalCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn)
Wraps OrtApi::SetGlobalCustomJoinThreadFn.
ThreadingOptions & SetGlobalSpinControl(int allow_spinning)
Wraps OrtApi::SetGlobalSpinControl.
ThreadingOptions & SetGlobalDenormalAsZero()
Wraps OrtApi::SetGlobalDenormalAsZero.
ThreadingOptions & SetGlobalIntraOpNumThreads(int intra_op_num_threads)
Wraps OrtApi::SetGlobalIntraOpNumThreads.
Type information that may contain either TensorTypeAndShapeInfo or the information about contained se...
Definition onnxruntime_cxx_api.h:1313
TypeInfo(std::nullptr_t)
Create an empty TypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1314
ConstTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1317
TypeInfo(OrtTypeInfo *p)
C API Interop.
Definition onnxruntime_cxx_api.h:1315
Wrapper around OrtValue.
Definition onnxruntime_cxx_api.h:1649
static Value CreateSparseTensor(const OrtMemoryInfo *info, void *p_data, const Shape &dense_shape, const Shape &values_shape, ONNXTensorElementDataType type)
Creates an OrtValue instance containing SparseTensor. This constructs a sparse tensor that makes use ...
static Value CreateSparseTensor(const OrtMemoryInfo *info, T *p_data, const Shape &dense_shape, const Shape &values_shape)
This is a simple forwarding method to the other overload that helps deducing data type enum value fro...
Value & operator=(Value &&)=default
static Value CreateSparseTensor(OrtAllocator *allocator, const Shape &dense_shape, ONNXTensorElementDataType type)
Creates an instance of OrtValue containing sparse tensor. The created instance has no data....
Value(std::nullptr_t)
Create an empty Value object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1654
static Value CreateTensor(const OrtMemoryInfo *info, T *p_data, size_t p_data_element_count, const int64_t *shape, size_t shape_len)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
Value(OrtValue *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1655
static Value CreateSparseTensor(OrtAllocator *allocator, const Shape &dense_shape)
This is a simple forwarding method to the below CreateSparseTensor. This helps to specify data type e...
static Value CreateTensor(OrtAllocator *allocator, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type)
Creates an OrtValue with a tensor using the supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtVal...
UnownedValue GetUnowned() const
Definition onnxruntime_cxx_api.h:1660
static Value CreateSequence(const std::vector< Value > &values)
Creates an OrtValue with a Sequence Onnx type representation. The API would ref-count the supplied Or...
static Value CreateMap(const Value &keys, const Value &values)
Creates an OrtValue with a Map Onnx type representation. The API would ref-count the supplied OrtValu...
static Value CreateTensor(const OrtMemoryInfo *info, void *p_data, size_t p_data_byte_count, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
static Value CreateTensor(OrtAllocator *allocator, const int64_t *shape, size_t shape_len)
Creates an OrtValue with a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue...
static Value CreateOpaque(const char *domain, const char *type_name, const T &value)
Creates an OrtValue wrapping an Opaque type. This is used for experimental support of non-tensor type...
ConstValue GetConst() const
Definition onnxruntime_cxx_api.h:1659
Definition onnxruntime_cxx_api.h:625
AllocatedFree(OrtAllocator *allocator)
Definition onnxruntime_cxx_api.h:627
OrtAllocator * allocator_
Definition onnxruntime_cxx_api.h:626
void operator()(void *ptr) const
Definition onnxruntime_cxx_api.h:629
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:612
typename Unowned< T >::Type contained_type
Definition onnxruntime_cxx_api.h:601
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:611
Base(const Base &)=default
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:604
Base & operator=(const Base &)=default
Used internally by the C++ API. C++ wrapper types inherit from this. This is a zero cost abstraction ...
Definition onnxruntime_cxx_api.h:557
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:567
contained_type * release()
Relinquishes ownership of the contained C object pointer The underlying object is not destroyed.
Definition onnxruntime_cxx_api.h:578
Base(const Base &)=delete
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:561
Base & operator=(const Base &)=delete
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:568
contained_type * p_
Definition onnxruntime_cxx_api.h:585
~Base()
Definition onnxruntime_cxx_api.h:562
T contained_type
Definition onnxruntime_cxx_api.h:558
Definition onnxruntime_cxx_api.h:1867
std::vector< Value > GetOutputValues(OrtAllocator *) const
std::vector< std::string > GetOutputNames(OrtAllocator *) const
std::vector< Value > GetOutputValues() const
std::vector< std::string > GetOutputNames() const
Definition onnxruntime_cxx_api.h:1038
TypeInfo GetInputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetInputTypeInfo.
size_t GetOutputCount() const
Returns the number of model outputs.
uint64_t GetProfilingStartTimeNs() const
Wraps OrtApi::SessionGetProfilingStartTimeNs.
ModelMetadata GetModelMetadata() const
Wraps OrtApi::SessionGetModelMetadata.
size_t GetInputCount() const
Returns the number of model inputs.
TypeInfo GetOutputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOutputTypeInfo.
AllocatedStringPtr GetOverridableInitializerNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of the overridable initializer name at then specified index.
AllocatedStringPtr GetOutputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of output name at then specified index.
size_t GetOverridableInitializerCount() const
Returns the number of inputs that have defaults that can be overridden.
AllocatedStringPtr GetInputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of input name at the specified index.
TypeInfo GetOverridableInitializerTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOverridableInitializerTypeInfo.
Definition onnxruntime_cxx_api.h:1346
void GetStringTensorContent(void *buffer, size_t buffer_length, size_t *offsets, size_t offsets_count) const
The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor into...
void GetStringTensorElement(size_t buffer_length, size_t element_index, void *buffer) const
The API copies UTF-8 encoded bytes for the requested string element contained within a tensor or a sp...
TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat format) const
The API returns type and shape information for the specified indices. Each supported indices have the...
const void * GetTensorRawData() const
Returns a non-typed pointer to a tensor contained data.
std::string GetStringTensorElement(size_t element_index) const
Returns string tensor UTF-8 encoded string element. Use of this API is recommended over GetStringTens...
size_t GetStringTensorElementLength(size_t element_index) const
The API returns a byte length of UTF-8 encoded string element contained in either a tensor or a spare...
size_t GetStringTensorDataLength() const
This API returns a full length of string data contained within either a tensor or a sparse Tensor....
bool IsSparseTensor() const
Returns true if the OrtValue contains a sparse tensor.
TypeInfo GetTypeInfo() const
The API returns type information for data contained in a tensor. For sparse tensors it returns type i...
const R * GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t &num_indices) const
The API retrieves a pointer to the internal indices buffer. The API merely performs a convenience dat...
bool IsTensor() const
Returns true if Value is a tensor, false for other types like map/sequence/etc.
ConstMemoryInfo GetTensorMemoryInfo() const
This API returns information about the memory allocation used to hold data.
const R * GetSparseTensorValues() const
The API returns a pointer to an internal buffer of the sparse tensor containing non-zero values....
TensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const
The API returns type information for data contained in a tensor. For sparse tensors it returns type i...
Value GetValue(int index, OrtAllocator *allocator) const
size_t GetCount() const
< Return true if OrtValue contains data and returns false if the OrtValue is a None
void GetOpaqueData(const char *domain, const char *type_name, R &) const
Obtains a pointer to a user defined data for experimental purposes.
TensorTypeAndShapeInfo GetSparseTensorValuesTypeAndShapeInfo() const
The API returns type and shape information for stored non-zero values of the sparse tensor....
const R * GetTensorData() const
Returns a const typed pointer to the tensor contained data. No type checking is performed,...
OrtSparseFormat GetSparseFormat() const
The API returns the sparse data format this OrtValue holds in a sparse tensor. If the sparse tensor w...
Definition onnxruntime_cxx_api.h:1878
void BindOutput(const char *name, const Value &)
void BindInput(const char *name, const Value &)
void SynchronizeOutputs()
void BindOutput(const char *name, const OrtMemoryInfo *)
Definition onnxruntime_cxx_api.h:1268
ONNXTensorElementDataType GetMapKeyType() const
Wraps OrtApi::GetMapKeyType.
TypeInfo GetMapValueType() const
Wraps OrtApi::GetMapValueType.
Definition onnxruntime_cxx_api.h:1168
std::string GetAllocatorName() const
OrtMemType GetMemoryType() const
OrtMemoryInfoDeviceType GetDeviceType() const
OrtAllocatorType GetAllocatorType() const
bool operator==(const MemoryInfoImpl< U > &o) const
Definition onnxruntime_cxx_api.h:1255
TypeInfo GetOptionalElementType() const
Wraps OrtApi::CastOptionalTypeToContainedTypeInfo.
Definition onnxruntime_cxx_api.h:1329
const char ** str
Definition onnxruntime_cxx_api.h:1334
const int64_t * values_shape
Definition onnxruntime_cxx_api.h:1330
size_t values_shape_len
Definition onnxruntime_cxx_api.h:1331
const void * p_data
Definition onnxruntime_cxx_api.h:1333
Definition onnxruntime_cxx_api.h:1234
TypeInfo GetSequenceElementType() const
Wraps OrtApi::GetSequenceElementType.
Definition onnxruntime_cxx_api.h:1082
AllocatedStringPtr EndProfilingAllocated(OrtAllocator *allocator)
End profiling and return a copy of the profiling file name.
void Run(const RunOptions &run_options, const IoBinding &)
Wraps OrtApi::RunWithBinding.
void RunAsync(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, Value *output_values, size_t output_count, RunAsyncCallbackFn callback, void *user_data)
Run the model asynchronously in a thread owned by intra op thread pool.
std::vector< Value > Run(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, size_t output_count)
Run the model returning results in an Ort allocated vector.
void Run(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, Value *output_values, size_t output_count)
Run the model returning results in user provided outputs Same as Run(const RunOptions&,...
Definition onnxruntime_cxx_api.h:1340
const int64_t * shape
Definition onnxruntime_cxx_api.h:1341
size_t shape_len
Definition onnxruntime_cxx_api.h:1342
Definition onnxruntime_cxx_api.h:1199
size_t GetElementCount() const
Wraps OrtApi::GetTensorShapeElementCount.
void GetDimensions(int64_t *values, size_t values_count) const
Wraps OrtApi::GetDimensions.
std::vector< int64_t > GetShape() const
Uses GetDimensionsCount & GetDimensions to return a std::vector of the shape.
void GetSymbolicDimensions(const char **values, size_t values_count) const
Wraps OrtApi::GetSymbolicDimensions.
size_t GetDimensionsCount() const
Wraps OrtApi::GetDimensionsCount.
ONNXTensorElementDataType GetElementType() const
Wraps OrtApi::GetTensorElementType.
Definition onnxruntime_cxx_api.h:1290
ONNXType GetONNXType() const
ConstSequenceTypeInfo GetSequenceTypeInfo() const
Wraps OrtApi::CastTypeInfoToSequenceTypeInfo.
ConstMapTypeInfo GetMapTypeInfo() const
Wraps OrtApi::CastTypeInfoToMapTypeInfo.
ConstOptionalTypeInfo GetOptionalTypeInfo() const
wraps OrtApi::CastTypeInfoToOptionalTypeInfo
ConstTensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const
Wraps OrtApi::CastTypeInfoToTensorInfo.
This is a tagging template type. Use it with Base<T> to indicate that the C++ interface object has no...
Definition onnxruntime_cxx_api.h:533
T Type
Definition onnxruntime_cxx_api.h:534
Definition onnxruntime_cxx_api.h:1507
void FillStringTensorElement(const char *s, size_t index)
Set a single string in a string tensor.
R * GetTensorMutableData()
Returns a non-const typed pointer to an OrtValue/Tensor contained buffer No type checking is performe...
R & At(const std::vector< int64_t > &location)
void UseBlockSparseIndices(const Shape &indices_shape, int32_t *indices_data)
Supplies BlockSparse format specific indices and marks the contained sparse tensor as being a BlockSp...
void FillSparseTensorBlockSparse(const OrtMemoryInfo *data_mem_info, const OrtSparseValuesParam &values, const Shape &indices_shape, const int32_t *indices_data)
The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API an...
void * GetTensorMutableRawData()
Returns a non-typed non-const pointer to a tensor contained data.
void UseCooIndices(int64_t *indices_data, size_t indices_num)
Supplies COO format specific indices and marks the contained sparse tensor as being a COO format tens...
void FillSparseTensorCoo(const OrtMemoryInfo *data_mem_info, const OrtSparseValuesParam &values_param, const int64_t *indices_data, size_t indices_num)
The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API an...
void FillStringTensor(const char *const *s, size_t s_len)
Set all strings at once in a string tensor.
void UseCsrIndices(int64_t *inner_data, size_t inner_num, int64_t *outer_data, size_t outer_num)
Supplies CSR format specific indices and marks the contained sparse tensor as being a CSR format tens...
void FillSparseTensorCsr(const OrtMemoryInfo *data_mem_info, const OrtSparseValuesParam &values, const int64_t *inner_indices_data, size_t inner_indices_num, const int64_t *outer_indices_data, size_t outer_indices_num)
The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API an...
char * GetResizedStringTensorElementBuffer(size_t index, size_t buffer_length)
Allocate if necessary and obtain a pointer to a UTF-8 encoded string element buffer indexed by the fl...
Memory allocation interface.
Definition onnxruntime_c_api.h:321
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:324
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:677
The C API.
Definition onnxruntime_c_api.h:737
CUDA Provider Options.
Definition onnxruntime_c_api.h:411
Definition onnxruntime_c_api.h:4752
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4798
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4782
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4770
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4802
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:4835
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4820
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:4832
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4763
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4772
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:4778
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4807
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4789
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:4759
uint32_t version
Definition onnxruntime_c_api.h:4753
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4769
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:4836
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4781
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4766
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4771
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4793
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:4817
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4821
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:4810
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:4828
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4815
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4777
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:615
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:632
ROCM Provider Options.
Definition onnxruntime_c_api.h:498
TensorRT Provider Options.
Definition onnxruntime_c_api.h:587