ONNX Runtime
Loading...
Searching...
No Matches
onnxruntime_cxx_api.h
1// Copyright (c) Microsoft Corporation. All rights reserved.
2// Licensed under the MIT License.
3
4// Summary: The Ort C++ API is a header only wrapper around the Ort C API.
5//
6// The C++ API simplifies usage by returning values directly instead of error codes, throwing exceptions on errors
7// and automatically releasing resources in the destructors. The primary purpose of C++ API is exception safety so
8// all the resources follow RAII and do not leak memory.
9//
10// Each of the C++ wrapper classes holds only a pointer to the C internal object. Treat them like smart pointers.
11// To create an empty object, pass 'nullptr' to the constructor (for example, Env e{nullptr};). However, you can't use them
12// until you assign an instance that actually holds an underlying object.
13//
14// For Ort objects only move assignment between objects is allowed, there are no copy constructors.
15// Some objects have explicit 'Clone' methods for this purpose.
16//
17// ConstXXXX types are copyable since they do not own the underlying C object, so you can pass them to functions as arguments
18// by value or by reference. ConstXXXX types are restricted to const only interfaces.
19//
20// UnownedXXXX are similar to ConstXXXX but also allow non-const interfaces.
21//
22// The lifetime of the corresponding owning object must eclipse the lifetimes of the ConstXXXX/UnownedXXXX types. They exists so you do not
23// have to fallback to C types and the API with the usual pitfalls. In general, do not use C API from your C++ code.
24
25#pragma once
26#include "onnxruntime_c_api.h"
27#include "onnxruntime_float16.h"
28
29#include <array>
30#include <cstddef>
31#include <cstdio>
32#include <memory>
33#include <stdexcept>
34#include <string>
35#include <type_traits>
36#include <unordered_map>
37#include <utility>
38#include <variant>
39#include <vector>
40
41#ifdef ORT_NO_EXCEPTIONS
42#include <iostream>
43#endif
44
48namespace Ort {
49
54struct Exception : std::exception {
55 Exception(const std::string& string, OrtErrorCode code) : message_{string}, code_{code} {}
56 Exception(std::string&& string, OrtErrorCode code) : message_{std::move(string)}, code_{code} {}
57
58 OrtErrorCode GetOrtErrorCode() const { return code_; }
59 const char* what() const noexcept override { return message_.c_str(); }
60
61 private:
62 std::string message_;
63 OrtErrorCode code_;
64};
65
66#ifdef ORT_NO_EXCEPTIONS
67// The #ifndef is for the very special case where the user of this library wants to define their own way of handling errors.
68// NOTE: This header expects control flow to not continue after calling ORT_CXX_API_THROW
69#ifndef ORT_CXX_API_THROW
70#define ORT_CXX_API_THROW(string, code) \
71 do { \
72 std::cerr << Ort::Exception(string, code) \
73 .what() \
74 << std::endl; \
75 abort(); \
76 } while (false)
77#endif
78#else
79#define ORT_CXX_API_THROW(string, code) \
80 throw Ort::Exception(string, code)
81#endif
82
83#ifdef ORT_API_MANUAL_INIT
84// If the macro ORT_API_MANUAL_INIT is defined, no static initialization
85// will be performed. Instead, users must call InitApi() before using the
86// ORT C++ APIs..
87//
88// InitApi() sets the global API object using the default initialization
89// logic. Users call this to initialize the ORT C++ APIs at a time that
90// makes sense in their program.
91inline void InitApi() noexcept;
92
93// InitApi(const OrtApi*) is used by custom operator libraries that are not
94// linked to onnxruntime. It sets the global API object, which is required
95// by the ORT C++ APIs.
96//
97// Example mycustomop.cc:
98//
99// #define ORT_API_MANUAL_INIT
100// #include <onnxruntime_cxx_api.h>
101// #undef ORT_API_MANUAL_INIT
102//
103// OrtStatus* ORT_API_CALL RegisterCustomOps(OrtSessionOptions* options, const OrtApiBase* api_base) {
104// Ort::InitApi(api_base->GetApi(ORT_API_VERSION));
105// // ...
106// }
107//
108inline void InitApi(const OrtApi* api) noexcept;
109#endif
110
111namespace detail {
112// This is used internally by the C++ API. This class holds the global
113// variable that points to the OrtApi.
114struct Global {
115 static const OrtApi* Api(const OrtApi* newValue = nullptr) noexcept {
116 // This block-level static will be initialized once when this function is
117 // first executed, delaying the call to DefaultInit() until it is first needed.
118 //
119 // When ORT_API_MANUAL_INIT is not defined, DefaultInit() calls
120 // OrtGetApiBase()->GetApi(), which may result in a shared library being
121 // loaded.
122 //
123 // Using a block-level static instead of a class-level static helps
124 // avoid issues with static initialization order and dynamic libraries
125 // loading other dynamic libraries.
126 //
127 // This makes it safe to include the C++ API headers in a shared library
128 // that is delay loaded or delay loads its dependencies.
129 //
130 // This DOES NOT make it safe to _use_ arbitrary ORT C++ APIs when
131 // initializing static members, however.
132 static const OrtApi* api = DefaultInit();
133
134 if (newValue) {
135 api = newValue;
136 }
137
138 return api;
139 }
140
141 private:
142 // Has different definitions based on ORT_API_MANUAL_INIT
143 static const OrtApi* DefaultInit() noexcept;
144
145#ifdef ORT_API_MANUAL_INIT
146 // Public APIs to set the OrtApi* to use.
147 friend void ::Ort::InitApi() noexcept;
148 friend void ::Ort::InitApi(const OrtApi*) noexcept;
149#endif
150};
151} // namespace detail
152
153#ifdef ORT_API_MANUAL_INIT
154
155// See comments on declaration above for usage.
156inline void InitApi(const OrtApi* api) noexcept { detail::Global::Api(api); }
157inline void InitApi() noexcept { InitApi(OrtGetApiBase()->GetApi(ORT_API_VERSION)); }
158
159#ifdef _MSC_VER
160// If you get a linker error about a mismatch here, you are trying to
161// link two compilation units that have different definitions for
162// ORT_API_MANUAL_INIT together. All compilation units must agree on the
163// definition of ORT_API_MANUAL_INIT.
164#pragma detect_mismatch("ORT_API_MANUAL_INIT", "enabled")
165#endif
166
167inline const OrtApi* detail::Global::DefaultInit() noexcept {
168 // When ORT_API_MANUAL_INIT is defined, there's no default init that can
169 // be done.
170 return nullptr;
171}
172
173#else // ORT_API_MANUAL_INIT
174
175#ifdef _MSC_VER
176// If you get a linker error about a mismatch here, you are trying to link
177// two compilation units that have different definitions for
178// ORT_API_MANUAL_INIT together. All compilation units must agree on the
179// definition of ORT_API_MANUAL_INIT.
180#pragma detect_mismatch("ORT_API_MANUAL_INIT", "disabled")
181#endif
182
183inline const OrtApi* detail::Global::DefaultInit() noexcept {
185}
186#endif // ORT_API_MANUAL_INIT
187
189inline const OrtApi& GetApi() noexcept { return *detail::Global::Api(); }
190
195std::string GetVersionString();
196
202std::string GetBuildInfoString();
203
209std::vector<std::string> GetAvailableProviders();
210
216 auto* api = GetApi().GetModelEditorApi();
217 if (api == nullptr) {
218 // minimal build
219 ORT_CXX_API_THROW("Model Editor API is not available in this build", ORT_FAIL);
220 }
221
222 return *api;
223}
224
230 auto* api = GetApi().GetCompileApi();
231 if (api == nullptr) {
232 // minimal build
233 ORT_CXX_API_THROW("Compile API is not available in this build", ORT_FAIL);
234 }
235
236 return *api;
237}
238
244 auto* api = GetApi().GetInteropApi();
245 if (api == nullptr) {
246 // minimal build
247 ORT_CXX_API_THROW("Interop API is not available in this build", ORT_FAIL);
248 }
249
250 return *api;
251}
252
257inline const OrtEpApi& GetEpApi() {
258 auto* api = GetApi().GetEpApi();
259 if (api == nullptr) {
260 // minimal build
261 ORT_CXX_API_THROW("EP API is not available in this build", ORT_FAIL);
262 }
263
264 return *api;
265}
266
285struct Float16_t : onnxruntime_float16::Float16Impl<Float16_t> {
286 private:
292 constexpr explicit Float16_t(uint16_t v) noexcept { val = v; }
293
294 public:
295 using Base = onnxruntime_float16::Float16Impl<Float16_t>;
296
300 Float16_t() = default;
301
307 constexpr static Float16_t FromBits(uint16_t v) noexcept { return Float16_t(v); }
308
313 explicit Float16_t(float v) noexcept { val = Base::ToUint16Impl(v); }
314
319 float ToFloat() const noexcept { return Base::ToFloatImpl(); }
320
325 using Base::IsNegative;
326
331 using Base::IsNaN;
332
337 using Base::IsFinite;
338
343 using Base::IsPositiveInfinity;
344
349 using Base::IsNegativeInfinity;
350
355 using Base::IsInfinity;
356
361 using Base::IsNaNOrZero;
362
367 using Base::IsNormal;
368
373 using Base::IsSubnormal;
374
379 using Base::Abs;
380
385 using Base::Negate;
386
395 using Base::AreZero;
396
400 explicit operator float() const noexcept { return ToFloat(); }
401
402 using Base::operator==;
403 using Base::operator!=;
404 using Base::operator<;
405};
406
407static_assert(sizeof(Float16_t) == sizeof(uint16_t), "Sizes must match");
408
427struct BFloat16_t : onnxruntime_float16::BFloat16Impl<BFloat16_t> {
428 private:
436 constexpr explicit BFloat16_t(uint16_t v) noexcept { val = v; }
437
438 public:
439 using Base = onnxruntime_float16::BFloat16Impl<BFloat16_t>;
440
441 BFloat16_t() = default;
442
448 static constexpr BFloat16_t FromBits(uint16_t v) noexcept { return BFloat16_t(v); }
449
454 explicit BFloat16_t(float v) noexcept { val = Base::ToUint16Impl(v); }
455
460 float ToFloat() const noexcept { return Base::ToFloatImpl(); }
461
466 using Base::IsNegative;
467
472 using Base::IsNaN;
473
478 using Base::IsFinite;
479
484 using Base::IsPositiveInfinity;
485
490 using Base::IsNegativeInfinity;
491
496 using Base::IsInfinity;
497
502 using Base::IsNaNOrZero;
503
508 using Base::IsNormal;
509
514 using Base::IsSubnormal;
515
520 using Base::Abs;
521
526 using Base::Negate;
527
536 using Base::AreZero;
537
541 explicit operator float() const noexcept { return ToFloat(); }
542
543 // We do not have an inherited impl for the below operators
544 // as the internal class implements them a little differently
545 bool operator==(const BFloat16_t& rhs) const noexcept;
546 bool operator!=(const BFloat16_t& rhs) const noexcept { return !(*this == rhs); }
547 bool operator<(const BFloat16_t& rhs) const noexcept;
548};
549
550static_assert(sizeof(BFloat16_t) == sizeof(uint16_t), "Sizes must match");
551
558 uint8_t value;
559 constexpr Float8E4M3FN_t() noexcept : value(0) {}
560 constexpr Float8E4M3FN_t(uint8_t v) noexcept : value(v) {}
561 constexpr operator uint8_t() const noexcept { return value; }
562 // nan values are treated like any other value for operator ==, !=
563 constexpr bool operator==(const Float8E4M3FN_t& rhs) const noexcept { return value == rhs.value; };
564 constexpr bool operator!=(const Float8E4M3FN_t& rhs) const noexcept { return value != rhs.value; };
565};
566
567static_assert(sizeof(Float8E4M3FN_t) == sizeof(uint8_t), "Sizes must match");
568
575 uint8_t value;
576 constexpr Float8E4M3FNUZ_t() noexcept : value(0) {}
577 constexpr Float8E4M3FNUZ_t(uint8_t v) noexcept : value(v) {}
578 constexpr operator uint8_t() const noexcept { return value; }
579 // nan values are treated like any other value for operator ==, !=
580 constexpr bool operator==(const Float8E4M3FNUZ_t& rhs) const noexcept { return value == rhs.value; };
581 constexpr bool operator!=(const Float8E4M3FNUZ_t& rhs) const noexcept { return value != rhs.value; };
582};
583
584static_assert(sizeof(Float8E4M3FNUZ_t) == sizeof(uint8_t), "Sizes must match");
585
592 uint8_t value;
593 constexpr Float8E5M2_t() noexcept : value(0) {}
594 constexpr Float8E5M2_t(uint8_t v) noexcept : value(v) {}
595 constexpr operator uint8_t() const noexcept { return value; }
596 // nan values are treated like any other value for operator ==, !=
597 constexpr bool operator==(const Float8E5M2_t& rhs) const noexcept { return value == rhs.value; };
598 constexpr bool operator!=(const Float8E5M2_t& rhs) const noexcept { return value != rhs.value; };
599};
600
601static_assert(sizeof(Float8E5M2_t) == sizeof(uint8_t), "Sizes must match");
602
609 uint8_t value;
610 constexpr Float8E5M2FNUZ_t() noexcept : value(0) {}
611 constexpr Float8E5M2FNUZ_t(uint8_t v) noexcept : value(v) {}
612 constexpr operator uint8_t() const noexcept { return value; }
613 // nan values are treated like any other value for operator ==, !=
614 constexpr bool operator==(const Float8E5M2FNUZ_t& rhs) const noexcept { return value == rhs.value; };
615 constexpr bool operator!=(const Float8E5M2FNUZ_t& rhs) const noexcept { return value != rhs.value; };
616};
617
618static_assert(sizeof(Float8E5M2FNUZ_t) == sizeof(uint8_t), "Sizes must match");
619
620namespace detail {
621// This is used internally by the C++ API. This macro is to make it easy to generate overloaded methods for all of the various OrtRelease* functions for every Ort* type
622// This can't be done in the C API since C doesn't have function overloading.
623#define ORT_DEFINE_RELEASE(NAME) \
624 inline void OrtRelease(Ort##NAME* ptr) { GetApi().Release##NAME(ptr); }
625
626#define ORT_DEFINE_RELEASE_FROM_API_STRUCT(NAME, API_GETTER) \
627 inline void OrtRelease(Ort##NAME* ptr) { API_GETTER().Release##NAME(ptr); }
628
629ORT_DEFINE_RELEASE(Allocator);
630ORT_DEFINE_RELEASE(ArenaCfg);
631ORT_DEFINE_RELEASE(CustomOpDomain);
633ORT_DEFINE_RELEASE(Env);
634ORT_DEFINE_RELEASE(ExternalInitializerInfo);
635ORT_DEFINE_RELEASE(Graph);
636ORT_DEFINE_RELEASE(IoBinding);
637ORT_DEFINE_RELEASE(KernelInfo);
638ORT_DEFINE_RELEASE(KeyValuePairs);
639ORT_DEFINE_RELEASE(LoraAdapter);
640ORT_DEFINE_RELEASE(MemoryInfo);
641ORT_DEFINE_RELEASE(MapTypeInfo);
642ORT_DEFINE_RELEASE(Model);
643ORT_DEFINE_RELEASE(ModelMetadata);
644ORT_DEFINE_RELEASE(Node);
645ORT_DEFINE_RELEASE(Op);
646ORT_DEFINE_RELEASE(OpAttr);
647ORT_DEFINE_RELEASE(PrepackedWeightsContainer);
648ORT_DEFINE_RELEASE(RunOptions);
649ORT_DEFINE_RELEASE(Session);
650ORT_DEFINE_RELEASE(SessionOptions);
651ORT_DEFINE_RELEASE(SequenceTypeInfo);
652ORT_DEFINE_RELEASE(Status);
653ORT_DEFINE_RELEASE(SyncStream);
654ORT_DEFINE_RELEASE(TensorTypeAndShapeInfo);
655ORT_DEFINE_RELEASE(ThreadingOptions);
656ORT_DEFINE_RELEASE(TypeInfo);
657ORT_DEFINE_RELEASE(Value);
658ORT_DEFINE_RELEASE(ValueInfo);
659
660ORT_DEFINE_RELEASE_FROM_API_STRUCT(ModelCompilationOptions, GetCompileApi);
661ORT_DEFINE_RELEASE_FROM_API_STRUCT(EpDevice, GetEpApi);
662ORT_DEFINE_RELEASE_FROM_API_STRUCT(KernelDef, GetEpApi);
663ORT_DEFINE_RELEASE_FROM_API_STRUCT(KernelDefBuilder, GetEpApi);
664ORT_DEFINE_RELEASE_FROM_API_STRUCT(KernelRegistry, GetEpApi);
665ORT_DEFINE_RELEASE_FROM_API_STRUCT(OpSchema, GetEpApi);
666ORT_DEFINE_RELEASE_FROM_API_STRUCT(ProfilingEvent, GetEpApi);
667
668// This is defined explicitly since OrtTensorRTProviderOptionsV2 is not a C API type,
669// but the struct has V2 in its name to indicate that it is the second version of the options.
672
673#undef ORT_DEFINE_RELEASE
674#undef ORT_DEFINE_RELEASE_FROM_API_STRUCT
675
679template <typename T>
680struct Unowned {
681 using Type = T;
682};
683
703template <typename T>
704struct Base {
705 using contained_type = T;
706
707 constexpr Base() = default;
708 constexpr explicit Base(contained_type* p) noexcept : p_{p} {}
710 OrtRelease(p_);
711 }
712
713 Base(const Base&) = delete;
714 Base& operator=(const Base&) = delete;
715
716 Base(Base&& v) noexcept : p_{v.p_} { v.p_ = nullptr; }
717 Base& operator=(Base&& v) noexcept {
718 OrtRelease(p_);
719 p_ = v.release();
720 return *this;
721 }
722
723 constexpr operator contained_type*() const noexcept { return p_; }
724 constexpr contained_type& operator*() const noexcept { return *p_; }
725
729 T* p = p_;
730 p_ = nullptr;
731 return p;
732 }
733
734 protected:
736};
737
738// Undefined. For const types use Base<Unowned<const T>>
739template <typename T>
740struct Base<const T>;
741
749template <typename T>
750struct Base<Unowned<T>> {
752
753 constexpr Base() = default;
754 constexpr explicit Base(contained_type* p) noexcept : p_{p} {}
755
756 ~Base() = default;
757
758 Base(const Base&) = default;
759 Base& operator=(const Base&) = default;
760
761 Base(Base&& v) noexcept : p_{v.p_} { v.p_ = nullptr; }
762 Base& operator=(Base&& v) noexcept {
763 p_ = nullptr;
764 std::swap(p_, v.p_);
765 return *this;
766 }
767
768 constexpr operator contained_type*() const noexcept { return p_; }
769 constexpr contained_type& operator*() const noexcept { return *p_; }
770
771 protected:
773};
774
775// Light functor to release memory with OrtAllocator
778 explicit AllocatedFree(OrtAllocator* allocator)
779 : allocator_(allocator) {}
780 void operator()(void* ptr) const {
781 if (ptr) allocator_->Free(allocator_, ptr);
782 }
783};
784
785} // namespace detail
786
787struct AllocatorWithDefaultOptions;
788struct Env;
789struct EpDevice;
790struct ExternalInitializerInfo;
791struct Graph;
792struct Model;
793struct Node;
794struct ModelMetadata;
795struct TypeInfo;
796struct PrepackedWeightsContainer;
797struct Session;
798struct SessionOptions;
799struct SyncStream;
800struct TensorRTProviderOptions;
801struct Value;
802struct ValueInfo;
803
808using AllocatedStringPtr = std::unique_ptr<char, detail::AllocatedFree>;
809
814struct Status : detail::Base<OrtStatus> {
815 Status() = default; // Same as with std::nullptr_t. But can be used in re-sizable containers and represent success.
816 explicit Status(std::nullptr_t) noexcept {}
817 explicit Status(OrtStatus* status) noexcept;
818 explicit Status(const Exception&);
819 explicit Status(const std::exception&);
820 Status(const char* message, OrtErrorCode code);
821 std::string GetErrorMessage() const;
823 bool IsOK() const noexcept;
824};
825
855
860struct TensorRTProviderOptions : detail::Base<OrtTensorRTProviderOptionsV2> {
861 TensorRTProviderOptions(std::nullptr_t) {}
865 void Update(const std::unordered_map<std::string, std::string>& options);
867 void UpdateWithValue(const char* key, void* value);
868
870 void* GetOptionByName(const char* name) const;
873};
874
879struct CUDAProviderOptions : detail::Base<OrtCUDAProviderOptionsV2> {
880 CUDAProviderOptions(std::nullptr_t) {}
884 void Update(const std::unordered_map<std::string, std::string>& options);
888 void UpdateWithValue(const char* key, void* value);
890 void* GetOptionByName(const char* name) const;
891};
892
907
908namespace detail {
909template <typename T>
911 using B = Base<T>;
912 using B::B;
913
914 // Wraps OrtApi::ExternalInitializerInfo_GetFilePath
915 const std::basic_string<ORTCHAR_T> GetFilePath() const;
916 // Wraps OrtApi::ExternalInitializerInfo_GetFileOffset
917 int64_t GetFileOffset() const;
918 // Wraps OrtApi::ExternalInitializerInfo_GetByteSize
919 size_t GetByteSize() const;
920};
921} // namespace detail
922
923// Const object holder that does not own the underlying object
926
932 using Base::Base;
933
934 explicit ExternalInitializerInfo(std::nullptr_t) {}
936 : detail::ConstExternalInitializerInfoImpl<OrtExternalInitializerInfo>{p} {}
937
939
941 ExternalInitializerInfo(const ORTCHAR_T* filepath, int64_t file_offset, size_t byte_size);
942
944 static Status Create(const ORTCHAR_T* filepath, int64_t file_offset, size_t byte_size,
945 /*out*/ ExternalInitializerInfo& out);
946};
947
948namespace detail {
949template <typename T>
952 using B::B;
953
954 const char* GetValue(const char* key) const;
955
956 // get the pairs in unordered_map. needs to copy to std::string so the hash works as expected
957 std::unordered_map<std::string, std::string> GetKeyValuePairs() const;
958 // get the pairs in two vectors. entries will be 1:1 between keys and values. avoids copying to std::string
959 void GetKeyValuePairs(std::vector<const char*>& keys, std::vector<const char*>& values) const;
960};
961} // namespace detail
962
963// Const object holder that does not own the underlying object
965
967struct KeyValuePairs : detail::KeyValuePairsImpl<OrtKeyValuePairs> {
968 explicit KeyValuePairs(std::nullptr_t) {}
970 explicit KeyValuePairs(OrtKeyValuePairs* p) : KeyValuePairsImpl<OrtKeyValuePairs>{p} {}
971
973 explicit KeyValuePairs();
974
976 explicit KeyValuePairs(const std::unordered_map<std::string, std::string>& kv_pairs);
977
979 void Add(const char* key, const char* value);
980
982 void Remove(const char* key);
983
984 ConstKeyValuePairs GetConst() const { return ConstKeyValuePairs{this->p_}; }
985};
986
987namespace detail {
988template <typename T>
989struct MemoryInfoImpl : Base<T> {
990 using B = Base<T>;
991 using B::B;
992
993 std::string GetAllocatorName() const;
995 int GetDeviceId() const;
999 uint32_t GetVendorId() const;
1000
1001 template <typename U>
1002 bool operator==(const MemoryInfoImpl<U>& o) const;
1003};
1004} // namespace detail
1005
1006// Const object holder that does not own the underlying object
1008
1012struct MemoryInfo : detail::MemoryInfoImpl<OrtMemoryInfo> {
1014 explicit MemoryInfo(std::nullptr_t) {}
1015 explicit MemoryInfo(OrtMemoryInfo* p) : MemoryInfoImpl<OrtMemoryInfo>{p} {}
1016 MemoryInfo(const char* name, OrtAllocatorType type, int id, OrtMemType mem_type);
1017 MemoryInfo(const char* name, OrtMemoryInfoDeviceType device_type, uint32_t vendor_id, uint32_t device_id,
1018 OrtDeviceMemoryType mem_type, size_t alignment, OrtAllocatorType allocator_type);
1019 ConstMemoryInfo GetConst() const { return ConstMemoryInfo{this->p_}; }
1020};
1021
1029 MemoryAllocation(OrtAllocator* allocator, void* p, size_t size);
1034 MemoryAllocation& operator=(MemoryAllocation&&) noexcept;
1035
1036 void* get() { return p_; }
1037 size_t size() const { return size_; }
1038
1039 private:
1040 OrtAllocator* allocator_;
1041 void* p_;
1042 size_t size_;
1043};
1044
1045namespace detail {
1046template <typename T>
1047struct AllocatorImpl : Base<T> {
1048 using B = Base<T>;
1049 using B::B;
1050
1051 void* Alloc(size_t size);
1052 void* Reserve(size_t size);
1053 MemoryAllocation GetAllocation(size_t size);
1054 void Free(void* p);
1055 ConstMemoryInfo GetInfo() const;
1056
1061 KeyValuePairs GetStats() const;
1062
1067 void Shrink();
1068};
1069} // namespace detail
1070
1074struct AllocatorWithDefaultOptions : detail::AllocatorImpl<detail::Unowned<OrtAllocator>> {
1075 explicit AllocatorWithDefaultOptions(std::nullptr_t) {}
1077};
1078
1083struct Allocator : detail::AllocatorImpl<OrtAllocator> {
1084 explicit Allocator(std::nullptr_t) {}
1085 Allocator(const Session& session, const OrtMemoryInfo*);
1086
1088 explicit Allocator(OrtAllocator* p) : AllocatorImpl<OrtAllocator>{p} {}
1089};
1090
1091using UnownedAllocator = detail::AllocatorImpl<detail::Unowned<OrtAllocator>>;
1092
1097namespace detail {
1098template <typename T>
1100 using B = Base<T>;
1101 using B::B;
1102 // For some reason this is not a const method on the stream
1103 void* GetHandle();
1104};
1105} // namespace detail
1106
1107struct SyncStream : detail::SyncStreamImpl<OrtSyncStream> {
1109 explicit SyncStream(std::nullptr_t) {}
1111 explicit SyncStream(OrtSyncStream* p) : SyncStreamImpl<OrtSyncStream>{p} {}
1112};
1113
1115
1116namespace detail {
1117template <typename T>
1120 using B::B;
1121
1123 uint32_t VendorId() const;
1124 uint32_t DeviceId() const;
1125 const char* Vendor() const;
1127};
1128} // namespace detail
1129
1134
1135namespace detail {
1136template <typename T>
1139 using B::B;
1140
1141 uint32_t GetReasonsBitmask() const;
1142 const char* GetNotes() const;
1143 int32_t GetErrorCode() const;
1144};
1145} // namespace detail
1146
1151 explicit DeviceEpIncompatibilityDetails(std::nullptr_t) {}
1153 : DeviceEpIncompatibilityDetailsImpl<OrtDeviceEpIncompatibilityDetails>{p} {}
1154};
1155
1156namespace detail {
1157template <typename T>
1160 using B::B;
1161
1162 const char* EpName() const;
1163 const char* EpVendor() const;
1169};
1170} // namespace detail
1171
1176
1179struct EpDevice : detail::EpDeviceImpl<OrtEpDevice> {
1180 explicit EpDevice(std::nullptr_t) {}
1181 explicit EpDevice(OrtEpDevice* p) : EpDeviceImpl<OrtEpDevice>{p} {}
1182
1184 EpDevice(OrtEpFactory& ep_factory, ConstHardwareDevice& hardware_device,
1185 ConstKeyValuePairs ep_metadata = {}, ConstKeyValuePairs ep_options = {});
1186};
1187
1195 const std::vector<ConstEpDevice>& ep_devices,
1196 const char* compatibility_info);
1197
1213AllocatedStringPtr GetCompatibilityInfoFromModelAllocated(const ORTCHAR_T* model_path, const char* ep_type,
1214 OrtAllocator* allocator);
1215
1228AllocatedStringPtr GetCompatibilityInfoFromModelBytesAllocated(const void* model_data, size_t model_data_length,
1229 const char* ep_type, OrtAllocator* allocator);
1230
1231namespace detail {
1232template <typename T>
1235 using B::B;
1236
1237 std::string GetName() const;
1238 std::string GetDomain() const;
1239 std::string GetOperatorType() const;
1240};
1241} // namespace detail
1242
1247
1248namespace detail {
1249template <typename T>
1252 using B::B;
1253
1254 std::string GetEpName() const;
1255 std::vector<ConstEpAssignedNode> GetNodes() const;
1256};
1257} // namespace detail
1258
1263
1264namespace detail {
1265template <typename T>
1268 using B::B;
1269
1271 OrtProfilingEventCategory GetCategory() const;
1272
1275 const char* GetName() const;
1276
1278 int64_t GetTimestampUs() const;
1279
1281 int64_t GetDurationUs() const;
1282
1286 const char* GetArgValue(const char* key) const;
1287};
1288} // namespace detail
1289
1298
1306 explicit ProfilingEvent(std::nullptr_t) {}
1308 : ConstProfilingEventImpl<OrtProfilingEvent>{p} {}
1309
1311 ProfilingEvent(OrtProfilingEventCategory category,
1312 int32_t process_id,
1313 int32_t thread_id,
1314 const char* event_name,
1315 int64_t timestamp_us,
1316 int64_t duration_us,
1317 const std::unordered_map<std::string, std::string>& args = {});
1318
1320 ProfilingEvent(OrtProfilingEventCategory category,
1321 int32_t process_id,
1322 int32_t thread_id,
1323 const char* event_name,
1324 int64_t timestamp_us,
1325 int64_t duration_us,
1326 const char* const* arg_keys,
1327 const char* const* arg_values,
1328 size_t num_args);
1329
1331};
1332
1333namespace detail {
1334template <typename T>
1337 using B::B;
1338
1341 Ort::Status AddEvents(const OrtProfilingEvent* const* events, size_t num_events);
1342 Ort::Status AddEvents(const std::vector<ProfilingEvent>& events);
1343};
1344} // namespace detail
1345
1352
1358struct Env : detail::Base<OrtEnv> {
1359 explicit Env(std::nullptr_t) {}
1360
1362 Env(OrtLoggingLevel logging_level = ORT_LOGGING_LEVEL_WARNING, _In_ const char* logid = "");
1363
1365 Env(OrtLoggingLevel logging_level, const char* logid, OrtLoggingFunction logging_function, void* logger_param);
1366
1368 Env(const OrtThreadingOptions* tp_options, OrtLoggingLevel logging_level = ORT_LOGGING_LEVEL_WARNING, _In_ const char* logid = "");
1369
1371 Env(const OrtThreadingOptions* tp_options, OrtLoggingFunction logging_function, void* logger_param,
1372 OrtLoggingLevel logging_level = ORT_LOGGING_LEVEL_WARNING, _In_ const char* logid = "");
1373
1375 explicit Env(const OrtEnvCreationOptions* options);
1376
1378 explicit Env(OrtEnv* p) : Base<OrtEnv>{p} {}
1379
1382
1384
1385 Env& CreateAndRegisterAllocator(const OrtMemoryInfo* mem_info, const OrtArenaCfg* arena_cfg);
1386
1387 Env& CreateAndRegisterAllocatorV2(const std::string& provider_type, const OrtMemoryInfo* mem_info,
1388 const std::unordered_map<std::string, std::string>& options,
1389 const OrtArenaCfg* arena_cfg);
1390
1392
1394
1396 OrtAllocatorType allocator_type,
1397 const OrtKeyValuePairs* allocator_options);
1398
1399 // Result may be nullptr
1401
1403 OrtDeviceMemoryType mem_type);
1404
1405 Env& RegisterExecutionProviderLibrary(const char* registration_name, const std::basic_string<ORTCHAR_T>& path);
1406 Env& UnregisterExecutionProviderLibrary(const char* registration_name);
1407
1408 std::vector<ConstEpDevice> GetEpDevices() const;
1409
1416 size_t GetNumHardwareDevices() const;
1417
1424 std::vector<ConstHardwareDevice> GetHardwareDevices() const;
1425
1437 const char* ep_name, ConstHardwareDevice hw) const;
1438
1439 Status CopyTensors(const std::vector<Value>& src_tensors,
1440 const std::vector<Value>& dst_tensors,
1441 OrtSyncStream* stream) const;
1442
1445 Status CopyTensor(const OrtValue* src_tensor, OrtValue* dst_tensor, OrtSyncStream* stream) const;
1446
1452};
1453
1457struct CustomOpDomain : detail::Base<OrtCustomOpDomain> {
1459 using Base::Base;
1460
1461 explicit CustomOpDomain(std::nullptr_t) {}
1462
1464 explicit CustomOpDomain(const char* domain);
1465
1466 // This does not take ownership of the op, simply registers it.
1467 void Add(const OrtCustomOp* op);
1468};
1469
1471struct LoraAdapter : detail::Base<OrtLoraAdapter> {
1473 using Base::Base;
1474
1475 explicit LoraAdapter(std::nullptr_t) {}
1483 static LoraAdapter CreateLoraAdapter(const std::basic_string<ORTCHAR_T>& adapter_path,
1484 OrtAllocator* allocator);
1485
1494 static LoraAdapter CreateLoraAdapterFromArray(const void* bytes, size_t num_bytes,
1495 OrtAllocator* allocator);
1496};
1497
1501struct RunOptions : detail::Base<OrtRunOptions> {
1502 explicit RunOptions(std::nullptr_t) {}
1504
1507
1510
1511 RunOptions& SetRunTag(const char* run_tag);
1512 const char* GetRunTag() const;
1513
1514 RunOptions& AddConfigEntry(const char* config_key, const char* config_value);
1515 const char* GetConfigEntry(const char* config_key);
1516
1523
1529
1537
1546
1552 RunOptions& EnableProfiling(const ORTCHAR_T* profile_file_prefix);
1553
1559};
1560
1561namespace detail {
1562// Utility function that returns a SessionOption config entry key for a specific custom operator.
1563// Ex: custom_op.[custom_op_name].[config]
1564std::string MakeCustomOpConfigEntryKey(const char* custom_op_name, const char* config);
1565} // namespace detail
1566
1577 CustomOpConfigs() = default;
1578 ~CustomOpConfigs() = default;
1583
1592 CustomOpConfigs& AddConfig(const char* custom_op_name, const char* config_key, const char* config_value);
1593
1602 const std::unordered_map<std::string, std::string>& GetFlattenedConfigs() const;
1603
1604 private:
1605 std::unordered_map<std::string, std::string> flat_configs_;
1606};
1607
1613namespace detail {
1614// we separate const-only methods because passing const ptr to non-const methods
1615// is only discovered when inline methods are compiled which is counter-intuitive
1616template <typename T>
1617struct ConstSessionOptionsImpl : Base<T> {
1618 using B = Base<T>;
1619 using B::B;
1620
1621 SessionOptions Clone() const;
1622
1623 std::string GetConfigEntry(const char* config_key) const;
1624 bool HasConfigEntry(const char* config_key) const;
1625 std::string GetConfigEntryOrDefault(const char* config_key, const std::string& def) const;
1626
1627 bool GetMemPatternEnabled() const;
1628 ExecutionMode GetExecutionMode() const;
1629};
1630
1631template <typename T>
1632struct SessionOptionsImpl : ConstSessionOptionsImpl<T> {
1633 using B = ConstSessionOptionsImpl<T>;
1634 using B::B;
1635
1636 SessionOptionsImpl& SetIntraOpNumThreads(int intra_op_num_threads);
1637 SessionOptionsImpl& SetInterOpNumThreads(int inter_op_num_threads);
1638 SessionOptionsImpl& SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level);
1639 SessionOptionsImpl& SetDeterministicCompute(bool value);
1640
1641 SessionOptionsImpl& EnableCpuMemArena();
1642 SessionOptionsImpl& DisableCpuMemArena();
1643
1644 SessionOptionsImpl& SetOptimizedModelFilePath(const ORTCHAR_T* optimized_model_file);
1645
1646 SessionOptionsImpl& EnableProfiling(const ORTCHAR_T* profile_file_prefix);
1647 SessionOptionsImpl& DisableProfiling();
1648
1649 SessionOptionsImpl& EnableOrtCustomOps();
1650
1651 SessionOptionsImpl& EnableMemPattern();
1652 SessionOptionsImpl& DisableMemPattern();
1653
1654 SessionOptionsImpl& SetExecutionMode(ExecutionMode execution_mode);
1655
1656 SessionOptionsImpl& SetLoadCancellationFlag(bool value);
1657
1658 SessionOptionsImpl& SetLogId(const char* logid);
1659 SessionOptionsImpl& SetLogSeverityLevel(int level);
1660
1661 SessionOptionsImpl& Add(OrtCustomOpDomain* custom_op_domain);
1662
1663 SessionOptionsImpl& DisablePerSessionThreads();
1664
1665 SessionOptionsImpl& AddConfigEntry(const char* config_key, const char* config_value);
1666
1667 SessionOptionsImpl& AddInitializer(const char* name, const OrtValue* ort_val);
1668 SessionOptionsImpl& AddExternalInitializers(const std::vector<std::string>& names, const std::vector<Value>& ort_values);
1669 SessionOptionsImpl& AddExternalInitializersFromFilesInMemory(const std::vector<std::basic_string<ORTCHAR_T>>& external_initializer_file_names,
1670 const std::vector<char*>& external_initializer_file_buffer_array,
1671 const std::vector<size_t>& external_initializer_file_lengths);
1672
1673 SessionOptionsImpl& AppendExecutionProvider_CPU(int use_arena);
1674 SessionOptionsImpl& AppendExecutionProvider_CUDA(const OrtCUDAProviderOptions& provider_options);
1675 SessionOptionsImpl& AppendExecutionProvider_CUDA_V2(const OrtCUDAProviderOptionsV2& provider_options);
1676 SessionOptionsImpl& AppendExecutionProvider_ROCM(const OrtROCMProviderOptions& provider_options);
1677 SessionOptionsImpl& AppendExecutionProvider_OpenVINO(const OrtOpenVINOProviderOptions& provider_options);
1679 SessionOptionsImpl& AppendExecutionProvider_OpenVINO_V2(const std::unordered_map<std::string, std::string>& provider_options = {});
1680 SessionOptionsImpl& AppendExecutionProvider_TensorRT(const OrtTensorRTProviderOptions& provider_options);
1681 SessionOptionsImpl& AppendExecutionProvider_TensorRT_V2(const OrtTensorRTProviderOptionsV2& provider_options);
1682 SessionOptionsImpl& AppendExecutionProvider_MIGraphX(const OrtMIGraphXProviderOptions& provider_options);
1684 SessionOptionsImpl& AppendExecutionProvider_CANN(const OrtCANNProviderOptions& provider_options);
1686 SessionOptionsImpl& AppendExecutionProvider_Dnnl(const OrtDnnlProviderOptions& provider_options);
1688 SessionOptionsImpl& AppendExecutionProvider(const std::string& provider_name,
1689 const std::unordered_map<std::string, std::string>& provider_options = {});
1690
1693 SessionOptionsImpl& AppendExecutionProvider_V2(Env& env, const std::vector<ConstEpDevice>& ep_devices,
1694 const KeyValuePairs& ep_options);
1697 SessionOptionsImpl& AppendExecutionProvider_V2(Env& env, const std::vector<ConstEpDevice>& ep_devices,
1698 const std::unordered_map<std::string, std::string>& ep_options);
1699
1701 SessionOptionsImpl& SetEpSelectionPolicy(OrtExecutionProviderDevicePolicy policy);
1702
1704 SessionOptionsImpl& SetEpSelectionPolicy(EpSelectionDelegate delegate, void* state = nullptr);
1705
1706 SessionOptionsImpl& SetCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn);
1707 SessionOptionsImpl& SetCustomThreadCreationOptions(void* ort_custom_thread_creation_options);
1708 SessionOptionsImpl& SetCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn);
1709
1713 SessionOptionsImpl& RegisterCustomOpsLibrary(const ORTCHAR_T* library_name, const CustomOpConfigs& custom_op_configs = {});
1714
1715 SessionOptionsImpl& RegisterCustomOpsUsingFunction(const char* function_name);
1716
1718 SessionOptionsImpl& AppendExecutionProvider_VitisAI(const std::unordered_map<std::string, std::string>& provider_options = {});
1719
1721 SessionOptionsImpl& AddFreeDimensionOverride(const char* dim_denotation, int64_t dim_value);
1722
1724 SessionOptionsImpl& AddFreeDimensionOverrideByName(const char* dim_name, int64_t dim_value);
1725};
1726} // namespace detail
1727
1728using UnownedSessionOptions = detail::SessionOptionsImpl<detail::Unowned<OrtSessionOptions>>;
1729using ConstSessionOptions = detail::ConstSessionOptionsImpl<detail::Unowned<const OrtSessionOptions>>;
1730
1734struct SessionOptions : detail::SessionOptionsImpl<OrtSessionOptions> {
1735 explicit SessionOptions(std::nullptr_t) {}
1737 explicit SessionOptions(OrtSessionOptions* p) : SessionOptionsImpl<OrtSessionOptions>{p} {}
1740};
1741
1746struct ModelCompilationOptions : detail::Base<OrtModelCompilationOptions> {
1748 using Base::Base;
1749
1750 explicit ModelCompilationOptions(std::nullptr_t) {}
1751
1752 ModelCompilationOptions(const Env& env, const SessionOptions& session_options);
1753 ModelCompilationOptions(const Env& env, ConstSessionOptions session_options);
1754
1755 ModelCompilationOptions& SetInputModelPath(const ORTCHAR_T* input_model_path);
1757 size_t input_model_data_size);
1758 ModelCompilationOptions& SetEpContextEmbedMode(bool embed_ep_context_in_model);
1759 ModelCompilationOptions& SetOutputModelPath(const ORTCHAR_T* output_model_path);
1761 size_t initializer_size_threshold);
1762
1765 OrtGetInitializerLocationFunc get_initializer_location_func,
1766 void* state);
1767
1768 ModelCompilationOptions& SetOutputModelBuffer(OrtAllocator* allocator, void** output_model_buffer_ptr,
1769 size_t* output_model_buffer_size_ptr);
1770
1773
1774 ModelCompilationOptions& SetEpContextBinaryInformation(const ORTCHAR_T* output_directory,
1775 const ORTCHAR_T* model_name);
1777
1779
1782};
1783
1790Status CompileModel(const Env& env, const ModelCompilationOptions& model_compilation_options);
1791
1795struct ModelMetadata : detail::Base<OrtModelMetadata> {
1797 using Base::Base;
1798
1799 explicit ModelMetadata(std::nullptr_t) {}
1800
1808
1816
1824
1832
1840
1847 std::vector<AllocatedStringPtr> GetCustomMetadataMapKeysAllocated(OrtAllocator* allocator) const;
1848
1859
1860 int64_t GetVersion() const;
1861};
1862
1863struct IoBinding;
1864
1865namespace detail {
1866
1867// we separate const-only methods because passing const ptr to non-const methods
1868// is only discovered when inline methods are compiled which is counter-intuitive
1869template <typename T>
1871 using B = Base<T>;
1872 using B::B;
1873
1874 size_t GetInputCount() const;
1875 size_t GetOutputCount() const;
1877
1878 std::vector<std::string> GetInputNames() const;
1879 std::vector<std::string> GetOutputNames() const;
1880 std::vector<std::string> GetOverridableInitializerNames() const;
1881
1882 std::vector<ConstMemoryInfo> GetMemoryInfoForInputs() const;
1883 std::vector<ConstMemoryInfo> GetMemoryInfoForOutputs() const;
1884 std::vector<ConstEpDevice> GetEpDeviceForInputs() const;
1885 std::vector<ConstEpDevice> GetEpDeviceForOutputs() const;
1886
1895
1904
1913
1914 uint64_t GetProfilingStartTimeNs() const;
1916
1917 TypeInfo GetInputTypeInfo(size_t index) const;
1918 TypeInfo GetOutputTypeInfo(size_t index) const;
1920
1921 int GetOpset(const std::string& domain) const;
1922
1923 std::vector<ValueInfo> GetInputs() const;
1924 std::vector<ValueInfo> GetOutputs() const;
1925
1930 std::vector<ConstEpAssignedSubgraph> GetEpGraphAssignmentInfo() const;
1931};
1932
1933template <typename T>
1936 using B::B;
1937
1955 std::vector<Value> Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
1956 const char* const* output_names, size_t output_count);
1957
1961 void Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
1962 const char* const* output_names, Value* output_values, size_t output_count);
1963
1964 void Run(const RunOptions& run_options, const IoBinding&);
1965
1985 void RunAsync(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
1986 const char* const* output_names, Value* output_values, size_t output_count, RunAsyncCallbackFn callback, void* user_data);
1987
1995
2007 void SetEpDynamicOptions(const char* const* keys, const char* const* values, size_t kv_len);
2008
2009 void FinalizeModelEditorSession(const Model& model, const SessionOptions& options,
2010 OrtPrepackedWeightsContainer* prepacked_weights_container = nullptr);
2011
2018 void ReleaseCapturedGraph(int graph_annotation_id);
2019};
2020
2021} // namespace detail
2022
2025
2029struct Session : detail::SessionImpl<OrtSession> {
2031 explicit Session(std::nullptr_t) {}
2032 explicit Session(OrtSession* p) : SessionImpl{p} {}
2033
2034 Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options);
2035
2037 Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options,
2038 OrtPrepackedWeightsContainer* prepacked_weights_container);
2039
2041 Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options);
2042
2044 Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options,
2045 OrtPrepackedWeightsContainer* prepacked_weights_container);
2046
2047#if !defined(ORT_MINIMAL_BUILD)
2049 Session(const Env& env, const Model& model, const SessionOptions& options);
2050
2052 static Session CreateModelEditorSession(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options);
2053
2055 static Session CreateModelEditorSession(const Env& env, const void* model_data, size_t model_data_length,
2056 const SessionOptions& options);
2057#endif // !defined(ORT_MINIMAL_BUILD)
2058
2059 ConstSession GetConst() const { return ConstSession{this->p_}; }
2060 UnownedSession GetUnowned() const { return UnownedSession{this->p_}; }
2061};
2062
2063namespace detail {
2064template <typename T>
2066 using B = Base<T>;
2067 using B::B;
2068
2070
2075 size_t GetElementCount() const;
2076
2077 size_t GetDimensionsCount() const;
2078
2083 [[deprecated("use GetShape()")]] void GetDimensions(int64_t* values, size_t values_count) const;
2084
2085 void GetSymbolicDimensions(const char** values, size_t values_count) const;
2086 std::vector<const char*> GetSymbolicDimensions() const;
2087
2088 bool HasShape() const;
2089 std::vector<int64_t> GetShape() const;
2090};
2091
2092} // namespace detail
2093
2095
2101 using Base::Base;
2102
2104 explicit TensorTypeAndShapeInfo(std::nullptr_t) {}
2106 explicit TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo* p) : TensorTypeAndShapeInfoImpl{p} {}
2107
2108 // Create a TensorTypeAndShapeInfo object with the specified element type and dimensions
2109 // symbolic_dims are optional, but should be 1:1 with dims.
2110 // The value in symbolic_dims will be used for all entries in dims that are -1.
2112 const std::vector<int64_t>& dims,
2113 const std::vector<std::string>* symbolic_dims = nullptr);
2114
2116};
2117
2118namespace detail {
2119template <typename T>
2121 using B = Base<T>;
2122 using B::B;
2124};
2125
2126} // namespace detail
2127
2129
2133struct SequenceTypeInfo : detail::SequenceTypeInfoImpl<OrtSequenceTypeInfo> {
2135 using Base::Base;
2136
2137 explicit SequenceTypeInfo(std::nullptr_t) {}
2138 explicit SequenceTypeInfo(OrtSequenceTypeInfo* p) : SequenceTypeInfoImpl<OrtSequenceTypeInfo>{p} {}
2140};
2141
2142namespace detail {
2143template <typename T>
2145 using B = Base<T>;
2146 using B::B;
2148};
2149
2150} // namespace detail
2151
2152// This is always owned by the TypeInfo and can only be obtained from it.
2154
2155namespace detail {
2156template <typename T>
2163
2164} // namespace detail
2165
2167
2171struct MapTypeInfo : detail::MapTypeInfoImpl<OrtMapTypeInfo> {
2173 using Base::Base;
2174
2175 explicit MapTypeInfo(std::nullptr_t) {}
2176 explicit MapTypeInfo(OrtMapTypeInfo* p) : MapTypeInfoImpl<OrtMapTypeInfo>{p} {}
2177 ConstMapTypeInfo GetConst() const { return ConstMapTypeInfo{this->p_}; }
2178};
2179
2180namespace detail {
2181template <typename T>
2193} // namespace detail
2194
2200
2205struct TypeInfo : detail::TypeInfoImpl<OrtTypeInfo> {
2207 using Base::Base;
2208
2210 explicit TypeInfo(std::nullptr_t) {}
2211 explicit TypeInfo(OrtTypeInfo* p) : TypeInfoImpl<OrtTypeInfo>{p} {}
2212
2213#if !defined(ORT_MINIMAL_BUILD)
2219#endif // !defined(ORT_MINIMAL_BUILD)
2220
2221 ConstTypeInfo GetConst() const { return ConstTypeInfo{this->p_}; }
2222};
2223
2224namespace detail {
2225// This structure is used to feed sparse tensor values
2226// information for use with FillSparseTensor<Format>() API
2227// if the data type for the sparse tensor values is numeric
2228// use data.p_data, otherwise, use data.str pointer to feed
2229// values. data.str is an array of const char* that are zero terminated.
2230// number of strings in the array must match shape size.
2231// For fully sparse tensors use shape {0} and set p_data/str
2232// to nullptr.
2234 const int64_t* values_shape;
2236 union {
2237 const void* p_data;
2238 const char** str;
2239 } data;
2240};
2241
2242// Provides a way to pass shape in a single
2243// argument
2244struct Shape {
2245 const int64_t* shape;
2247};
2248
2249template <typename T>
2251 using B = Base<T>;
2252 using B::B;
2253
2257 template <typename R>
2258 void GetOpaqueData(const char* domain, const char* type_name, R&) const;
2259
2260 bool IsTensor() const;
2261 bool HasValue() const;
2262
2263 size_t GetCount() const; // If a non tensor, returns 2 for map and N for sequence, where N is the number of elements
2264 Value GetValue(int index, OrtAllocator* allocator) const;
2265
2273
2288 void GetStringTensorContent(void* buffer, size_t buffer_length, size_t* offsets, size_t offsets_count) const;
2289
2296 template <typename R>
2297 const R* GetTensorData() const;
2298
2303 const void* GetTensorRawData() const;
2304
2312
2320
2326
2335 void GetStringTensorElement(size_t buffer_length, size_t element_index, void* buffer) const;
2336
2343 std::string GetStringTensorElement(size_t element_index) const;
2344
2351 size_t GetStringTensorElementLength(size_t element_index) const;
2352
2363 size_t GetTensorSizeInBytes() const;
2364
2365#if !defined(DISABLE_SPARSE_TENSORS)
2373
2380
2389
2399 template <typename R>
2400 const R* GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t& num_indices) const;
2401
2406 bool IsSparseTensor() const;
2407
2416 template <typename R>
2417 const R* GetSparseTensorValues() const;
2418
2419#endif
2420
2433};
2434
2435template <typename T>
2438 using B::B;
2439
2445 template <typename R>
2447
2453
2455 // Obtain a reference to an element of data at the location specified
2461 template <typename R>
2462 R& At(const std::vector<int64_t>& location);
2463
2469 void FillStringTensor(const char* const* s, size_t s_len);
2470
2476 void FillStringTensorElement(const char* s, size_t index);
2477
2490 char* GetResizedStringTensorElementBuffer(size_t index, size_t buffer_length);
2491
2492#if !defined(DISABLE_SPARSE_TENSORS)
2501 void UseCooIndices(int64_t* indices_data, size_t indices_num);
2502
2513 void UseCsrIndices(int64_t* inner_data, size_t inner_num, int64_t* outer_data, size_t outer_num);
2514
2523 void UseBlockSparseIndices(const Shape& indices_shape, int32_t* indices_data);
2524
2534 void FillSparseTensorCoo(const OrtMemoryInfo* data_mem_info, const OrtSparseValuesParam& values_param,
2535 const int64_t* indices_data, size_t indices_num);
2536
2548 void FillSparseTensorCsr(const OrtMemoryInfo* data_mem_info,
2549 const OrtSparseValuesParam& values,
2550 const int64_t* inner_indices_data, size_t inner_indices_num,
2551 const int64_t* outer_indices_data, size_t outer_indices_num);
2552
2563 const OrtSparseValuesParam& values,
2564 const Shape& indices_shape,
2565 const int32_t* indices_data);
2566
2567#endif
2568};
2569
2570} // namespace detail
2571
2574
2578struct Value : detail::ValueImpl<OrtValue> {
2580 using Base::Base;
2583
2584 Value(std::nullptr_t) {}
2585 Value(Value&&) = default;
2586 Value& operator=(Value&&) = default;
2587
2588 ConstValue GetConst() const { return ConstValue{this->p_}; }
2589 UnownedValue GetUnowned() const { return UnownedValue{this->p_}; }
2590
2599 template <typename T>
2600 static Value CreateTensor(const OrtMemoryInfo* info, T* p_data, size_t p_data_element_count,
2601 const int64_t* shape, size_t shape_len);
2602
2612 static Value CreateTensor(const OrtMemoryInfo* info, void* p_data, size_t p_data_byte_count,
2613 const int64_t* shape, size_t shape_len,
2615
2625 static Value CreateTensor(OrtAllocator* deleter, void* p_data, size_t p_data_byte_count,
2626 const int64_t* shape, size_t shape_len,
2628
2640 template <typename T>
2641 static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len);
2642
2654 static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len,
2656
2665 static Value CreateMap(const Value& keys, const Value& values);
2666
2674 static Value CreateSequence(const std::vector<Value>& values);
2675
2684 template <typename T>
2685 static Value CreateOpaque(const char* domain, const char* type_name, const T& value);
2686
2687#if !defined(DISABLE_SPARSE_TENSORS)
2698 template <typename T>
2699 static Value CreateSparseTensor(const OrtMemoryInfo* info, T* p_data, const Shape& dense_shape,
2700 const Shape& values_shape);
2701
2718 static Value CreateSparseTensor(const OrtMemoryInfo* info, void* p_data, const Shape& dense_shape,
2719 const Shape& values_shape, ONNXTensorElementDataType type);
2720
2730 template <typename T>
2731 static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape);
2732
2744 static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape, ONNXTensorElementDataType type);
2745
2746#endif // !defined(DISABLE_SPARSE_TENSORS)
2747};
2748
2749namespace detail {
2750namespace binding_utils {
2751// Bring these out of template
2752std::vector<std::string> GetOutputNamesHelper(const OrtIoBinding* binding, OrtAllocator*);
2753std::vector<Value> GetOutputValuesHelper(const OrtIoBinding* binding, OrtAllocator*);
2754} // namespace binding_utils
2755
2756template <typename T>
2758 using B = Base<T>;
2759 using B::B;
2760
2761 std::vector<std::string> GetOutputNames() const;
2762 std::vector<std::string> GetOutputNames(OrtAllocator*) const;
2763 std::vector<Value> GetOutputValues() const;
2764 std::vector<Value> GetOutputValues(OrtAllocator*) const;
2765};
2766
2767template <typename T>
2770 using B::B;
2771
2772 void BindInput(const char* name, const Value&);
2773 void BindOutput(const char* name, const Value&);
2774 void BindOutput(const char* name, const OrtMemoryInfo*);
2779};
2780
2781} // namespace detail
2782
2785
2789struct IoBinding : detail::IoBindingImpl<OrtIoBinding> {
2790 explicit IoBinding(std::nullptr_t) {}
2791 explicit IoBinding(Session& session);
2792 ConstIoBinding GetConst() const { return ConstIoBinding{this->p_}; }
2793 UnownedIoBinding GetUnowned() const { return UnownedIoBinding{this->p_}; }
2794};
2795
2800struct ArenaCfg : detail::Base<OrtArenaCfg> {
2801 explicit ArenaCfg(std::nullptr_t) {}
2810 ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk);
2811
2816 explicit ArenaCfg(const std::unordered_map<std::string, size_t>& arena_config);
2817};
2818
2819//
2820// Custom OPs (only needed to implement custom OPs)
2821//
2822
2823namespace detail {
2824// Need to define a templated ConstOpAttr with const members
2825template <typename T>
2828 using B::B;
2829
2830 // Wraps OrtApi::OpAttr_GetName
2831 std::string GetName() const;
2832 // Wraps OrtApi::OpAttr_GetType
2834
2835 // Wraps OrtApi::ReadAttr for a single value
2836 // This does not support Tensor Attribute
2837 // Call GetTensorAttributeAsOrtValue() instead.
2838 template <typename R>
2839 Status GetValue(R& out) const;
2840
2841 // Wraps OrtApi::ReadAttr for an array of values
2842 template <typename R>
2843 Status GetValueArray(std::vector<R>& out) const;
2844 // Wraps OrtApi::OpAttr_GetTensorAttributeAsOrtValue
2846};
2847} // namespace detail
2848
2850
2854struct OpAttr : detail::ConstOpAttrImpl<OrtOpAttr> {
2856 using Base::Base;
2857
2858 OpAttr() = default; // Enable storing it in the container for resize()
2859 explicit OpAttr(std::nullptr_t) {}
2860 OpAttr(const char* name, const void* data, int len, OrtOpAttrType type);
2861
2862 ConstOpAttr GetConst() const { return ConstOpAttr{this->p_}; }
2863};
2864
2873#define ORT_CXX_LOG(logger, message_severity, message) \
2874 do { \
2875 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2876 Ort::ThrowOnError(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
2877 static_cast<const char*>(__FUNCTION__), message)); \
2878 } \
2879 } while (false)
2880
2889#define ORT_CXX_LOG_NOEXCEPT(logger, message_severity, message) \
2890 do { \
2891 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2892 static_cast<void>(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
2893 static_cast<const char*>(__FUNCTION__), message)); \
2894 } \
2895 } while (false)
2896
2908#define ORT_CXX_LOGF(logger, message_severity, /*format,*/...) \
2909 do { \
2910 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2911 Ort::ThrowOnError(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
2912 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
2913 } \
2914 } while (false)
2915
2927#define ORT_CXX_LOGF_NOEXCEPT(logger, message_severity, /*format,*/...) \
2928 do { \
2929 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
2930 static_cast<void>(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
2931 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
2932 } \
2933 } while (false)
2934
2945struct Logger {
2949 Logger() = default;
2950
2954 explicit Logger(std::nullptr_t) {}
2955
2962 explicit Logger(const OrtLogger* logger);
2963
2964 ~Logger() = default;
2965
2966 Logger(const Logger&) = default;
2967 Logger& operator=(const Logger&) = default;
2968
2969 Logger(Logger&& v) noexcept = default;
2970 Logger& operator=(Logger&& v) noexcept = default;
2971
2978
2991 Status LogMessage(OrtLoggingLevel log_severity_level, const ORTCHAR_T* file_path, int line_number,
2992 const char* func_name, const char* message) const noexcept;
2993
3008 template <typename... Args>
3009 Status LogFormattedMessage(OrtLoggingLevel log_severity_level, const ORTCHAR_T* file_path, int line_number,
3010 const char* func_name, const char* format, Args&&... args) const noexcept;
3011
3012 private:
3013 const OrtLogger* logger_{};
3014 OrtLoggingLevel cached_severity_level_{};
3015};
3016
3025 size_t GetInputCount() const;
3026 size_t GetOutputCount() const;
3027 // If input is optional and is not present, the method returns an empty ConstValue
3028 // which can be compared to nullptr.
3029 ConstValue GetInput(size_t index) const;
3030 // If output is optional and is not present, the method returns an empty UnownedValue
3031 // which can be compared to nullptr.
3032 UnownedValue GetOutput(size_t index, const int64_t* dim_values, size_t dim_count) const;
3033 UnownedValue GetOutput(size_t index, const std::vector<int64_t>& dims) const;
3035 void* GetGPUComputeStream() const;
3038 Ort::Allocator GetAllocator(const OrtMemoryInfo& memory_info) const;
3039 OrtKernelContext* GetOrtKernelContext() const { return ctx_; }
3040 void ParallelFor(void (*fn)(void*, size_t), size_t total, size_t num_batch, void* usr_data) const;
3041
3042 private:
3043 OrtKernelContext* ctx_;
3044};
3045
3046struct KernelInfo;
3047
3048namespace detail {
3049namespace attr_utils {
3050void GetAttr(const OrtKernelInfo* p, const char* name, float&);
3051void GetAttr(const OrtKernelInfo* p, const char* name, int64_t&);
3052void GetAttr(const OrtKernelInfo* p, const char* name, std::string&);
3053void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<float>&);
3054void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<int64_t>&);
3055void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<std::string>&);
3056} // namespace attr_utils
3057
3058template <typename T>
3059struct KernelInfoImpl : Base<T> {
3060 using B = Base<T>;
3061 using B::B;
3062
3063 KernelInfo Copy() const;
3064
3065 template <typename R> // R is only implemented for float, int64_t, and string
3066 R GetAttribute(const char* name) const {
3067 R val;
3068 attr_utils::GetAttr(this->p_, name, val);
3069 return val;
3070 }
3071
3072 template <typename R> // R is only implemented for float, int64_t, and string
3073 std::vector<R> GetAttributes(const char* name) const {
3074 std::vector<R> result;
3075 attr_utils::GetAttrs(this->p_, name, result);
3076 return result;
3077 }
3078
3079 Value GetTensorAttribute(const char* name, OrtAllocator* allocator) const;
3080
3081 size_t GetInputCount() const;
3082 size_t GetOutputCount() const;
3083
3084 std::string GetInputName(size_t index) const;
3085 std::string GetOutputName(size_t index) const;
3086
3087 TypeInfo GetInputTypeInfo(size_t index) const;
3088 TypeInfo GetOutputTypeInfo(size_t index) const;
3089
3090 ConstValue GetTensorConstantInput(size_t index, int* is_constant) const;
3091
3092 std::string GetNodeName() const;
3093 Logger GetLogger() const;
3094
3095 KeyValuePairs GetConfigEntries() const;
3096
3097 std::string GetOperatorDomain() const;
3098 std::string GetOperatorType() const;
3099 int GetOperatorSinceVersion() const;
3100 const OrtEp* GetEp() const;
3101};
3102
3103} // namespace detail
3104
3105using ConstKernelInfo = detail::KernelInfoImpl<detail::Unowned<const OrtKernelInfo>>;
3106
3113struct KernelInfo : detail::KernelInfoImpl<OrtKernelInfo> {
3114 using Base = detail::KernelInfoImpl<OrtKernelInfo>;
3115 using Base::Base;
3116 explicit KernelInfo(std::nullptr_t) {}
3117 explicit KernelInfo(OrtKernelInfo* info);
3118 ConstKernelInfo GetConst() const { return ConstKernelInfo{this->p_}; }
3119};
3120
3124struct Op : detail::Base<OrtOp> {
3126 using Base::Base;
3127
3128 explicit Op(std::nullptr_t) {}
3129
3130 explicit Op(OrtOp*);
3131
3132 static Op Create(const OrtKernelInfo* info, const char* op_name, const char* domain,
3133 int version, const char** type_constraint_names,
3134 const ONNXTensorElementDataType* type_constraint_values,
3135 size_t type_constraint_count,
3136 const OpAttr* attr_values,
3137 size_t attr_count,
3138 size_t input_count, size_t output_count);
3139
3140 void Invoke(const OrtKernelContext* context,
3141 const Value* input_values,
3142 size_t input_count,
3143 Value* output_values,
3144 size_t output_count);
3145
3146 // For easier refactoring
3147 void Invoke(const OrtKernelContext* context,
3148 const OrtValue* const* input_values,
3149 size_t input_count,
3150 OrtValue* const* output_values,
3151 size_t output_count);
3152};
3153
3159 SymbolicInteger(int64_t i) : i_(i), is_int_(true) {};
3160 SymbolicInteger(const char* s) : s_(s), is_int_(false) {};
3163
3166
3167 bool operator==(const SymbolicInteger& dim) const {
3168 if (is_int_ == dim.is_int_) {
3169 if (is_int_) {
3170 return i_ == dim.i_;
3171 } else {
3172 return std::string{s_} == std::string{dim.s_};
3173 }
3174 }
3175 return false;
3176 }
3177
3178 bool IsInt() const { return is_int_; }
3179 int64_t AsInt() const { return i_; }
3180 const char* AsSym() const { return s_; }
3181
3182 static constexpr int INVALID_INT_DIM = -2;
3183
3184 private:
3185 union {
3186 int64_t i_;
3187 const char* s_;
3188 };
3189 bool is_int_;
3190 };
3191
3192 using Shape = std::vector<SymbolicInteger>;
3193
3195
3196 const Shape& GetInputShape(size_t indice) const { return input_shapes_.at(indice); }
3197
3198 size_t GetInputCount() const { return input_shapes_.size(); }
3199
3201
3202 int64_t GetAttrInt(const char* attr_name);
3203
3204 using Ints = std::vector<int64_t>;
3205 Ints GetAttrInts(const char* attr_name);
3206
3207 float GetAttrFloat(const char* attr_name);
3208
3209 using Floats = std::vector<float>;
3210 Floats GetAttrFloats(const char* attr_name);
3211
3212 std::string GetAttrString(const char* attr_name);
3213
3214 using Strings = std::vector<std::string>;
3215 Strings GetAttrStrings(const char* attr_name);
3216
3217 private:
3218 ConstOpAttr GetAttrHdl(const char* attr_name) const;
3219 const OrtApi* ort_api_;
3221 std::vector<Shape> input_shapes_;
3222};
3223
3225
3226#define MAX_CUSTOM_OP_END_VER (1UL << 31) - 1
3227
3228template <typename TOp, typename TKernel, bool WithStatus = false>
3232 OrtCustomOp::GetName = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetName(); };
3233
3234 OrtCustomOp::GetExecutionProviderType = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetExecutionProviderType(); };
3235
3236 OrtCustomOp::GetInputTypeCount = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetInputTypeCount(); };
3237 OrtCustomOp::GetInputType = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputType(index); };
3238 OrtCustomOp::GetInputMemoryType = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputMemoryType(index); };
3239
3240 OrtCustomOp::GetOutputTypeCount = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetOutputTypeCount(); };
3241 OrtCustomOp::GetOutputType = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetOutputType(index); };
3242
3243#if defined(_MSC_VER) && !defined(__clang__)
3244#pragma warning(push)
3245#pragma warning(disable : 26409)
3246#endif
3247 OrtCustomOp::KernelDestroy = [](void* op_kernel) { delete static_cast<TKernel*>(op_kernel); };
3248#if defined(_MSC_VER) && !defined(__clang__)
3249#pragma warning(pop)
3250#endif
3251 OrtCustomOp::GetInputCharacteristic = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputCharacteristic(index); };
3252 OrtCustomOp::GetOutputCharacteristic = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetOutputCharacteristic(index); };
3253
3254 OrtCustomOp::GetVariadicInputMinArity = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetVariadicInputMinArity(); };
3255 OrtCustomOp::GetVariadicInputHomogeneity = [](const OrtCustomOp* this_) { return static_cast<int>(static_cast<const TOp*>(this_)->GetVariadicInputHomogeneity()); };
3256 OrtCustomOp::GetVariadicOutputMinArity = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetVariadicOutputMinArity(); };
3257 OrtCustomOp::GetVariadicOutputHomogeneity = [](const OrtCustomOp* this_) { return static_cast<int>(static_cast<const TOp*>(this_)->GetVariadicOutputHomogeneity()); };
3258#ifdef __cpp_if_constexpr
3259 if constexpr (WithStatus) {
3260#else
3261 if (WithStatus) {
3262#endif
3263 OrtCustomOp::CreateKernelV2 = [](const OrtCustomOp* this_, const OrtApi* api, const OrtKernelInfo* info, void** op_kernel) -> OrtStatusPtr {
3264 return static_cast<const TOp*>(this_)->CreateKernelV2(*api, info, op_kernel);
3265 };
3266 OrtCustomOp::KernelComputeV2 = [](void* op_kernel, OrtKernelContext* context) -> OrtStatusPtr {
3267 return static_cast<TKernel*>(op_kernel)->ComputeV2(context);
3268 };
3269 } else {
3272
3273 OrtCustomOp::CreateKernel = [](const OrtCustomOp* this_, const OrtApi* api, const OrtKernelInfo* info) { return static_cast<const TOp*>(this_)->CreateKernel(*api, info); };
3274 OrtCustomOp::KernelCompute = [](void* op_kernel, OrtKernelContext* context) {
3275 static_cast<TKernel*>(op_kernel)->Compute(context);
3276 };
3277 }
3278
3279 SetShapeInferFn<TOp>(0);
3280
3281 OrtCustomOp::GetStartVersion = [](const OrtCustomOp* this_) {
3282 return static_cast<const TOp*>(this_)->start_ver_;
3283 };
3284
3285 OrtCustomOp::GetEndVersion = [](const OrtCustomOp* this_) {
3286 return static_cast<const TOp*>(this_)->end_ver_;
3287 };
3288
3291 OrtCustomOp::GetAliasMap = nullptr;
3293 }
3294
3295 // Default implementation of GetExecutionProviderType that returns nullptr to default to the CPU provider
3296 const char* GetExecutionProviderType() const { return nullptr; }
3297
3298 // Default implementations of GetInputCharacteristic() and GetOutputCharacteristic() below
3299 // (inputs and outputs are required by default)
3301 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
3302 }
3303
3305 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
3306 }
3307
3308 // Default implementation of GetInputMemoryType() that returns OrtMemTypeDefault
3309 OrtMemType GetInputMemoryType(size_t /*index*/) const {
3310 return OrtMemTypeDefault;
3311 }
3312
3313 // Default implementation of GetVariadicInputMinArity() returns 1 to specify that a variadic input
3314 // should expect at least 1 argument.
3316 return 1;
3317 }
3318
3319 // Default implementation of GetVariadicInputHomegeneity() returns true to specify that all arguments
3320 // to a variadic input should be of the same type.
3322 return true;
3323 }
3324
3325 // Default implementation of GetVariadicOutputMinArity() returns 1 to specify that a variadic output
3326 // should produce at least 1 output value.
3328 return 1;
3329 }
3330
3331 // Default implementation of GetVariadicOutputHomegeneity() returns true to specify that all output values
3332 // produced by a variadic output should be of the same type.
3334 return true;
3335 }
3336
3337 // Declare list of session config entries used by this Custom Op.
3338 // Implement this function in order to get configs from CustomOpBase::GetSessionConfigs().
3339 // This default implementation returns an empty vector of config entries.
3340 std::vector<std::string> GetSessionConfigKeys() const {
3341 return std::vector<std::string>{};
3342 }
3343
3344 // Ort::CustomOpBase derived class should provide the following static method with the type/shape inferencing
3345 // implementation if needed:
3346 // static OrtStatusPtr InferOutputShape(Ort::ShapeInferContext& context)
3347 template <typename C>
3348 decltype(&C::InferOutputShape) SetShapeInferFn(decltype(&C::InferOutputShape)) {
3350 ShapeInferContext ctx(&GetApi(), ort_ctx);
3351 return C::InferOutputShape(ctx);
3352 };
3353 return {};
3354 }
3355
3356 template <typename C>
3360
3361 protected:
3362 // Helper function that returns a map of session config entries specified by CustomOpBase::GetSessionConfigKeys.
3363 void GetSessionConfigs(std::unordered_map<std::string, std::string>& out, ConstSessionOptions options) const;
3364
3365 int start_ver_ = 1;
3366 int end_ver_ = MAX_CUSTOM_OP_END_VER;
3367};
3368
3369// Forward declaration to resolve circular dependency
3370// on ConstNode
3372
3373namespace detail {
3374template <typename T>
3376 using B = Base<T>;
3377 using B::B;
3378
3380 std::string GetName() const;
3386 std::vector<ValueInfoConsumerProducerInfo> GetConsumers() const;
3396 bool IsGraphOutput() const;
3400 bool IsFromOuterScope() const;
3401};
3402} // namespace detail
3403
3404// Const object holder that does not own the underlying object
3406
3411 ValueInfo() = default; // Same thing as with nullptr
3412 explicit ValueInfo(std::nullptr_t) {}
3414 explicit ValueInfo(OrtValueInfo* p) : ConstValueInfoImpl<OrtValueInfo>{p} {}
3415
3416#if !defined(ORT_MINIMAL_BUILD)
3417 // Create ValueInfo for a tensor
3418 explicit ValueInfo(const std::string& name, const ConstTypeInfo& type_info);
3419#endif
3420 ConstValueInfo GetConst() const { return ConstValueInfo{this->p_}; }
3421};
3422
3423// Forward declaration
3424struct AttrNameSubgraph;
3425
3426namespace detail {
3427// Forward decl
3428template <typename T>
3429struct ConstGraphImpl;
3430
3431template <typename T>
3432struct ConstNodeImpl : Base<T> {
3433 using B = Base<T>;
3434 using B::B;
3435
3436 // <Wraps OrtApi::Node_GetId
3437 size_t GetId() const;
3438 // <Wraps OrtApi::Node_GetName
3439 std::string GetName() const;
3440 // <Wraps OrtApi::Node_GetOperatorType
3441 std::string GetOperatorType() const;
3442 // <Wraps OrtApi::Node_GetDomain
3443 std::string GetDomain() const;
3444 // <Wraps OrtApi::Node_GetSinceVersion
3445 int GetSinceVersion() const;
3446
3447 // <Wraps OrtApi::Node_Inputs
3448 std::vector<ConstValueInfo> GetInputs() const;
3449 // <Wraps OrtApi::Node_Outputs
3450 std::vector<ConstValueInfo> GetOutputs() const;
3451 // <Wraps OrtApi::Node_ImplicitInputs
3452 std::vector<ConstValueInfo> GetImplicitInputs() const;
3453 // <Wraps OrtApi::Node_GetAttributes
3454 std::vector<ConstOpAttr> GetAttributes() const;
3455 // <Wraps OrtApi::Node_GetAttributeByName
3456 // Please, read C API doc for details
3457 Status GetAttributeByName(const std::string& name, ConstOpAttr& attr) const;
3458 // <Wraps OrtApi::Node_GetSubgraphs
3459 std::vector<AttrNameSubgraph> GetSubgraphs() const;
3460 // <Wraps OrtApi::Node_GetGraph
3461 // ConstGraph is not available yet
3463 // <Wraps OrtApi::Node_GetEpName
3464 std::string GetEpName() const;
3465};
3466} // namespace detail
3467
3469
3473struct Node : detail::ConstNodeImpl<OrtNode> {
3474 Node() = default; // Same thing as with nullptr
3475 explicit Node(std::nullptr_t) {}
3476 explicit Node(OrtNode* p) : ConstNodeImpl<OrtNode>{p} {}
3477
3478#if !defined(ORT_MINIMAL_BUILD)
3479 Node(const std::string& operator_name, const std::string& operator_domain,
3480 const std::string& node_name,
3481 const std::vector<std::string>& input_names,
3482 const std::vector<std::string>& output_names);
3483
3487 Node(const std::string& operator_name, const std::string& operator_domain,
3488 const std::string& node_name,
3489 const std::vector<std::string>& input_names,
3490 const std::vector<std::string>& output_names,
3491 std::vector<OpAttr>& attributes);
3492
3493 private:
3494 static void Init(const std::string& operator_name, const std::string& operator_domain,
3495 const std::string& node_name,
3496 const std::vector<std::string>& input_names,
3497 const std::vector<std::string>& output_names,
3498 std::vector<OpAttr>& attributes,
3499 OrtNode*& node);
3500#endif // !defined(ORT_MINIMAL_BUILD)
3501};
3502
3503// Return struct for some of ValueInfo APIs.
3504// Must be declared after ConstNode is available.
3507 // either producer output or consumer output index
3508 // producer is unsigned only, output can be -1
3509 int64_t index;
3510};
3511
3512// Represents a return value for Graph::GetOperatorSets()
3514 std::string domain;
3515 int64_t version;
3516};
3517
3518namespace detail {
3519template <typename T>
3521 using B = Base<T>;
3522 using B::B;
3523
3524 // <Wraps OrtApi::Graph_GetName
3525 std::string GetName() const;
3526 // <Wraps OrtApi::Graph_GetModelPath
3527 std::basic_string<ORTCHAR_T> GetModelPath() const;
3528 // <Wraps OrtApi::Graph_GetOnnxIRVersion
3529 int64_t GetOnnxIRVersion() const;
3530 // <Wraps OrtApi::Graph_GetOperatorSets
3531 std::vector<OperatorSet> GetOperatorSets() const;
3532 // <Wraps OrtApi::Graph_Inputs
3533 std::vector<ConstValueInfo> GetInputs() const;
3534 // <Wraps OrtApi::Graph_Outputs
3535 std::vector<ConstValueInfo> GetOutputs() const;
3536 // <Wraps OrtApi::Graph_Initializers
3537 std::vector<ConstValueInfo> GetInitializers() const;
3538 // <Wraps OrtApi::Graph_GetNodes
3539 std::vector<ConstNode> GetNodes() const;
3540 // <Wraps OrtApi::Graph_GetParentGraph
3542 // <Wraps OrtApi::Graph_GetGraphView
3543 Graph GetGraphView(const std::vector<ConstNode>& nodes) const;
3544 // <Wraps OrtApi::Graph_GetModelMetadata
3546};
3547
3548template <typename T>
3551 using B::B;
3552
3553#if !defined(ORT_MINIMAL_BUILD)
3557 void SetInputs(std::vector<ValueInfo>& inputs);
3561 void SetOutputs(std::vector<ValueInfo>& outputs);
3565 void AddInitializer(const std::string& name, Value& initializer, bool data_is_external); // Graph takes ownership of Value
3569 void AddNode(Node& node); // Graph takes ownership of Node
3570#endif // !defined(ORT_MINIMAL_BUILD)
3571};
3572} // namespace detail
3573
3575
3576// Return value for Node API
3577// Must be declared after ConstGraph
3582
3586struct Graph : detail::GraphImpl<OrtGraph> {
3587 explicit Graph(std::nullptr_t) {}
3588 explicit Graph(OrtGraph* p) : GraphImpl<OrtGraph>{p} {}
3589#if !defined(ORT_MINIMAL_BUILD)
3590 // <Wraps GetModelEditorApi().CreateGraph()
3592#endif
3593};
3594
3595namespace detail {
3596template <typename T>
3599 using B::B;
3600
3601#if !defined(ORT_MINIMAL_BUILD)
3605 void AddGraph(Graph& graph);
3606#endif
3607};
3608} // namespace detail
3609
3610// Const object holder that does not own the underlying object
3612
3616struct Model : detail::ModelImpl<OrtModel> {
3617 using DomainOpsetPair = std::pair<std::string, int>;
3618
3619 explicit Model(std::nullptr_t) {}
3620 explicit Model(OrtModel* p) : ModelImpl<OrtModel>{p} {}
3621
3622#if !defined(ORT_MINIMAL_BUILD)
3623 //< Wraps GetModelEditorApi().CreateModel()
3624 explicit Model(const std::vector<DomainOpsetPair>& opsets);
3625#endif
3626};
3627
3628namespace detail {
3629template <typename T>
3631 using B = Base<T>;
3632 using B::B;
3633
3635 const char* GetOperatorType() const;
3636
3638 const char* GetDomain() const;
3639
3641 std::pair<int, int> GetSinceVersion() const;
3642
3644 const char* GetExecutionProvider() const;
3645
3647 OrtMemType GetInputMemType(size_t input_index) const;
3648
3650 OrtMemType GetOutputMemType(size_t output_index) const;
3651};
3652} // namespace detail
3653
3655
3658 using Base::Base;
3659
3660 explicit KernelDef(std::nullptr_t) {}
3661 explicit KernelDef(OrtKernelDef* p) : detail::ConstKernelDefImpl<OrtKernelDef>{p} {}
3662
3663 ConstKernelDef GetConst() const { return ConstKernelDef{this->p_}; }
3664};
3665
3670struct KernelDefBuilder : detail::Base<OrtKernelDefBuilder> {
3672 explicit KernelDefBuilder(std::nullptr_t) {}
3673 explicit KernelDefBuilder(OrtKernelDefBuilder* ort_kernel_def_builder);
3674
3675 KernelDefBuilder& SetOperatorType(const char* op_type);
3676 KernelDefBuilder& SetDomain(const char* domain);
3677 KernelDefBuilder& SetSinceVersion(int since_version_start, int since_version_end);
3679 KernelDefBuilder& SetInputMemType(size_t input_index, OrtMemType mem_type);
3680 KernelDefBuilder& SetOutputMemType(size_t output_index, OrtMemType mem_type);
3681 KernelDefBuilder& AddTypeConstraint(const char* arg_name, const OrtDataType* data_type);
3682 KernelDefBuilder& AddTypeConstraint(const char* arg_name, const std::vector<const OrtDataType*>& data_types);
3683 KernelDefBuilder& AddInputOutputAlias(int input_index, int output_index);
3684 KernelDefBuilder& AddInputOutputAliases(const std::vector<int>& input_indices,
3685 const std::vector<int>& output_indices);
3686 KernelDefBuilder& AddInputOutputMutableAlias(int input_index, int output_index);
3687 KernelDefBuilder& AddInputOutputMutableAliases(const std::vector<int>& input_indices,
3688 const std::vector<int>& output_indices);
3689
3691};
3692
3697struct KernelRegistry : detail::Base<OrtKernelRegistry> {
3700
3702 explicit KernelRegistry(std::nullptr_t) {}
3703
3705 explicit KernelRegistry(OrtKernelRegistry* ort_kernel_registry);
3706
3708 Status AddKernel(const OrtKernelDef* kernel_def, OrtKernelCreateFunc kernel_create_func,
3709 void* kernel_create_func_state);
3710};
3711
3712namespace detail {
3713template <typename T>
3715 using B = Base<T>;
3716 using B::B;
3717
3719 std::string GetTypeParamName() const;
3720
3722 std::vector<std::string> GetAllowedTypes() const;
3723
3725 std::vector<size_t> GetInputIndices() const;
3726
3728 std::vector<size_t> GetOutputIndices() const;
3729};
3730} // namespace detail
3731
3736
3737namespace detail {
3738template <typename T>
3739struct OpSchemaImpl : Base<T> {
3740 using B = Base<T>;
3741 using B::B;
3742
3744 int GetSinceVersion() const;
3745
3747 size_t GetNumInputs() const;
3748
3750 std::string GetInputName(size_t index) const;
3751
3755
3757 size_t GetNumOutputs() const;
3758
3760 std::string GetOutputName(size_t index) const;
3761
3765
3768
3771};
3772} // namespace detail
3773
3779
3785OpSchema GetOpSchema(const char* name, int max_inclusive_version, const char* domain);
3786
3787namespace detail {
3788template <typename T>
3791 using B::B;
3792
3793 //< Wraps SharedPrePackedWeightCache_StoreWeightData
3794 Status StoreWeightData(void** buffer_data_ptrs, size_t* buffer_sizes, size_t num_buffers);
3795};
3796} // namespace detail
3797
3815
3818
3819} // namespace Ort
3820#include "onnxruntime_cxx_inline.h"
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:292
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:478
struct OrtNode OrtNode
Definition onnxruntime_c_api.h:320
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:260
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:513
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:317
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:442
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:979
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:7612
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:309
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:306
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:300
struct OrtValueInfo OrtValueInfo
Definition onnxruntime_c_api.h:319
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:313
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:249
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:308
struct OrtSession OrtSession
Definition onnxruntime_c_api.h:294
OrtCompiledModelCompatibility
Definition onnxruntime_c_api.h:1205
OrtStatus *(* EpSelectionDelegate)(const OrtEpDevice **ep_devices, size_t num_devices, const OrtKeyValuePairs *model_metadata, const OrtKeyValuePairs *runtime_metadata, const OrtEpDevice **selected, size_t max_selected, size_t *num_selected, void *state)
Delegate to allow providing custom OrtEpDevice selection logic.
Definition onnxruntime_c_api.h:567
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:303
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:293
struct OrtExternalInitializerInfo OrtExternalInitializerInfo
Definition onnxruntime_c_api.h:328
OrtAllocatorType
Definition onnxruntime_c_api.h:484
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:314
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:297
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:298
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:311
struct OrtProfilingEvent OrtProfilingEvent
Definition onnxruntime_ep_c_api.h:35
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:480
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:312
struct OrtEpDevice OrtEpDevice
Definition onnxruntime_c_api.h:325
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:1053
OrtHardwareDeviceType
Definition onnxruntime_c_api.h:520
struct OrtModel OrtModel
Definition onnxruntime_c_api.h:322
struct OrtGraph OrtGraph
Definition onnxruntime_c_api.h:321
struct OrtSyncStream OrtSyncStream
Definition onnxruntime_c_api.h:327
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:302
OrtDeviceMemoryType
This matches OrtDevice::MemoryType values.
Definition onnxruntime_c_api.h:506
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:295
OrtStatus *(* OrtWriteBufferFunc)(void *state, const void *buffer, size_t buffer_num_bytes)
Function called by ORT to write a buffer to a custom destination (e.g., file, stream,...
Definition onnxruntime_c_api.h:586
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:451
struct OrtKeyValuePairs OrtKeyValuePairs
Definition onnxruntime_c_api.h:326
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:339
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:494
OrtSparseFormat
Definition onnxruntime_c_api.h:241
ONNXType
Definition onnxruntime_c_api.h:229
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:290
OrtErrorCode
Error codes reported by ONNX Runtime.
Definition onnxruntime_error_code.h:19
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:291
struct OrtDeviceEpIncompatibilityDetails OrtDeviceEpIncompatibilityDetails
Definition onnxruntime_c_api.h:332
OrtStatus *(* OrtGetInitializerLocationFunc)(void *state, const char *initializer_name, const OrtValue *initializer_value, const OrtExternalInitializerInfo *external_info, OrtExternalInitializerInfo **new_external_info)
Function called by ORT to allow user to specify how an initializer should be saved,...
Definition onnxruntime_c_api.h:620
#define ORT_API_VERSION
The API version defined in this header.
Definition onnxruntime_c_api.h:43
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:316
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:299
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:307
ExecutionMode
Definition onnxruntime_c_api.h:459
OrtOpAttrType
Definition onnxruntime_c_api.h:268
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:972
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:193
OrtExecutionProviderDevicePolicy
These are the default EP selection policies used by ORT when doing automatic EP selection.
Definition onnxruntime_c_api.h:528
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:263
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:502
@ ORT_FAIL
Definition onnxruntime_error_code.h:27
@ ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT
Definition onnxruntime_c_api.h:195
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:629
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:48
Ort::KeyValuePairs GetEnvConfigEntries()
const OrtModelEditorApi & GetModelEditorApi()
This returns a reference to the ORT C Model Editor API. Used if building or augmenting a model at run...
Definition onnxruntime_cxx_api.h:215
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:808
detail::ConstSessionOptionsImpl< detail::Unowned< const OrtSessionOptions > > ConstSessionOptions
Definition onnxruntime_cxx_api.h:1729
detail::KernelInfoImpl< detail::Unowned< const OrtKernelInfo > > ConstKernelInfo
Definition onnxruntime_cxx_api.h:3105
const OrtApi & GetApi() noexcept
This returns a reference to the ORT C API.
Definition onnxruntime_cxx_api.h:189
const OrtCompileApi & GetCompileApi()
This returns a reference to the ORT C Compile API. Used if compiling a model at runtime.
Definition onnxruntime_cxx_api.h:229
AllocatedStringPtr GetCompatibilityInfoFromModelAllocated(const char *model_path, const char *ep_type, OrtAllocator *allocator)
Extract EP compatibility info from a precompiled model file.
AllocatedStringPtr GetCompatibilityInfoFromModelBytesAllocated(const void *model_data, size_t model_data_length, const char *ep_type, OrtAllocator *allocator)
Extract EP compatibility info from precompiled model bytes in memory.
detail::AllocatorImpl< detail::Unowned< OrtAllocator > > UnownedAllocator
Definition onnxruntime_cxx_api.h:1091
OrtCompiledModelCompatibility GetModelCompatibilityForEpDevices(const std::vector< ConstEpDevice > &ep_devices, const char *compatibility_info)
Validate a compiled model's compatibility for one or more EP devices.
const OrtInteropApi & GetInteropApi()
This returns a reference to the ORT C Interop API. Used for external resource import with EPs.
Definition onnxruntime_cxx_api.h:243
OpSchema GetOpSchema(const char *name, int max_inclusive_version, const char *domain)
Get an operator schema from the global schema registry.
detail::SessionOptionsImpl< detail::Unowned< OrtSessionOptions > > UnownedSessionOptions
Definition onnxruntime_cxx_api.h:1728
std::string GetBuildInfoString()
This function returns the onnxruntime build information: including git branch, git commit id,...
const OrtEpApi & GetEpApi()
This returns a reference to the ORT C EP API. Used if authoring a plugin execution provider.
Definition onnxruntime_cxx_api.h:257
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:3224
Status CompileModel(const Env &env, const ModelCompilationOptions &model_compilation_options)
Compiles an input model to generate a model with EPContext nodes that execute EP-specific kernels....
Wrapper around OrtAllocator.
Definition onnxruntime_cxx_api.h:1083
Allocator(const Session &session, const OrtMemoryInfo *)
Take ownership of a pointer created by C API.
Allocator(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1084
Allocator(OrtAllocator *p)
Definition onnxruntime_cxx_api.h:1088
Wrapper around OrtAllocator default instance that is owned by Onnxruntime.
Definition onnxruntime_cxx_api.h:1074
AllocatorWithDefaultOptions(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1075
it is a structure that represents the configuration of an arena based allocator
Definition onnxruntime_cxx_api.h:2800
ArenaCfg(std::nullptr_t)
Create an empty ArenaCfg object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2801
ArenaCfg(const std::unordered_map< std::string, size_t > &arena_config)
ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk)
Definition onnxruntime_cxx_api.h:3578
ConstGraph sub_graph
Definition onnxruntime_cxx_api.h:3580
std::string attr_name
Definition onnxruntime_cxx_api.h:3579
bfloat16 (Brain Floating Point) data type
Definition onnxruntime_cxx_api.h:427
bool operator==(const BFloat16_t &rhs) const noexcept
onnxruntime_float16::BFloat16Impl< BFloat16_t > Base
Definition onnxruntime_cxx_api.h:439
BFloat16_t()=default
static constexpr BFloat16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of bfloat16.
Definition onnxruntime_cxx_api.h:448
bool operator!=(const BFloat16_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:546
BFloat16_t(float v) noexcept
__ctor from float. Float is converted into bfloat16 16-bit representation.
Definition onnxruntime_cxx_api.h:454
float ToFloat() const noexcept
Converts bfloat16 to float.
Definition onnxruntime_cxx_api.h:460
bool operator<(const BFloat16_t &rhs) const noexcept
The CUDAProviderOptions (V2)
Definition onnxruntime_cxx_api.h:879
CUDAProviderOptions()
Wraps OrtApi::CreateCUDAProviderOptions.
CUDAProviderOptions(std::nullptr_t)
Definition onnxruntime_cxx_api.h:880
void UpdateWithValue(const char *key, void *value)
Wrapper around OrtApi::GetCUDAProviderOptionsByName.
std::string GetCUDAProviderOptionsAsString() const
Wrapper around OrtApi::UpdateCUDAProviderOptionsWithValue.
void Update(const std::unordered_map< std::string, std::string > &options)
Wrapper around OrtApi::GetCUDAProviderOptionsAsString.
void * GetOptionByName(const char *name) const
Definition onnxruntime_cxx_api.h:3229
OrtCustomOpInputOutputCharacteristic GetOutputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:3304
OrtCustomOpInputOutputCharacteristic GetInputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:3300
OrtMemType GetInputMemoryType(size_t) const
Definition onnxruntime_cxx_api.h:3309
std::vector< std::string > GetSessionConfigKeys() const
Definition onnxruntime_cxx_api.h:3340
bool GetVariadicInputHomogeneity() const
Definition onnxruntime_cxx_api.h:3321
int GetVariadicInputMinArity() const
Definition onnxruntime_cxx_api.h:3315
void SetShapeInferFn(...)
Definition onnxruntime_cxx_api.h:3357
CustomOpBase()
Definition onnxruntime_cxx_api.h:3230
bool GetVariadicOutputHomogeneity() const
Definition onnxruntime_cxx_api.h:3333
int GetVariadicOutputMinArity() const
Definition onnxruntime_cxx_api.h:3327
decltype(&C::InferOutputShape) SetShapeInferFn(decltype(&C::InferOutputShape))
Definition onnxruntime_cxx_api.h:3348
const char * GetExecutionProviderType() const
Definition onnxruntime_cxx_api.h:3296
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:1576
~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:1457
CustomOpDomain(std::nullptr_t)
Create an empty CustomOpDomain object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1461
CustomOpDomain(const char *domain)
Wraps OrtApi::CreateCustomOpDomain.
void Add(const OrtCustomOp *op)
Wraps CustomOpDomain_Add.
Wrapper around OrtDeviceEpIncompatibilityDetails.
Definition onnxruntime_cxx_api.h:1150
DeviceEpIncompatibilityDetails(OrtDeviceEpIncompatibilityDetails *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:1152
DeviceEpIncompatibilityDetails(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1151
The Env (Environment)
Definition onnxruntime_cxx_api.h:1358
std::vector< ConstHardwareDevice > GetHardwareDevices() const
Get the list of available hardware devices.
Env & EnableTelemetryEvents()
Wraps OrtApi::EnableTelemetryEvents.
Env(OrtEnv *p)
C Interop Helper.
Definition onnxruntime_cxx_api.h:1378
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 & UnregisterExecutionProviderLibrary(const char *registration_name)
Wraps OrtApi::UnregisterExecutionProviderLibrary.
Env & SetPerSessionThreadPoolCallbacks(const OrtThreadPoolCallbacksConfig &config)
Wraps OrtApi::SetPerSessionThreadPoolCallbacks Stores work callbacks on the Env for per-session threa...
std::vector< ConstEpDevice > GetEpDevices() const
DeviceEpIncompatibilityDetails GetHardwareDeviceEpIncompatibilityDetails(const char *ep_name, ConstHardwareDevice hw) const
Check for known incompatibility issues between hardware device and a specific execution provider.
Env & UnregisterAllocator(const OrtMemoryInfo *mem_info)
Wraps OrtApi::UnregisterAllocator.
Env(std::nullptr_t)
Create an empty Env object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1359
Status CopyTensor(const OrtValue *src_tensor, OrtValue *dst_tensor, OrtSyncStream *stream) const
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 & RegisterAllocator(OrtAllocator *allocator)
Wraps OrtApi::RegisterAllocator.
UnownedAllocator CreateSharedAllocator(const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type, OrtAllocatorType allocator_type, const OrtKeyValuePairs *allocator_options)
Wraps OrtApi::CreateSharedAllocator.
size_t GetNumHardwareDevices() const
Get the number of available hardware devices.
Env(OrtLoggingLevel logging_level, const char *logid, OrtLoggingFunction logging_function, void *logger_param)
Wraps OrtApi::CreateEnvWithCustomLogger.
Env(const OrtEnvCreationOptions *options)
Wraps OrtApi::CreateEnvWithOptions.
Env & CreateAndRegisterAllocator(const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocator.
UnownedAllocator GetSharedAllocator(const OrtMemoryInfo *mem_info)
Wraps OrtApi::GetSharedAllocator.
Env & RegisterExecutionProviderLibrary(const char *registration_name, const std::basic_string< char > &path)
Wraps OrtApi::RegisterExecutionProviderLibrary.
Env & UpdateEnvWithCustomLogLevel(OrtLoggingLevel log_severity_level)
Wraps OrtApi::UpdateEnvWithCustomLogLevel.
Status CopyTensors(const std::vector< Value > &src_tensors, const std::vector< Value > &dst_tensors, OrtSyncStream *stream) const
Wraps OrtApi::CopyTensors.
void ReleaseSharedAllocator(const OrtEpDevice *ep_device, OrtDeviceMemoryType mem_type)
Wraps OrtApi::ReleaseSharedAllocator.
Env & DisableTelemetryEvents()
Wraps OrtApi::DisableTelemetryEvents.
Mutable EpDevice that is created by EpApi users.
Definition onnxruntime_cxx_api.h:1179
EpDevice(OrtEpDevice *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:1181
EpDevice(OrtEpFactory &ep_factory, ConstHardwareDevice &hardware_device, ConstKeyValuePairs ep_metadata={}, ConstKeyValuePairs ep_options={})
Wraps OrtEpApi::CreateEpDevice.
EpDevice(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1180
All C++ methods that can fail will throw an exception of this type.
Definition onnxruntime_cxx_api.h:54
const char * what() const noexcept override
Definition onnxruntime_cxx_api.h:59
Exception(const std::string &string, OrtErrorCode code)
Definition onnxruntime_cxx_api.h:55
OrtErrorCode GetOrtErrorCode() const
Definition onnxruntime_cxx_api.h:58
Exception(std::string &&string, OrtErrorCode code)
Definition onnxruntime_cxx_api.h:56
Wrapper around OrtExternalInitializerInfo.
Definition onnxruntime_cxx_api.h:930
ConstExternalInitializerInfo GetConst() const
Wraps OrtApi::CreateExternalInitializerInfo.
Definition onnxruntime_cxx_api.h:938
ExternalInitializerInfo(const char *filepath, int64_t file_offset, size_t byte_size)
Wrapper around CreateExternalInitializerInfo that does not throw an exception.
ExternalInitializerInfo(std::nullptr_t)
Definition onnxruntime_cxx_api.h:934
ExternalInitializerInfo(OrtExternalInitializerInfo *p)
Definition onnxruntime_cxx_api.h:935
static Status Create(const char *filepath, int64_t file_offset, size_t byte_size, ExternalInitializerInfo &out)
IEEE 754 half-precision floating point data type.
Definition onnxruntime_cxx_api.h:285
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:313
onnxruntime_float16::Float16Impl< Float16_t > Base
Definition onnxruntime_cxx_api.h:295
float ToFloat() const noexcept
Converts float16 to float.
Definition onnxruntime_cxx_api.h:319
static constexpr Float16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of float16.
Definition onnxruntime_cxx_api.h:307
float8e4m3fn (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:557
uint8_t value
Definition onnxruntime_cxx_api.h:558
constexpr Float8E4M3FN_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:560
constexpr bool operator==(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:563
constexpr Float8E4M3FN_t() noexcept
Definition onnxruntime_cxx_api.h:559
constexpr bool operator!=(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:564
float8e4m3fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:574
constexpr bool operator==(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:580
uint8_t value
Definition onnxruntime_cxx_api.h:575
constexpr Float8E4M3FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:576
constexpr bool operator!=(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:581
constexpr Float8E4M3FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:577
float8e5m2 (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:591
constexpr Float8E5M2_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:594
uint8_t value
Definition onnxruntime_cxx_api.h:592
constexpr bool operator!=(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:598
constexpr Float8E5M2_t() noexcept
Definition onnxruntime_cxx_api.h:593
constexpr bool operator==(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:597
float8e5m2fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:608
constexpr Float8E5M2FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:610
constexpr Float8E5M2FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:611
constexpr bool operator!=(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:615
constexpr bool operator==(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:614
uint8_t value
Definition onnxruntime_cxx_api.h:609
Wrapper around OrtGraph.
Definition onnxruntime_cxx_api.h:3586
Graph(OrtGraph *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3588
Graph(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:3587
Wrapper around OrtIoBinding.
Definition onnxruntime_cxx_api.h:2789
UnownedIoBinding GetUnowned() const
Definition onnxruntime_cxx_api.h:2793
ConstIoBinding GetConst() const
Definition onnxruntime_cxx_api.h:2792
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:2790
This class wraps a raw pointer OrtKernelContext* that is being passed to the custom kernel Compute() ...
Definition onnxruntime_cxx_api.h:3023
KernelContext(OrtKernelContext *context)
OrtSyncStream * GetSyncStream() const
Logger GetLogger() const
ConstValue GetInput(size_t index) const
OrtKernelContext * GetOrtKernelContext() const
Definition onnxruntime_cxx_api.h:3039
void ParallelFor(void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data) const
UnownedValue GetPreallocatedOutput(size_t index) const
void * GetGPUComputeStream() const
size_t GetInputCount() const
Ort::Allocator GetAllocator(const OrtMemoryInfo &memory_info) 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
Builder for OrtKernelDef.
Definition onnxruntime_cxx_api.h:3670
KernelDefBuilder & AddTypeConstraint(const char *arg_name, const OrtDataType *data_type)
KernelDefBuilder & SetOutputMemType(size_t output_index, OrtMemType mem_type)
KernelDefBuilder & AddInputOutputMutableAliases(const std::vector< int > &input_indices, const std::vector< int > &output_indices)
KernelDefBuilder & SetInputMemType(size_t input_index, OrtMemType mem_type)
KernelDefBuilder & SetDomain(const char *domain)
KernelDefBuilder & AddInputOutputAliases(const std::vector< int > &input_indices, const std::vector< int > &output_indices)
KernelDefBuilder & AddInputOutputAlias(int input_index, int output_index)
KernelDefBuilder & SetExecutionProvider(const char *ep_name)
KernelDefBuilder & SetOperatorType(const char *op_type)
KernelDefBuilder & AddInputOutputMutableAlias(int input_index, int output_index)
KernelDefBuilder()
Wraps OrtEpApi::CreateKernelDefBuilder.
KernelDefBuilder & AddTypeConstraint(const char *arg_name, const std::vector< const OrtDataType * > &data_types)
KernelDefBuilder(std::nullptr_t)
Create an empty object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:3672
KernelDefBuilder(OrtKernelDefBuilder *ort_kernel_def_builder)
KernelDefBuilder & SetSinceVersion(int since_version_start, int since_version_end)
Definition onnxruntime_cxx_api.h:3656
KernelDef(OrtKernelDef *p)
Definition onnxruntime_cxx_api.h:3661
KernelDef(std::nullptr_t)
Definition onnxruntime_cxx_api.h:3660
ConstKernelDef GetConst() const
Definition onnxruntime_cxx_api.h:3663
This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelIn...
Definition onnxruntime_cxx_api.h:3113
KernelInfo(OrtKernelInfo *info)
Take ownership of the instance.
ConstKernelInfo GetConst() const
Definition onnxruntime_cxx_api.h:3118
detail::KernelInfoImpl< OrtKernelInfo > Base
Definition onnxruntime_cxx_api.h:3114
KernelInfo(std::nullptr_t)
Create an empty instance to initialize later.
Definition onnxruntime_cxx_api.h:3116
Registry for kernels supported by an EP.
Definition onnxruntime_cxx_api.h:3697
KernelRegistry()
< Wrapper around OrtEpApi::CreateKernelRegistry
KernelRegistry(std::nullptr_t)
Take ownership of a pointer created with the C API.
Definition onnxruntime_cxx_api.h:3702
Status AddKernel(const OrtKernelDef *kernel_def, OrtKernelCreateFunc kernel_create_func, void *kernel_create_func_state)
KernelRegistry(OrtKernelRegistry *ort_kernel_registry)
Wraps KernelRegistry_AddKernel.
Wrapper around OrtKeyValuePairs.
Definition onnxruntime_cxx_api.h:967
KeyValuePairs()
Wraps OrtApi::CreateKeyValuePairs.
void Add(const char *key, const char *value)
Wraps OrtApi::AddKeyValuePair.
KeyValuePairs(const std::unordered_map< std::string, std::string > &kv_pairs)
Wraps OrtApi::CreateKeyValuePairs and OrtApi::AddKeyValuePair.
void Remove(const char *key)
Wraps OrtApi::RemoveKeyValuePair.
KeyValuePairs(std::nullptr_t)
Definition onnxruntime_cxx_api.h:968
ConstKeyValuePairs GetConst() const
Definition onnxruntime_cxx_api.h:984
KeyValuePairs(OrtKeyValuePairs *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:970
This class represents an ONNX Runtime logger that can be used to log information with an associated s...
Definition onnxruntime_cxx_api.h:2945
Logger(Logger &&v) noexcept=default
Logger & operator=(Logger &&v) noexcept=default
Logger & operator=(const Logger &)=default
~Logger()=default
Logger(const Logger &)=default
Logger()=default
Logger(std::nullptr_t)
Definition onnxruntime_cxx_api.h:2954
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:1471
static LoraAdapter CreateLoraAdapter(const std::basic_string< char > &adapter_path, OrtAllocator *allocator)
Wraps OrtApi::CreateLoraAdapter.
LoraAdapter(std::nullptr_t)
Definition onnxruntime_cxx_api.h:1475
static LoraAdapter CreateLoraAdapterFromArray(const void *bytes, size_t num_bytes, OrtAllocator *allocator)
Wraps OrtApi::CreateLoraAdapterFromArray.
Wrapper around OrtMapTypeInfo.
Definition onnxruntime_cxx_api.h:2171
ConstMapTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:2177
MapTypeInfo(OrtMapTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:2176
MapTypeInfo(std::nullptr_t)
Create an empty MapTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2175
Represents native memory allocation coming from one of the OrtAllocators registered with OnnxRuntime....
Definition onnxruntime_cxx_api.h:1028
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:1037
Wrapper around OrtMemoryInfo.
Definition onnxruntime_cxx_api.h:1012
MemoryInfo(const char *name, OrtAllocatorType type, int id, OrtMemType mem_type)
MemoryInfo(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1014
MemoryInfo(OrtMemoryInfo *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:1015
static MemoryInfo CreateCpu(OrtAllocatorType type, OrtMemType mem_type1)
ConstMemoryInfo GetConst() const
Definition onnxruntime_cxx_api.h:1019
MemoryInfo(const char *name, OrtMemoryInfoDeviceType device_type, uint32_t vendor_id, uint32_t device_id, OrtDeviceMemoryType mem_type, size_t alignment, OrtAllocatorType allocator_type)
Wrapper around CreateMemoryInfo_V2.
Options object used when compiling a model.
Definition onnxruntime_cxx_api.h:1746
ModelCompilationOptions & SetOutputModelWriteFunc(OrtWriteBufferFunc write_func, void *state)
ModelCompilationOptions & SetEpContextEmbedMode(bool embed_ep_context_in_model)
Wraps OrtApi::ModelCompilationOptions_SetEpContextEmbedMode.
ModelCompilationOptions & SetInputModelFromBuffer(const void *input_model_data, size_t input_model_data_size)
Wraps OrtApi::ModelCompilationOptions_SetInputModelFromBuffer.
ModelCompilationOptions & SetOutputModelBuffer(OrtAllocator *allocator, void **output_model_buffer_ptr, size_t *output_model_buffer_size_ptr)
Wraps OrtApi::ModelCompilationOptions_SetOutputModelBuffer.
ModelCompilationOptions & SetFlags(uint32_t flags)
Wraps OrtApi::ModelCompilationOptions_SetFlags.
ModelCompilationOptions & SetOutputModelExternalInitializersFile(const char *file_path, size_t initializer_size_threshold)
Wraps OrtApi::ModelCompilationOptions_SetOutputModelExternalInitializersFile.
ModelCompilationOptions(std::nullptr_t)
Create an empty ModelCompilationOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1750
ModelCompilationOptions(const Env &env, ConstSessionOptions session_options)
Wraps OrtApi::CreateModelCompilationOptionsFromSessionOptions.
ModelCompilationOptions & SetOutputModelPath(const char *output_model_path)
Wraps OrtApi::ModelCompilationOptions_SetOutputModelPath.
ModelCompilationOptions & SetInputModelPath(const char *input_model_path)
Wraps OrtApi::ModelCompilationOptions_SetInputModelPath.
ModelCompilationOptions & SetOutputModelGetInitializerLocationFunc(OrtGetInitializerLocationFunc get_initializer_location_func, void *state)
ModelCompilationOptions & SetEpContextBinaryInformation(const char *output_directory, const char *model_name)
Wraps OrtApi::ModelCompilationOptions_SetEpContextBinaryInformation.
ModelCompilationOptions & SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level)
Wraps OrtApi::ModelCompilationOptions_SetGraphOptimizationLevel.
ModelCompilationOptions(const Env &env, const SessionOptions &session_options)
Wraps OrtApi::CreateModelCompilationOptionsFromSessionOptions.
ModelCompilationOptions & SetInputModel(const OrtModel *model)
Wraps OrtCompileApi::ModelCompilationOptions_SetInputModel.
ModelCompilationOptions & SetWeightlessEnabled(bool use_weightless)
Wraps OrtCompileApi::ModelCompilationOptions_SetWeightlessEnabled.
Wrapper around OrtModel.
Definition onnxruntime_cxx_api.h:3616
Model(const std::vector< DomainOpsetPair > &opsets)
Model(OrtModel *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3620
std::pair< std::string, int > DomainOpsetPair
Definition onnxruntime_cxx_api.h:3617
Model(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:3619
Wrapper around OrtModelMetadata.
Definition onnxruntime_cxx_api.h:1795
AllocatedStringPtr GetDescriptionAllocated(OrtAllocator *allocator) const
Returns a copy of the description.
std::vector< AllocatedStringPtr > GetCustomMetadataMapKeysAllocated(OrtAllocator *allocator) const
Returns a vector of copies of the custom metadata keys.
ModelMetadata(std::nullptr_t)
Create an empty ModelMetadata object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1799
AllocatedStringPtr GetGraphDescriptionAllocated(OrtAllocator *allocator) const
Returns a copy of the graph description.
AllocatedStringPtr GetProducerNameAllocated(OrtAllocator *allocator) const
Returns a copy of the producer name.
AllocatedStringPtr GetGraphNameAllocated(OrtAllocator *allocator) const
Returns a copy of the graph name.
AllocatedStringPtr LookupCustomMetadataMapAllocated(const char *key, OrtAllocator *allocator) const
Looks up a value by a key in the Custom Metadata map.
AllocatedStringPtr GetDomainAllocated(OrtAllocator *allocator) const
Returns a copy of the domain name.
int64_t GetVersion() const
Wraps OrtApi::ModelMetadataGetVersion.
Wrapper around OrtNode.
Definition onnxruntime_cxx_api.h:3473
Node(const std::string &operator_name, const std::string &operator_domain, const std::string &node_name, const std::vector< std::string > &input_names, const std::vector< std::string > &output_names)
Node()=default
Node(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:3475
Node(const std::string &operator_name, const std::string &operator_domain, const std::string &node_name, const std::vector< std::string > &input_names, const std::vector< std::string > &output_names, std::vector< OpAttr > &attributes)
Wraps CreateNode. Node takes ownership of attributes on success and updates the OpAttr in attributes ...
Node(OrtNode *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3476
This struct provides life time management for custom op attribute.
Definition onnxruntime_cxx_api.h:2854
OpAttr(const char *name, const void *data, int len, OrtOpAttrType type)
OpAttr()=default
OpAttr(std::nullptr_t)
Definition onnxruntime_cxx_api.h:2859
ConstOpAttr GetConst() const
Definition onnxruntime_cxx_api.h:2862
Create and own custom defined operation.
Definition onnxruntime_cxx_api.h:3124
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:3128
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)
Definition onnxruntime_cxx_api.h:3513
std::string domain
Definition onnxruntime_cxx_api.h:3514
int64_t version
Definition onnxruntime_cxx_api.h:3515
The PrepackedWeightsContainer.
Definition onnxruntime_cxx_api.h:898
PrepackedWeightsContainer()
Wraps OrtApi::CreatePrepackedWeightsContainer.
PrepackedWeightsContainer(OrtPrepackedWeightsContainer *p)
Definition onnxruntime_cxx_api.h:903
PrepackedWeightsContainer(std::nullptr_t)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:901
Owning wrapper around OrtProfilingEvent.
Definition onnxruntime_cxx_api.h:1305
ProfilingEvent(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1306
ConstProfilingEvent GetConst() const
Definition onnxruntime_cxx_api.h:1330
ProfilingEvent(OrtProfilingEventCategory category, int32_t process_id, int32_t thread_id, const char *event_name, int64_t timestamp_us, int64_t duration_us, const std::unordered_map< std::string, std::string > &args={})
Wraps OrtEpApi::CreateProfilingEvent.
ProfilingEvent(OrtProfilingEvent *p)
Take ownership.
Definition onnxruntime_cxx_api.h:1307
ProfilingEvent(OrtProfilingEventCategory category, int32_t process_id, int32_t thread_id, const char *event_name, int64_t timestamp_us, int64_t duration_us, const char *const *arg_keys, const char *const *arg_values, size_t num_args)
Wraps OrtEpApi::CreateProfilingEvent.
RunOptions.
Definition onnxruntime_cxx_api.h:1501
int GetRunLogSeverityLevel() const
Wraps OrtApi::RunOptionsGetRunLogSeverityLevel.
RunOptions & SetTerminate()
Terminates all currently executing Session::Run calls that were made using this RunOptions instance.
RunOptions & DisableProfiling()
Disable profiling for this run.
RunOptions & SetSyncStream(OrtSyncStream *stream)
Associate a sync stream with the run options.
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:1502
RunOptions & SetRunLogVerbosityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel.
RunOptions & SetRunLogSeverityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogSeverityLevel.
RunOptions & EnableProfiling(const char *profile_file_prefix)
Enable profiling for this run.
RunOptions & AddConfigEntry(const char *config_key, const char *config_value)
Wraps OrtApi::AddRunConfigEntry.
const char * GetRunTag() const
Wraps OrtApi::RunOptionsGetRunTag.
RunOptions()
Wraps OrtApi::CreateRunOptions.
const char * GetConfigEntry(const char *config_key)
Wraps OrtApi::GetRunConfigEntry.
Wrapper around OrtSequenceTypeInfo.
Definition onnxruntime_cxx_api.h:2133
SequenceTypeInfo(std::nullptr_t)
Create an empty SequenceTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2137
ConstSequenceTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:2139
SequenceTypeInfo(OrtSequenceTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:2138
Wrapper around OrtSession.
Definition onnxruntime_cxx_api.h:2029
Session(std::nullptr_t)
Create an empty Session object, must be assigned a valid one to be used. Wraps OrtApi::CreateSession.
Definition onnxruntime_cxx_api.h:2031
static Session CreateModelEditorSession(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options)
Wraps OrtModelEditorApi::CreateModelEditorSession.
UnownedSession GetUnowned() const
Definition onnxruntime_cxx_api.h:2060
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 Model &model, const SessionOptions &options)
Wraps OrtModelEditorApi::CreateSessionFromModel.
Session(OrtSession *p)
C API Interop.
Definition onnxruntime_cxx_api.h:2032
static Session CreateModelEditorSession(const Env &env, const char *model_path, const SessionOptions &options)
Wraps OrtModelEditorApi::CreateModelEditorSession.
Session(const Env &env, const char *model_path, const SessionOptions &options)
ConstSession GetConst() const
Definition onnxruntime_cxx_api.h:2059
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:1734
SessionOptions(std::nullptr_t)
Create an empty SessionOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1735
UnownedSessionOptions GetUnowned() const
Definition onnxruntime_cxx_api.h:1738
SessionOptions()
Wraps OrtApi::CreateSessionOptions.
ConstSessionOptions GetConst() const
Definition onnxruntime_cxx_api.h:1739
SessionOptions(OrtSessionOptions *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1737
Definition onnxruntime_cxx_api.h:3158
SymbolicInteger & operator=(const SymbolicInteger &)=default
SymbolicInteger(const SymbolicInteger &)=default
int64_t AsInt() const
Definition onnxruntime_cxx_api.h:3179
int64_t i_
Definition onnxruntime_cxx_api.h:3186
const char * s_
Definition onnxruntime_cxx_api.h:3187
bool operator==(const SymbolicInteger &dim) const
Definition onnxruntime_cxx_api.h:3167
SymbolicInteger & operator=(SymbolicInteger &&)=default
SymbolicInteger(SymbolicInteger &&)=default
const char * AsSym() const
Definition onnxruntime_cxx_api.h:3180
SymbolicInteger(int64_t i)
Definition onnxruntime_cxx_api.h:3159
SymbolicInteger(const char *s)
Definition onnxruntime_cxx_api.h:3160
bool IsInt() const
Definition onnxruntime_cxx_api.h:3178
Provide access to per-node attributes and input shapes, so one could compute and set output shapes.
Definition onnxruntime_cxx_api.h:3157
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:3192
std::vector< float > Floats
Definition onnxruntime_cxx_api.h:3209
std::string GetAttrString(const char *attr_name)
std::vector< int64_t > Ints
Definition onnxruntime_cxx_api.h:3204
ShapeInferContext(const OrtApi *ort_api, OrtShapeInferContext *ctx)
int64_t GetAttrInt(const char *attr_name)
size_t GetInputCount() const
Definition onnxruntime_cxx_api.h:3198
std::vector< std::string > Strings
Definition onnxruntime_cxx_api.h:3214
Floats GetAttrFloats(const char *attr_name)
const Shape & GetInputShape(size_t indice) const
Definition onnxruntime_cxx_api.h:3196
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:814
OrtErrorCode GetErrorCode() const
Status(const Exception &)
Creates status instance out of exception.
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()=default
Status(const std::exception &)
Creates status instance out of exception.
Status(const char *message, OrtErrorCode code)
Creates status instance out of null-terminated string message.
Status(std::nullptr_t) noexcept
Create an empty object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:816
Definition onnxruntime_cxx_api.h:1107
SyncStream(OrtSyncStream *p)
Definition onnxruntime_cxx_api.h:1111
SyncStream(std::nullptr_t)
< Create an empty SyncStream object, must be assigned a valid one to be used
Definition onnxruntime_cxx_api.h:1109
The TensorRTOptions (V2)
Definition onnxruntime_cxx_api.h:860
void Update(const std::unordered_map< std::string, std::string > &options)
Wrapper around OrtApi::UpdateTensorRTProviderOptions.
void UpdateWithValue(const char *key, void *value)
Wrapper around OrtApi::GetTensorRTProviderOptionsByName.
std::string GetTensorRTProviderOptionsAsString() const
void * GetOptionByName(const char *name) const
Wrapper around OrtApi::GetTensorRTProviderOptionsAsString.
TensorRTProviderOptions(std::nullptr_t)
Definition onnxruntime_cxx_api.h:861
TensorRTProviderOptions()
Wraps OrtApi::CreateTensorRTProviderOptionsV2.
Wrapper around OrtTensorTypeAndShapeInfo.
Definition onnxruntime_cxx_api.h:2099
TensorTypeAndShapeInfo(std::nullptr_t)
Create an empty TensorTypeAndShapeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2104
ConstTensorTypeAndShapeInfo GetConst() const
Definition onnxruntime_cxx_api.h:2115
TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:2106
TensorTypeAndShapeInfo(ONNXTensorElementDataType element_type, const std::vector< int64_t > &dims, const std::vector< std::string > *symbolic_dims=nullptr)
The ThreadingOptions.
Definition onnxruntime_cxx_api.h:830
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:2205
static TypeInfo CreateOptionalTypeInfo(ConstTypeInfo contained_type)
static TypeInfo CreateSequenceTypeInfo(ConstTypeInfo sequence_type)
static TypeInfo CreateTensorInfo(ConstTensorTypeAndShapeInfo tensor_info)
static TypeInfo CreateSparseTensorInfo(ConstTensorTypeAndShapeInfo sparse_tensor_info)
TypeInfo(std::nullptr_t)
Create an empty TypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2210
static TypeInfo CreateMapTypeInfo(ONNXTensorElementDataType key_type, ConstTypeInfo value_type)
ConstTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:2221
TypeInfo(OrtTypeInfo *p)
C API Interop.
Definition onnxruntime_cxx_api.h:2211
Wrapper around OrtValue.
Definition onnxruntime_cxx_api.h:2578
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(Value &&)=default
Value(std::nullptr_t)
Create an empty Value object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:2584
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.
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:2589
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...
static Value CreateTensor(OrtAllocator *deleter, 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::CreateTensorWithDataAndDeleterAsOrtValue.
ConstValue GetConst() const
Definition onnxruntime_cxx_api.h:2588
Definition onnxruntime_cxx_api.h:3505
int64_t index
Definition onnxruntime_cxx_api.h:3509
ConstNode node
Definition onnxruntime_cxx_api.h:3506
Wrapper around OrtValueInfo.
Definition onnxruntime_cxx_api.h:3410
ConstValueInfo GetConst() const
Definition onnxruntime_cxx_api.h:3420
ValueInfo(std::nullptr_t)
Definition onnxruntime_cxx_api.h:3412
ValueInfo(const std::string &name, const ConstTypeInfo &type_info)
ValueInfo(OrtValueInfo *p)
Take ownership of a pointer created by C API.
Definition onnxruntime_cxx_api.h:3414
ValueInfo()=default
Definition onnxruntime_cxx_api.h:776
AllocatedFree(OrtAllocator *allocator)
Definition onnxruntime_cxx_api.h:778
OrtAllocator * allocator_
Definition onnxruntime_cxx_api.h:777
void operator()(void *ptr) const
Definition onnxruntime_cxx_api.h:780
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:762
constexpr contained_type & operator*() const noexcept
Definition onnxruntime_cxx_api.h:769
typename Unowned< T >::Type contained_type
Definition onnxruntime_cxx_api.h:751
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:761
Base(const Base &)=default
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:754
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:704
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:716
constexpr Base()=default
constexpr contained_type & operator*() const noexcept
Definition onnxruntime_cxx_api.h:724
contained_type * release()
Relinquishes ownership of the contained C object pointer The underlying object is not destroyed.
Definition onnxruntime_cxx_api.h:728
Base(const Base &)=delete
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:708
Base & operator=(const Base &)=delete
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:717
contained_type * p_
Definition onnxruntime_cxx_api.h:735
~Base()
Definition onnxruntime_cxx_api.h:709
T contained_type
Definition onnxruntime_cxx_api.h:705
Definition onnxruntime_cxx_api.h:910
const std::basic_string< char > GetFilePath() const
Definition onnxruntime_cxx_api.h:3520
std::vector< ConstNode > GetNodes() const
std::vector< ConstValueInfo > GetInputs() const
ConstNode GetParentNode() const
int64_t GetOnnxIRVersion() const
std::basic_string< char > GetModelPath() const
Graph GetGraphView(const std::vector< ConstNode > &nodes) const
ModelMetadata GetModelMetadata() const
Wraps OrtApi::Graph_GetModelMetadata.
std::vector< ConstValueInfo > GetInitializers() const
std::string GetName() const
std::vector< ConstValueInfo > GetOutputs() const
std::vector< OperatorSet > GetOperatorSets() const
Definition onnxruntime_cxx_api.h:2757
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:3630
std::pair< int, int > GetSinceVersion() const
Wraps OrtEpApi::KernelDef_GetExecutionProvider.
const char * GetDomain() const
Wraps OrtEpApi::KernelDef_GetSinceVersion.
OrtMemType GetOutputMemType(size_t output_index) const
const char * GetExecutionProvider() const
Wraps OrtEpApi::KernelDef_GetInputMemType.
OrtMemType GetInputMemType(size_t input_index) const
Wraps OrtEpApi::KernelDef_GetOutputMemType.
const char * GetOperatorType() const
< Wraps OrtEpApi::KernelDef_GetOperatorType
Definition onnxruntime_cxx_api.h:3432
std::vector< ConstValueInfo > GetOutputs() const
std::vector< ConstValueInfo > GetImplicitInputs() const
std::string GetName() const
std::string GetDomain() const
std::vector< AttrNameSubgraph > GetSubgraphs() const
ConstGraphImpl< detail::Unowned< const OrtGraph > > GetGraph() const
std::string GetOperatorType() const
std::vector< ConstOpAttr > GetAttributes() const
std::vector< ConstValueInfo > GetInputs() const
Status GetAttributeByName(const std::string &name, ConstOpAttr &attr) const
std::string GetEpName() const
Definition onnxruntime_cxx_api.h:2826
std::string GetName() const
Status GetValue(R &out) const
Status GetTensorAttributeAsOrtValue(Value &) const
Status GetValueArray(std::vector< R > &out) const
OrtOpAttrType GetType() const
Definition onnxruntime_cxx_api.h:1266
int64_t GetTimestampUs() const
Get the start timestamp in microseconds. Wraps OrtEpApi::ProfilingEvent_GetTimestampUs.
const char * GetName() const
Get the event name. Wraps OrtEpApi::ProfilingEvent_GetName.
const char * GetArgValue(const char *key) const
Get the value of an event argument by key. Wraps OrtEpApi::ProfilingEvent_GetArgValue.
int64_t GetDurationUs() const
Get the duration in microseconds. Wraps OrtEpApi::ProfilingEvent_GetDurationUs.
OrtProfilingEventCategory GetCategory() const
Get the event category. Wraps OrtEpApi::ProfilingEvent_GetCategory.
Definition onnxruntime_cxx_api.h:1870
std::vector< std::string > GetOutputNames() const
TypeInfo GetInputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetInputTypeInfo.
std::vector< ConstEpAssignedSubgraph > GetEpGraphAssignmentInfo() const
Returns information on the subgraph/nodes assigned to execution providers in the session.
size_t GetOutputCount() const
Returns the number of model outputs.
std::vector< ValueInfo > GetOutputs() const
int GetOpset(const std::string &domain) const
Wraps OrtApi::SessionGetOpsetForDomain.
uint64_t GetProfilingStartTimeNs() const
Wraps OrtApi::SessionGetProfilingStartTimeNs.
std::vector< ConstEpDevice > GetEpDeviceForOutputs() const
Wrapper for OrtApi::SessionGetEpDeviceForOutputs.
std::vector< std::string > GetOverridableInitializerNames() const
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.
std::vector< std::string > GetInputNames() const
AllocatedStringPtr GetOverridableInitializerNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of the overridable initializer name at then specified index.
std::vector< ConstEpDevice > GetEpDeviceForInputs() const
Wrapper for OrtApi::SessionGetEpDeviceForInputs.
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.
std::vector< ConstMemoryInfo > GetMemoryInfoForOutputs() const
Wrapper for OrtApi::SessionGetMemoryInfoForOutputs.
AllocatedStringPtr GetInputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of input name at the specified index.
std::vector< ConstMemoryInfo > GetMemoryInfoForInputs() const
Wrapper for OrtApi::SessionGetMemoryInfoForInputs.
std::vector< ValueInfo > GetInputs() const
TypeInfo GetOverridableInitializerTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOverridableInitializerTypeInfo.
Definition onnxruntime_cxx_api.h:2250
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.
size_t GetTensorSizeInBytes() const
Returns the total size of the tensor data in bytes. Throws an exception if the OrtValue does not cont...
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....
void GetTensorElementTypeAndShapeDataReference(ONNXTensorElementDataType &elem_type, Shape &shape) const
Returns the tensor's element type and a reference to the tensor's internal shape data....
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:3375
Status GetInitializer(ConstValue &value) const
< A wrapper around OrtApi::ValueInfo_GetInitializerValue
std::string GetName() const
< A wrapper around OrtApi::GetValueInfoName
bool IsFromOuterScope() const
< A wrapper around OrtApi::ValueInfo_IsFromOuterScope
Status GetExternalInitializerInfo(ExternalInitializerInfo &info) const
< A wrapper around OrtApi::ValueInfo_GetExternalInitializerInfo
bool IsConstantInitializer() const
< A wrapper around OrtApi::ValueInfo_IsConstantInitializer
std::vector< ValueInfoConsumerProducerInfo > GetConsumers() const
< A wrapper around OrtApi::ValueInfo_GetValueConsumers
bool IsGraphOutput() const
< A wrapper around OrtApi::ValueInfo_IsGraphOutput
bool IsRequiredGraphInput() const
< A wrapper around OrtApi::ValueInfo_IsRequiredGraphInput
ConstTypeInfo TypeInfo() const
< A wrapper around OrtApi::GetValueInfoTypeInfo
ValueInfoConsumerProducerInfo GetProducerNode() const
bool IsOptionalGraphInput() const
< A wrapper around OrtApi::ValueInfo_IsOptionalGraphInput
Definition onnxruntime_cxx_api.h:1137
uint32_t GetReasonsBitmask() const
Wraps DeviceEpIncompatibilityDetails_GetReasonsBitmask.
const char * GetNotes() const
Wraps DeviceEpIncompatibilityDetails_GetNotes.
int32_t GetErrorCode() const
Wraps DeviceEpIncompatibilityDetails_GetErrorCode.
Definition onnxruntime_cxx_api.h:1233
std::string GetDomain() const
std::string GetOperatorType() const
std::string GetName() const
Definition onnxruntime_cxx_api.h:1250
std::vector< ConstEpAssignedNode > GetNodes() const
Definition onnxruntime_cxx_api.h:1158
const char * EpName() const
const char * EpVendor() const
ConstKeyValuePairs EpOptions() const
ConstHardwareDevice Device() const
ConstMemoryInfo GetMemoryInfo(OrtDeviceMemoryType memory_type) const
Wraps EpDevice_MemoryInfo.
SyncStream CreateSyncStream(ConstKeyValuePairs stream_options={}) const
ConstKeyValuePairs EpMetadata() const
Definition onnxruntime_cxx_api.h:3549
void SetInputs(std::vector< ValueInfo > &inputs)
void SetOutputs(std::vector< ValueInfo > &outputs)
void AddNode(Node &node)
void AddInitializer(const std::string &name, Value &initializer, bool data_is_external)
Definition onnxruntime_cxx_api.h:1118
OrtHardwareDeviceType Type() const
const char * Vendor() const
ConstKeyValuePairs Metadata() const
Definition onnxruntime_cxx_api.h:2768
void BindOutput(const char *name, const Value &)
void BindInput(const char *name, const Value &)
void BindOutput(const char *name, const OrtMemoryInfo *)
Definition onnxruntime_cxx_api.h:950
void GetKeyValuePairs(std::vector< const char * > &keys, std::vector< const char * > &values) const
std::unordered_map< std::string, std::string > GetKeyValuePairs() const
const char * GetValue(const char *key) const
Definition onnxruntime_cxx_api.h:2157
ONNXTensorElementDataType GetMapKeyType() const
Wraps OrtApi::GetMapKeyType.
TypeInfo GetMapValueType() const
Wraps OrtApi::GetMapValueType.
Definition onnxruntime_cxx_api.h:989
std::string GetAllocatorName() const
Wrapper MemoryInfoGetName.
int GetDeviceId() const
Wrapper MemoryInfoGetId.
OrtMemType GetMemoryType() const
Wrapper MemoryInfoGetMemType.
OrtDeviceMemoryType GetDeviceMemoryType() const
Wrapper MemoryInfoGetDeviceMemType.
OrtMemoryInfoDeviceType GetDeviceType() const
Wrapper MemoryInfoGetDeviceType.
OrtAllocatorType GetAllocatorType() const
Wrapper MemoryInfoGetType.
uint32_t GetVendorId() const
Wrapper MemoryInfoGetVendorId.
bool operator==(const MemoryInfoImpl< U > &o) const
Definition onnxruntime_cxx_api.h:3597
void AddGraph(Graph &graph)
Definition onnxruntime_cxx_api.h:3739
std::string GetInputName(size_t index) const
int GetSinceVersion() const
< Wraps OrtEpApi::OpSchema_GetSinceVersion
size_t GetNumOutputs() const
Wraps OrtEpApi::OpSchema_GetOutputName.
ConstOpSchemaTypeConstraint GetOutputTypeConstraint(size_t index) const
Wraps OrtEpApi::OpSchema_GetTypeConstraintCount.
size_t GetTypeConstraintCount() const
Wraps OrtEpApi::OpSchema_GetTypeConstraint. Returns the i-th type constraint.
ConstOpSchemaTypeConstraint GetInputTypeConstraint(size_t index) const
Wraps OrtEpApi::OpSchema_GetNumOutputs.
size_t GetNumInputs() const
Wraps OrtEpApi::OpSchema_GetInputName.
std::string GetOutputName(size_t index) const
ConstOpSchemaTypeConstraint GetTypeConstraint(size_t index) const
Definition onnxruntime_cxx_api.h:3714
std::vector< size_t > GetOutputIndices() const
std::vector< size_t > GetInputIndices() const
Wraps OrtEpApi::OpSchemaTypeConstraint_GetOutputIndices.
std::vector< std::string > GetAllowedTypes() const
Wraps OrtEpApi::OpSchemaTypeConstraint_GetInputIndices.
std::string GetTypeParamName() const
< Wraps OrtEpApi::OpSchemaTypeConstraint_GetTypeParamName
Definition onnxruntime_cxx_api.h:2144
TypeInfo GetOptionalElementType() const
Wraps OrtApi::CastOptionalTypeToContainedTypeInfo.
Definition onnxruntime_cxx_api.h:2233
const char ** str
Definition onnxruntime_cxx_api.h:2238
const int64_t * values_shape
Definition onnxruntime_cxx_api.h:2234
size_t values_shape_len
Definition onnxruntime_cxx_api.h:2235
const void * p_data
Definition onnxruntime_cxx_api.h:2237
Definition onnxruntime_cxx_api.h:1335
Ort::Status AddEvents(const std::vector< ProfilingEvent > &events)
Ort::Status AddEvents(const OrtProfilingEvent *const *events, size_t num_events)
Adds profiling events to this container. Events are copied. Wraps OrtEpApi::ProfilingEventsContainer_...
Definition onnxruntime_cxx_api.h:2120
TypeInfo GetSequenceElementType() const
Wraps OrtApi::GetSequenceElementType.
Definition onnxruntime_cxx_api.h:1934
void SetEpDynamicOptions(const char *const *keys, const char *const *values, size_t kv_len)
Set DynamicOptions for EPs (Execution Providers)
AllocatedStringPtr EndProfilingAllocated(OrtAllocator *allocator)
End profiling and return a copy of the profiling file name.
void ReleaseCapturedGraph(int graph_annotation_id)
Release a previously captured graph.
void FinalizeModelEditorSession(const Model &model, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container=nullptr)
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:2244
const int64_t * shape
Definition onnxruntime_cxx_api.h:2245
size_t shape_len
Definition onnxruntime_cxx_api.h:2246
Definition onnxruntime_cxx_api.h:3789
Status StoreWeightData(void **buffer_data_ptrs, size_t *buffer_sizes, size_t num_buffers)
Definition onnxruntime_cxx_api.h:1099
void * GetHandle()
Wraps SyncStream_GetHandle.
Definition onnxruntime_cxx_api.h:2065
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.
std::vector< const char * > GetSymbolicDimensions() const
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.
bool HasShape() const
Wraps OrtApi::TensorTypeAndShape_HasShape.
Definition onnxruntime_cxx_api.h:2182
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:680
T Type
Definition onnxruntime_cxx_api.h:681
Definition onnxruntime_cxx_api.h:2436
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:358
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:365
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:939
The C API.
Definition onnxruntime_c_api.h:1307
const OrtEpApi *(* GetEpApi)(void)
Get the OrtEpApi instance for implementing an execution provider.
Definition onnxruntime_c_api.h:5779
const OrtInteropApi *(* GetInteropApi)(void)
Get the EP Interop API instance.
Definition onnxruntime_c_api.h:7027
const OrtCompileApi *(* GetCompileApi)(void)
Get the Compile API instance.
Definition onnxruntime_c_api.h:5511
void(* ReleaseTensorRTProviderOptions)(OrtTensorRTProviderOptionsV2 *input)
Release an OrtTensorRTProviderOptionsV2.
Definition onnxruntime_c_api.h:3564
const OrtModelEditorApi *(* GetModelEditorApi)(void)
Get the Model Editor API instance.
Definition onnxruntime_c_api.h:5453
void(* ReleaseCUDAProviderOptions)(OrtCUDAProviderOptionsV2 *input)
Release an OrtCUDAProviderOptionsV2.
Definition onnxruntime_c_api.h:4067
CUDA Provider Options.
Definition onnxruntime_c_api.h:639
The OrtCompileApi struct provides functions to compile ONNX models.
Definition onnxruntime_c_api.h:8176
Definition onnxruntime_c_api.h:7622
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7671
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7655
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7643
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7675
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7708
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7693
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7705
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7636
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7645
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:7651
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7680
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7662
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:7632
uint32_t version
Definition onnxruntime_c_api.h:7623
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7642
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:7709
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7654
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7639
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:7644
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7666
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:7690
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:7694
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:7683
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:7701
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7688
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:7650
Configuration options for creating an OrtEnv.
Definition onnxruntime_c_api.h:1219
The OrtEpApi struct provides functions that are relevant to the implementation of an execution provid...
Definition onnxruntime_ep_c_api.h:1021
The OrtEpFactory provides functions to create and manage execution providers.
Definition onnxruntime_ep_c_api.h:2753
The OrtEp struct provides functions to implement for an execution provider.
Definition onnxruntime_ep_c_api.h:2164
The OrtInteropApi struct provides functions for external resource interop with execution providers.
Definition onnxruntime_c_api.h:8497
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:843
The OrtModelEditorApi struct provides functions to create or edit an ONNX model.
Definition onnxruntime_c_api.h:7723
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:882
ROCM Provider Options.
Definition onnxruntime_c_api.h:726
TensorRT Provider Options.
Definition onnxruntime_c_api.h:815
Configuration for thread pool work callbacks.
Definition onnxruntime_c_api.h:1032