HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Ort Namespace Reference

All C++ Onnxruntime APIs are defined inside this namespace. More...

Namespaces

 Custom
 
 detail
 
 Experimental
 

Classes

struct  Exception
 All C++ methods that can fail will throw an exception of this type. More...
 
struct  Global
 
struct  Float16_t
 IEEE 754 half-precision floating point data type. More...
 
struct  BFloat16_t
 bfloat16 (Brain Floating Point) data type More...
 
struct  Float8E4M3FN_t
 float8e4m3fn (Float8 Floating Point) data type More...
 
struct  Float8E4M3FNUZ_t
 float8e4m3fnuz (Float8 Floating Point) data type More...
 
struct  Float8E5M2_t
 float8e5m2 (Float8 Floating Point) data type More...
 
struct  Float8E5M2FNUZ_t
 float8e5m2fnuz (Float8 Floating Point) data type More...
 
struct  Status
 The Status that holds ownership of OrtStatus received from C API Use it to safely destroy OrtStatus* returned from the C API. Use appropriate constructors to construct an instance of a Status object from exceptions. More...
 
struct  ThreadingOptions
 The ThreadingOptions. More...
 
struct  Env
 The Env (Environment) More...
 
struct  CustomOpDomain
 Custom Op Domain. More...
 
struct  RunOptions
 RunOptions. More...
 
struct  CustomOpConfigs
 Class that represents session configuration entries for one or more custom operators. More...
 
struct  SessionOptions
 Wrapper around ::OrtSessionOptions. More...
 
struct  ModelMetadata
 Wrapper around ::OrtModelMetadata. More...
 
struct  Session
 Wrapper around ::OrtSession. More...
 
struct  MemoryInfo
 Wrapper around OrtMemoryInfo. More...
 
struct  TensorTypeAndShapeInfo
 Wrapper around ::OrtTensorTypeAndShapeInfo. More...
 
struct  SequenceTypeInfo
 Wrapper around ::OrtSequenceTypeInfo. More...
 
struct  MapTypeInfo
 Wrapper around ::OrtMapTypeInfo. More...
 
struct  TypeInfo
 Type information that may contain either TensorTypeAndShapeInfo or the information about contained sequence or map depending on the ONNXType. More...
 
struct  Value
 Wrapper around OrtValue. More...
 
struct  MemoryAllocation
 Represents native memory allocation coming from one of the OrtAllocators registered with OnnxRuntime. Use it to wrap an allocation made by an allocator so it can be automatically released when no longer needed. More...
 
struct  AllocatorWithDefaultOptions
 Wrapper around ::OrtAllocator default instance that is owned by Onnxruntime. More...
 
struct  Allocator
 Wrapper around ::OrtAllocator. More...
 
struct  IoBinding
 Wrapper around ::OrtIoBinding. More...
 
struct  ArenaCfg
 it is a structure that represents the configuration of an arena based allocator More...
 
struct  OpAttr
 This struct provides life time management for custom op attribute More...
 
struct  Logger
 This class represents an ONNX Runtime logger that can be used to log information with an associated severity level and source code location (file path, line number, function name). More...
 
struct  KernelContext
 This class wraps a raw pointer OrtKernelContext* that is being passed to the custom kernel Compute() method. Use it to safely access context attributes, input and output parameters with exception safety guarantees. See usage example in onnxruntime/test/testdata/custom_op_library/custom_op_library.cc More...
 
struct  KernelInfo
 This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelInfo* passed to kernel constructor and query attributes, warp the pointer with Ort::Unowned<KernelInfo> instance so it does not destroy the pointer the kernel does not own. More...
 
struct  Op
 Create and own custom defined operation. More...
 
struct  ShapeInferContext
 Provide access to per-node attributes and input shapes, so one could compute and set output shapes. More...
 
struct  CustomOpBase
 
struct  TypeToTensorType< float >
 
struct  TypeToTensorType< Float16_t >
 
struct  TypeToTensorType< BFloat16_t >
 
struct  TypeToTensorType< double >
 
struct  TypeToTensorType< int8_t >
 
struct  TypeToTensorType< int16_t >
 
struct  TypeToTensorType< int32_t >
 
struct  TypeToTensorType< int64_t >
 
struct  TypeToTensorType< uint8_t >
 
struct  TypeToTensorType< uint16_t >
 
struct  TypeToTensorType< uint32_t >
 
struct  TypeToTensorType< uint64_t >
 
struct  TypeToTensorType< bool >
 
struct  TypeToTensorType< Float8E4M3FN_t >
 
struct  TypeToTensorType< Float8E4M3FNUZ_t >
 
struct  TypeToTensorType< Float8E5M2_t >
 
struct  TypeToTensorType< Float8E5M2FNUZ_t >
 

Typedefs

using AllocatedStringPtr = std::unique_ptr< char, detail::AllocatedFree >
 unique_ptr typedef used to own strings allocated by OrtAllocators and release them at the end of the scope. The lifespan of the given allocator must eclipse the lifespan of AllocatedStringPtr instance More...
 
using UnownedSessionOptions = detail::SessionOptionsImpl< detail::Unowned< OrtSessionOptions >>
 
using ConstSessionOptions = detail::ConstSessionOptionsImpl< detail::Unowned< const OrtSessionOptions >>
 
using ConstSession = detail::ConstSessionImpl< detail::Unowned< const OrtSession >>
 
using UnownedSession = detail::SessionImpl< detail::Unowned< OrtSession >>
 
using ConstMemoryInfo = detail::MemoryInfoImpl< detail::Unowned< const OrtMemoryInfo >>
 
using ConstTensorTypeAndShapeInfo = detail::TensorTypeAndShapeInfoImpl< detail::Unowned< const OrtTensorTypeAndShapeInfo >>
 
using ConstSequenceTypeInfo = detail::SequenceTypeInfoImpl< detail::Unowned< const OrtSequenceTypeInfo >>
 
using ConstOptionalTypeInfo = detail::OptionalTypeInfoImpl< detail::Unowned< const OrtOptionalTypeInfo >>
 
using ConstMapTypeInfo = detail::MapTypeInfoImpl< detail::Unowned< const OrtMapTypeInfo >>
 
using ConstTypeInfo = detail::TypeInfoImpl< detail::Unowned< const OrtTypeInfo >>
 Contains a constant, unowned OrtTypeInfo that can be copied and passed around by value. Provides access to const OrtTypeInfo APIs. More...
 
using ConstValue = detail::ConstValueImpl< detail::Unowned< const OrtValue >>
 
using UnownedValue = detail::ValueImpl< detail::Unowned< OrtValue >>
 
using UnownedAllocator = detail::AllocatorImpl< detail::Unowned< OrtAllocator >>
 
using ConstIoBinding = detail::ConstIoBindingImpl< detail::Unowned< const OrtIoBinding >>
 
using UnownedIoBinding = detail::IoBindingImpl< detail::Unowned< OrtIoBinding >>
 
using ConstKernelInfo = detail::KernelInfoImpl< detail::Unowned< const OrtKernelInfo >>
 
using ShapeInferFn = Ort::Status(*)(Ort::ShapeInferContext &)
 

Functions

const OrtApi & GetApi () noexcept
 This returns a reference to the OrtApi interface in use. More...
 
std::string GetVersionString ()
 This function returns the onnxruntime version string More...
 
std::string GetBuildInfoString ()
 This function returns the onnxruntime build information: including git branch, git commit id, build type(Debug/Release/RelWithDebInfo) and cmake cpp flags. More...
 
std::vector< std::stringGetAvailableProviders ()
 This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representing the available execution providers. More...
 
void ThrowOnError (OrtStatus *ort_status)
 
void ThrowOnError (const Status &st)
 
 ctx_ (ctx)
 

Detailed Description

All C++ Onnxruntime APIs are defined inside this namespace.

Typedef Documentation

using Ort::AllocatedStringPtr = typedef std::unique_ptr<char, detail::AllocatedFree>

unique_ptr typedef used to own strings allocated by OrtAllocators and release them at the end of the scope. The lifespan of the given allocator must eclipse the lifespan of AllocatedStringPtr instance

Definition at line 645 of file onnxruntime_cxx_api.h.

using Ort::ConstIoBinding = typedef detail::ConstIoBindingImpl<detail::Unowned<const OrtIoBinding>>

Definition at line 1852 of file onnxruntime_cxx_api.h.

using Ort::ConstKernelInfo = typedef detail::KernelInfoImpl<detail::Unowned<const OrtKernelInfo>>

Definition at line 2119 of file onnxruntime_cxx_api.h.

using Ort::ConstMapTypeInfo = typedef detail::MapTypeInfoImpl<detail::Unowned<const OrtMapTypeInfo>>

Definition at line 1236 of file onnxruntime_cxx_api.h.

using Ort::ConstOptionalTypeInfo = typedef detail::OptionalTypeInfoImpl<detail::Unowned<const OrtOptionalTypeInfo>>

Definition at line 1223 of file onnxruntime_cxx_api.h.

using Ort::ConstSequenceTypeInfo = typedef detail::SequenceTypeInfoImpl<detail::Unowned<const OrtSequenceTypeInfo>>

Definition at line 1201 of file onnxruntime_cxx_api.h.

using Ort::ConstSession = typedef detail::ConstSessionImpl<detail::Unowned<const OrtSession>>

Definition at line 1106 of file onnxruntime_cxx_api.h.

Definition at line 908 of file onnxruntime_cxx_api.h.

using Ort::ConstTensorTypeAndShapeInfo = typedef detail::TensorTypeAndShapeInfoImpl<detail::Unowned<const OrtTensorTypeAndShapeInfo>>

Definition at line 1180 of file onnxruntime_cxx_api.h.

using Ort::ConstTypeInfo = typedef detail::TypeInfoImpl<detail::Unowned<const OrtTypeInfo>>

Contains a constant, unowned OrtTypeInfo that can be copied and passed around by value. Provides access to const OrtTypeInfo APIs.

Definition at line 1266 of file onnxruntime_cxx_api.h.

Definition at line 1602 of file onnxruntime_cxx_api.h.

Definition at line 2233 of file onnxruntime_cxx_api.h.

Definition at line 1816 of file onnxruntime_cxx_api.h.

Definition at line 1853 of file onnxruntime_cxx_api.h.

Definition at line 1107 of file onnxruntime_cxx_api.h.

Definition at line 907 of file onnxruntime_cxx_api.h.

Function Documentation

Ort::ctx_ ( ctx  )

Definition at line 1926 of file onnxruntime_cxx_inline.h.

const OrtApi& Ort::GetApi ( )
inlinenoexcept

This returns a reference to the OrtApi interface in use.

Definition at line 124 of file onnxruntime_cxx_api.h.

std::vector<std::string> Ort::GetAvailableProviders ( )

This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representing the available execution providers.

Returns
vector of strings
std::string Ort::GetBuildInfoString ( )

This function returns the onnxruntime build information: including git branch, git commit id, build type(Debug/Release/RelWithDebInfo) and cmake cpp flags.

Returns
string
std::string Ort::GetVersionString ( )

This function returns the onnxruntime version string

Returns
version string major.minor.rev
void Ort::ThrowOnError ( OrtStatus *  ort_status)
inline

Definition at line 31 of file onnxruntime_cxx_inline.h.

void Ort::ThrowOnError ( const Status &  st)
inline

Definition at line 38 of file onnxruntime_cxx_inline.h.