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 <cstddef>
30#include <cstdio>
31#include <array>
32#include <memory>
33#include <stdexcept>
34#include <string>
35#include <vector>
36#include <unordered_map>
37#include <utility>
38#include <type_traits>
39
40#ifdef ORT_NO_EXCEPTIONS
41#include <iostream>
42#endif
43
47namespace Ort {
48
53struct Exception : std::exception {
54 Exception(std::string&& string, OrtErrorCode code) : message_{std::move(string)}, code_{code} {}
55
56 OrtErrorCode GetOrtErrorCode() const { return code_; }
57 const char* what() const noexcept override { return message_.c_str(); }
58
59 private:
60 std::string message_;
61 OrtErrorCode code_;
62};
63
64#ifdef ORT_NO_EXCEPTIONS
65// The #ifndef is for the very special case where the user of this library wants to define their own way of handling errors.
66// NOTE: This header expects control flow to not continue after calling ORT_CXX_API_THROW
67#ifndef ORT_CXX_API_THROW
68#define ORT_CXX_API_THROW(string, code) \
69 do { \
70 std::cerr << Ort::Exception(string, code) \
71 .what() \
72 << std::endl; \
73 abort(); \
74 } while (false)
75#endif
76#else
77#define ORT_CXX_API_THROW(string, code) \
78 throw Ort::Exception(string, code)
79#endif
80
81// This is used internally by the C++ API. This class holds the global variable that points to the OrtApi,
82// it's in a template so that we can define a global variable in a header and make
83// it transparent to the users of the API.
84template <typename T>
85struct Global {
86 static const OrtApi* api_;
87};
88
89// If macro ORT_API_MANUAL_INIT is defined, no static initialization will be performed. Instead, user must call InitApi() before using it.
90template <typename T>
91#ifdef ORT_API_MANUAL_INIT
92const OrtApi* Global<T>::api_{};
93inline void InitApi() noexcept { Global<void>::api_ = OrtGetApiBase()->GetApi(ORT_API_VERSION); }
94
95// Used by custom operator libraries that are not linked to onnxruntime. Sets the global API object, which is
96// required by C++ APIs.
97//
98// Example mycustomop.cc:
99//
100// #define ORT_API_MANUAL_INIT
101// #include <onnxruntime_cxx_api.h>
102// #undef ORT_API_MANUAL_INIT
103//
104// OrtStatus* ORT_API_CALL RegisterCustomOps(OrtSessionOptions* options, const OrtApiBase* api_base) {
105// Ort::InitApi(api_base->GetApi(ORT_API_VERSION));
106// // ...
107// }
108//
109inline void InitApi(const OrtApi* api) noexcept { Global<void>::api_ = api; }
110#else
111#if defined(_MSC_VER) && !defined(__clang__)
112#pragma warning(push)
113// "Global initializer calls a non-constexpr function." Therefore you can't use ORT APIs in the other global initializers.
114// Please define ORT_API_MANUAL_INIT if it conerns you.
115#pragma warning(disable : 26426)
116#endif
118#if defined(_MSC_VER) && !defined(__clang__)
119#pragma warning(pop)
120#endif
121#endif
122
124inline const OrtApi& GetApi() noexcept { return *Global<void>::api_; }
125
130std::string GetVersionString();
131
137std::string GetBuildInfoString();
138
144std::vector<std::string> GetAvailableProviders();
145
164struct Float16_t : onnxruntime_float16::Float16Impl<Float16_t> {
165 private:
171 constexpr explicit Float16_t(uint16_t v) noexcept { val = v; }
172
173 public:
174 using Base = onnxruntime_float16::Float16Impl<Float16_t>;
175
179 Float16_t() = default;
180
186 constexpr static Float16_t FromBits(uint16_t v) noexcept { return Float16_t(v); }
187
192 explicit Float16_t(float v) noexcept { val = Base::ToUint16Impl(v); }
193
198 float ToFloat() const noexcept { return Base::ToFloatImpl(); }
199
204 using Base::IsNegative;
205
210 using Base::IsNaN;
211
216 using Base::IsFinite;
217
222 using Base::IsPositiveInfinity;
223
228 using Base::IsNegativeInfinity;
229
234 using Base::IsInfinity;
235
240 using Base::IsNaNOrZero;
241
246 using Base::IsNormal;
247
252 using Base::IsSubnormal;
253
258 using Base::Abs;
259
264 using Base::Negate;
265
274 using Base::AreZero;
275
279 explicit operator float() const noexcept { return ToFloat(); }
280
281 using Base::operator==;
282 using Base::operator!=;
283 using Base::operator<;
284};
285
286static_assert(sizeof(Float16_t) == sizeof(uint16_t), "Sizes must match");
287
306struct BFloat16_t : onnxruntime_float16::BFloat16Impl<BFloat16_t> {
307 private:
315 constexpr explicit BFloat16_t(uint16_t v) noexcept { val = v; }
316
317 public:
318 using Base = onnxruntime_float16::BFloat16Impl<BFloat16_t>;
319
320 BFloat16_t() = default;
321
327 static constexpr BFloat16_t FromBits(uint16_t v) noexcept { return BFloat16_t(v); }
328
333 explicit BFloat16_t(float v) noexcept { val = Base::ToUint16Impl(v); }
334
339 float ToFloat() const noexcept { return Base::ToFloatImpl(); }
340
345 using Base::IsNegative;
346
351 using Base::IsNaN;
352
357 using Base::IsFinite;
358
363 using Base::IsPositiveInfinity;
364
369 using Base::IsNegativeInfinity;
370
375 using Base::IsInfinity;
376
381 using Base::IsNaNOrZero;
382
387 using Base::IsNormal;
388
393 using Base::IsSubnormal;
394
399 using Base::Abs;
400
405 using Base::Negate;
406
415 using Base::AreZero;
416
420 explicit operator float() const noexcept { return ToFloat(); }
421
422 // We do not have an inherited impl for the below operators
423 // as the internal class implements them a little differently
424 bool operator==(const BFloat16_t& rhs) const noexcept;
425 bool operator!=(const BFloat16_t& rhs) const noexcept { return !(*this == rhs); }
426 bool operator<(const BFloat16_t& rhs) const noexcept;
427};
428
429static_assert(sizeof(BFloat16_t) == sizeof(uint16_t), "Sizes must match");
430
437 uint8_t value;
438 constexpr Float8E4M3FN_t() noexcept : value(0) {}
439 constexpr Float8E4M3FN_t(uint8_t v) noexcept : value(v) {}
440 constexpr operator uint8_t() const noexcept { return value; }
441 // nan values are treated like any other value for operator ==, !=
442 constexpr bool operator==(const Float8E4M3FN_t& rhs) const noexcept { return value == rhs.value; };
443 constexpr bool operator!=(const Float8E4M3FN_t& rhs) const noexcept { return value != rhs.value; };
444};
445
446static_assert(sizeof(Float8E4M3FN_t) == sizeof(uint8_t), "Sizes must match");
447
454 uint8_t value;
455 constexpr Float8E4M3FNUZ_t() noexcept : value(0) {}
456 constexpr Float8E4M3FNUZ_t(uint8_t v) noexcept : value(v) {}
457 constexpr operator uint8_t() const noexcept { return value; }
458 // nan values are treated like any other value for operator ==, !=
459 constexpr bool operator==(const Float8E4M3FNUZ_t& rhs) const noexcept { return value == rhs.value; };
460 constexpr bool operator!=(const Float8E4M3FNUZ_t& rhs) const noexcept { return value != rhs.value; };
461};
462
463static_assert(sizeof(Float8E4M3FNUZ_t) == sizeof(uint8_t), "Sizes must match");
464
471 uint8_t value;
472 constexpr Float8E5M2_t() noexcept : value(0) {}
473 constexpr Float8E5M2_t(uint8_t v) noexcept : value(v) {}
474 constexpr operator uint8_t() const noexcept { return value; }
475 // nan values are treated like any other value for operator ==, !=
476 constexpr bool operator==(const Float8E5M2_t& rhs) const noexcept { return value == rhs.value; };
477 constexpr bool operator!=(const Float8E5M2_t& rhs) const noexcept { return value != rhs.value; };
478};
479
480static_assert(sizeof(Float8E5M2_t) == sizeof(uint8_t), "Sizes must match");
481
488 uint8_t value;
489 constexpr Float8E5M2FNUZ_t() noexcept : value(0) {}
490 constexpr Float8E5M2FNUZ_t(uint8_t v) noexcept : value(v) {}
491 constexpr operator uint8_t() const noexcept { return value; }
492 // nan values are treated like any other value for operator ==, !=
493 constexpr bool operator==(const Float8E5M2FNUZ_t& rhs) const noexcept { return value == rhs.value; };
494 constexpr bool operator!=(const Float8E5M2FNUZ_t& rhs) const noexcept { return value != rhs.value; };
495};
496
497static_assert(sizeof(Float8E5M2FNUZ_t) == sizeof(uint8_t), "Sizes must match");
498
499namespace detail {
500// 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
501// This can't be done in the C API since C doesn't have function overloading.
502#define ORT_DEFINE_RELEASE(NAME) \
503 inline void OrtRelease(Ort##NAME* ptr) { GetApi().Release##NAME(ptr); }
504
505ORT_DEFINE_RELEASE(Allocator);
506ORT_DEFINE_RELEASE(MemoryInfo);
507ORT_DEFINE_RELEASE(CustomOpDomain);
508ORT_DEFINE_RELEASE(ThreadingOptions);
509ORT_DEFINE_RELEASE(Env);
510ORT_DEFINE_RELEASE(RunOptions);
511ORT_DEFINE_RELEASE(Session);
512ORT_DEFINE_RELEASE(SessionOptions);
513ORT_DEFINE_RELEASE(TensorTypeAndShapeInfo);
514ORT_DEFINE_RELEASE(SequenceTypeInfo);
515ORT_DEFINE_RELEASE(MapTypeInfo);
516ORT_DEFINE_RELEASE(TypeInfo);
517ORT_DEFINE_RELEASE(Value);
518ORT_DEFINE_RELEASE(ModelMetadata);
519ORT_DEFINE_RELEASE(IoBinding);
520ORT_DEFINE_RELEASE(ArenaCfg);
521ORT_DEFINE_RELEASE(Status);
522ORT_DEFINE_RELEASE(OpAttr);
523ORT_DEFINE_RELEASE(Op);
524ORT_DEFINE_RELEASE(KernelInfo);
525
526#undef ORT_DEFINE_RELEASE
527
531template <typename T>
532struct Unowned {
533 using Type = T;
534};
535
555template <typename T>
556struct Base {
557 using contained_type = T;
558
559 constexpr Base() = default;
560 constexpr explicit Base(contained_type* p) noexcept : p_{p} {}
562
563 Base(const Base&) = delete;
564 Base& operator=(const Base&) = delete;
565
566 Base(Base&& v) noexcept : p_{v.p_} { v.p_ = nullptr; }
567 Base& operator=(Base&& v) noexcept {
568 OrtRelease(p_);
569 p_ = v.release();
570 return *this;
571 }
572
573 constexpr operator contained_type*() const noexcept { return p_; }
574
578 T* p = p_;
579 p_ = nullptr;
580 return p;
581 }
582
583 protected:
585};
586
587// Undefined. For const types use Base<Unowned<const T>>
588template <typename T>
589struct Base<const T>;
590
598template <typename T>
599struct Base<Unowned<T>> {
601
602 constexpr Base() = default;
603 constexpr explicit Base(contained_type* p) noexcept : p_{p} {}
604
605 ~Base() = default;
606
607 Base(const Base&) = default;
608 Base& operator=(const Base&) = default;
609
610 Base(Base&& v) noexcept : p_{v.p_} { v.p_ = nullptr; }
611 Base& operator=(Base&& v) noexcept {
612 p_ = nullptr;
613 std::swap(p_, v.p_);
614 return *this;
615 }
616
617 constexpr operator contained_type*() const noexcept { return p_; }
618
619 protected:
621};
622
623// Light functor to release memory with OrtAllocator
626 explicit AllocatedFree(OrtAllocator* allocator)
627 : allocator_(allocator) {}
628 void operator()(void* ptr) const {
629 if (ptr) allocator_->Free(allocator_, ptr);
630 }
631};
632
633} // namespace detail
634
635struct AllocatorWithDefaultOptions;
636struct Env;
637struct TypeInfo;
638struct Value;
639struct ModelMetadata;
640
645using AllocatedStringPtr = std::unique_ptr<char, detail::AllocatedFree>;
646
651struct Status : detail::Base<OrtStatus> {
652 explicit Status(std::nullptr_t) noexcept {}
653 explicit Status(OrtStatus* status) noexcept;
654 explicit Status(const Exception&) noexcept;
655 explicit Status(const std::exception&) noexcept;
656 Status(const char* message, OrtErrorCode code) noexcept;
657 std::string GetErrorMessage() const;
659 bool IsOK() const noexcept;
660};
661
691
697struct Env : detail::Base<OrtEnv> {
698 explicit Env(std::nullptr_t) {}
699
701 Env(OrtLoggingLevel logging_level = ORT_LOGGING_LEVEL_WARNING, _In_ const char* logid = "");
702
704 Env(OrtLoggingLevel logging_level, const char* logid, OrtLoggingFunction logging_function, void* logger_param);
705
707 Env(const OrtThreadingOptions* tp_options, OrtLoggingLevel logging_level = ORT_LOGGING_LEVEL_WARNING, _In_ const char* logid = "");
708
710 Env(const OrtThreadingOptions* tp_options, OrtLoggingFunction logging_function, void* logger_param,
711 OrtLoggingLevel logging_level = ORT_LOGGING_LEVEL_WARNING, _In_ const char* logid = "");
712
714 explicit Env(OrtEnv* p) : Base<OrtEnv>{p} {}
715
718
720
721 Env& CreateAndRegisterAllocator(const OrtMemoryInfo* mem_info, const OrtArenaCfg* arena_cfg);
722
723 Env& CreateAndRegisterAllocatorV2(const std::string& provider_type, const OrtMemoryInfo* mem_info, const std::unordered_map<std::string, std::string>& options, const OrtArenaCfg* arena_cfg);
724};
725
729struct CustomOpDomain : detail::Base<OrtCustomOpDomain> {
730 explicit CustomOpDomain(std::nullptr_t) {}
731
733 explicit CustomOpDomain(const char* domain);
734
735 // This does not take ownership of the op, simply registers it.
736 void Add(const OrtCustomOp* op);
737};
738
742struct RunOptions : detail::Base<OrtRunOptions> {
743 explicit RunOptions(std::nullptr_t) {}
745
748
751
752 RunOptions& SetRunTag(const char* run_tag);
753 const char* GetRunTag() const;
754
755 RunOptions& AddConfigEntry(const char* config_key, const char* config_value);
756
763
769};
770
771namespace detail {
772// Utility function that returns a SessionOption config entry key for a specific custom operator.
773// Ex: custom_op.[custom_op_name].[config]
774std::string MakeCustomOpConfigEntryKey(const char* custom_op_name, const char* config);
775} // namespace detail
776
787 CustomOpConfigs() = default;
788 ~CustomOpConfigs() = default;
793
802 CustomOpConfigs& AddConfig(const char* custom_op_name, const char* config_key, const char* config_value);
803
812 const std::unordered_map<std::string, std::string>& GetFlattenedConfigs() const;
813
814 private:
815 std::unordered_map<std::string, std::string> flat_configs_;
816};
817
823struct SessionOptions;
824
825namespace detail {
826// we separate const-only methods because passing const ptr to non-const methods
827// is only discovered when inline methods are compiled which is counter-intuitive
828template <typename T>
829struct ConstSessionOptionsImpl : Base<T> {
830 using B = Base<T>;
831 using B::B;
832
833 SessionOptions Clone() const;
834
835 std::string GetConfigEntry(const char* config_key) const;
836 bool HasConfigEntry(const char* config_key) const;
837 std::string GetConfigEntryOrDefault(const char* config_key, const std::string& def);
838};
839
840template <typename T>
841struct SessionOptionsImpl : ConstSessionOptionsImpl<T> {
842 using B = ConstSessionOptionsImpl<T>;
843 using B::B;
844
845 SessionOptionsImpl& SetIntraOpNumThreads(int intra_op_num_threads);
846 SessionOptionsImpl& SetInterOpNumThreads(int inter_op_num_threads);
847 SessionOptionsImpl& SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level);
848 SessionOptionsImpl& SetDeterministicCompute(bool value);
849
850 SessionOptionsImpl& EnableCpuMemArena();
851 SessionOptionsImpl& DisableCpuMemArena();
852
853 SessionOptionsImpl& SetOptimizedModelFilePath(const ORTCHAR_T* optimized_model_file);
854
855 SessionOptionsImpl& EnableProfiling(const ORTCHAR_T* profile_file_prefix);
856 SessionOptionsImpl& DisableProfiling();
857
858 SessionOptionsImpl& EnableOrtCustomOps();
859
860 SessionOptionsImpl& EnableMemPattern();
861 SessionOptionsImpl& DisableMemPattern();
862
863 SessionOptionsImpl& SetExecutionMode(ExecutionMode execution_mode);
864
865 SessionOptionsImpl& SetLogId(const char* logid);
866 SessionOptionsImpl& SetLogSeverityLevel(int level);
867
868 SessionOptionsImpl& Add(OrtCustomOpDomain* custom_op_domain);
869
870 SessionOptionsImpl& DisablePerSessionThreads();
871
872 SessionOptionsImpl& AddConfigEntry(const char* config_key, const char* config_value);
873
874 SessionOptionsImpl& AddInitializer(const char* name, const OrtValue* ort_val);
875 SessionOptionsImpl& AddExternalInitializers(const std::vector<std::string>& names, const std::vector<Value>& ort_values);
876 SessionOptionsImpl& AddExternalInitializersFromFilesInMemory(const std::vector<std::basic_string<ORTCHAR_T>>& external_initializer_file_names,
877 const std::vector<char*>& external_initializer_file_buffer_array,
878 const std::vector<size_t>& external_initializer_file_lengths);
879
880 SessionOptionsImpl& AppendExecutionProvider_CUDA(const OrtCUDAProviderOptions& provider_options);
881 SessionOptionsImpl& AppendExecutionProvider_CUDA_V2(const OrtCUDAProviderOptionsV2& provider_options);
882 SessionOptionsImpl& AppendExecutionProvider_ROCM(const OrtROCMProviderOptions& provider_options);
883 SessionOptionsImpl& AppendExecutionProvider_OpenVINO(const OrtOpenVINOProviderOptions& provider_options);
885 SessionOptionsImpl& AppendExecutionProvider_OpenVINO_V2(const std::unordered_map<std::string, std::string>& provider_options = {});
886 SessionOptionsImpl& AppendExecutionProvider_TensorRT(const OrtTensorRTProviderOptions& provider_options);
887 SessionOptionsImpl& AppendExecutionProvider_TensorRT_V2(const OrtTensorRTProviderOptionsV2& provider_options);
888 SessionOptionsImpl& AppendExecutionProvider_MIGraphX(const OrtMIGraphXProviderOptions& provider_options);
890 SessionOptionsImpl& AppendExecutionProvider_CANN(const OrtCANNProviderOptions& provider_options);
892 SessionOptionsImpl& AppendExecutionProvider_Dnnl(const OrtDnnlProviderOptions& provider_options);
894 SessionOptionsImpl& AppendExecutionProvider(const std::string& provider_name,
895 const std::unordered_map<std::string, std::string>& provider_options = {});
896
897 SessionOptionsImpl& SetCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn);
898 SessionOptionsImpl& SetCustomThreadCreationOptions(void* ort_custom_thread_creation_options);
899 SessionOptionsImpl& SetCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn);
900
904 SessionOptionsImpl& RegisterCustomOpsLibrary(const ORTCHAR_T* library_name, const CustomOpConfigs& custom_op_configs = {});
905
906 SessionOptionsImpl& RegisterCustomOpsUsingFunction(const char* function_name);
907
909 SessionOptionsImpl& AppendExecutionProvider_VitisAI(const std::unordered_map<std::string, std::string>& provider_options = {});
910};
911} // namespace detail
912
913using UnownedSessionOptions = detail::SessionOptionsImpl<detail::Unowned<OrtSessionOptions>>;
914using ConstSessionOptions = detail::ConstSessionOptionsImpl<detail::Unowned<const OrtSessionOptions>>;
915
919struct SessionOptions : detail::SessionOptionsImpl<OrtSessionOptions> {
920 explicit SessionOptions(std::nullptr_t) {}
922 explicit SessionOptions(OrtSessionOptions* p) : SessionOptionsImpl<OrtSessionOptions>{p} {}
925};
926
930struct ModelMetadata : detail::Base<OrtModelMetadata> {
931 explicit ModelMetadata(std::nullptr_t) {}
933
941
949
957
965
973
980 std::vector<AllocatedStringPtr> GetCustomMetadataMapKeysAllocated(OrtAllocator* allocator) const;
981
992
993 int64_t GetVersion() const;
994};
995
996struct IoBinding;
997
998namespace detail {
999
1000// we separate const-only methods because passing const ptr to non-const methods
1001// is only discovered when inline methods are compiled which is counter-intuitive
1002template <typename T>
1004 using B = Base<T>;
1005 using B::B;
1006
1007 size_t GetInputCount() const;
1008 size_t GetOutputCount() const;
1010
1019
1028
1037
1038 uint64_t GetProfilingStartTimeNs() const;
1040
1041 TypeInfo GetInputTypeInfo(size_t index) const;
1042 TypeInfo GetOutputTypeInfo(size_t index) const;
1044};
1045
1046template <typename T>
1049 using B::B;
1050
1068 std::vector<Value> Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
1069 const char* const* output_names, size_t output_count);
1070
1074 void Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
1075 const char* const* output_names, Value* output_values, size_t output_count);
1076
1077 void Run(const RunOptions& run_options, const IoBinding&);
1078
1098 void RunAsync(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
1099 const char* const* output_names, Value* output_values, size_t output_count, RunAsyncCallbackFn callback, void* user_data);
1100
1108};
1109
1110} // namespace detail
1111
1114
1118struct Session : detail::SessionImpl<OrtSession> {
1119 explicit Session(std::nullptr_t) {}
1120 Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options);
1121 Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options,
1122 OrtPrepackedWeightsContainer* prepacked_weights_container);
1123 Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options);
1124 Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options,
1125 OrtPrepackedWeightsContainer* prepacked_weights_container);
1126
1127 ConstSession GetConst() const { return ConstSession{this->p_}; }
1128 UnownedSession GetUnowned() const { return UnownedSession{this->p_}; }
1129};
1130
1131namespace detail {
1132template <typename T>
1134 using B = Base<T>;
1135 using B::B;
1136
1137 std::string GetAllocatorName() const;
1139 int GetDeviceId() const;
1142
1143 template <typename U>
1144 bool operator==(const MemoryInfoImpl<U>& o) const;
1145};
1146} // namespace detail
1147
1148// Const object holder that does not own the underlying object
1150
1154struct MemoryInfo : detail::MemoryInfoImpl<OrtMemoryInfo> {
1156 explicit MemoryInfo(std::nullptr_t) {}
1157 explicit MemoryInfo(OrtMemoryInfo* p) : MemoryInfoImpl<OrtMemoryInfo>{p} {}
1158 MemoryInfo(const char* name, OrtAllocatorType type, int id, OrtMemType mem_type);
1159 ConstMemoryInfo GetConst() const { return ConstMemoryInfo{this->p_}; }
1160};
1161
1162namespace detail {
1163template <typename T>
1165 using B = Base<T>;
1166 using B::B;
1167
1169 size_t GetElementCount() const;
1170
1171 size_t GetDimensionsCount() const;
1172
1177 [[deprecated("use GetShape()")]] void GetDimensions(int64_t* values, size_t values_count) const;
1178
1179 void GetSymbolicDimensions(const char** values, size_t values_count) const;
1180
1181 std::vector<int64_t> GetShape() const;
1182};
1183
1184} // namespace detail
1185
1187
1192 explicit TensorTypeAndShapeInfo(std::nullptr_t) {}
1193 explicit TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo* p) : TensorTypeAndShapeInfoImpl{p} {}
1195};
1196
1197namespace detail {
1198template <typename T>
1200 using B = Base<T>;
1201 using B::B;
1203};
1204
1205} // namespace detail
1206
1208
1212struct SequenceTypeInfo : detail::SequenceTypeInfoImpl<OrtSequenceTypeInfo> {
1213 explicit SequenceTypeInfo(std::nullptr_t) {}
1214 explicit SequenceTypeInfo(OrtSequenceTypeInfo* p) : SequenceTypeInfoImpl<OrtSequenceTypeInfo>{p} {}
1216};
1217
1218namespace detail {
1219template <typename T>
1221 using B = Base<T>;
1222 using B::B;
1224};
1225
1226} // namespace detail
1227
1228// This is always owned by the TypeInfo and can only be obtained from it.
1230
1231namespace detail {
1232template <typename T>
1239
1240} // namespace detail
1241
1243
1247struct MapTypeInfo : detail::MapTypeInfoImpl<OrtMapTypeInfo> {
1248 explicit MapTypeInfo(std::nullptr_t) {}
1249 explicit MapTypeInfo(OrtMapTypeInfo* p) : MapTypeInfoImpl<OrtMapTypeInfo>{p} {}
1250 ConstMapTypeInfo GetConst() const { return ConstMapTypeInfo{this->p_}; }
1251};
1252
1253namespace detail {
1254template <typename T>
1266} // namespace detail
1267
1273
1278struct TypeInfo : detail::TypeInfoImpl<OrtTypeInfo> {
1279 explicit TypeInfo(std::nullptr_t) {}
1280 explicit TypeInfo(OrtTypeInfo* p) : TypeInfoImpl<OrtTypeInfo>{p} {}
1281
1282 ConstTypeInfo GetConst() const { return ConstTypeInfo{this->p_}; }
1283};
1284
1285namespace detail {
1286// This structure is used to feed sparse tensor values
1287// information for use with FillSparseTensor<Format>() API
1288// if the data type for the sparse tensor values is numeric
1289// use data.p_data, otherwise, use data.str pointer to feed
1290// values. data.str is an array of const char* that are zero terminated.
1291// number of strings in the array must match shape size.
1292// For fully sparse tensors use shape {0} and set p_data/str
1293// to nullptr.
1295 const int64_t* values_shape;
1297 union {
1298 const void* p_data;
1299 const char** str;
1300 } data;
1301};
1302
1303// Provides a way to pass shape in a single
1304// argument
1305struct Shape {
1306 const int64_t* shape;
1308};
1309
1310template <typename T>
1312 using B = Base<T>;
1313 using B::B;
1314
1318 template <typename R>
1319 void GetOpaqueData(const char* domain, const char* type_name, R&) const;
1320
1321 bool IsTensor() const;
1322 bool HasValue() const;
1323
1324 size_t GetCount() const; // If a non tensor, returns 2 for map and N for sequence, where N is the number of elements
1325 Value GetValue(int index, OrtAllocator* allocator) const;
1326
1334
1349 void GetStringTensorContent(void* buffer, size_t buffer_length, size_t* offsets, size_t offsets_count) const;
1350
1357 template <typename R>
1358 const R* GetTensorData() const;
1359
1364 const void* GetTensorRawData() const;
1365
1373
1381
1387
1396 void GetStringTensorElement(size_t buffer_length, size_t element_index, void* buffer) const;
1397
1404 std::string GetStringTensorElement(size_t element_index) const;
1405
1412 size_t GetStringTensorElementLength(size_t element_index) const;
1413
1414#if !defined(DISABLE_SPARSE_TENSORS)
1422
1429
1438
1448 template <typename R>
1449 const R* GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t& num_indices) const;
1450
1455 bool IsSparseTensor() const;
1456
1465 template <typename R>
1466 const R* GetSparseTensorValues() const;
1467
1468#endif
1469};
1470
1471template <typename T>
1474 using B::B;
1475
1481 template <typename R>
1483
1489
1491 // Obtain a reference to an element of data at the location specified
1497 template <typename R>
1498 R& At(const std::vector<int64_t>& location);
1499
1505 void FillStringTensor(const char* const* s, size_t s_len);
1506
1512 void FillStringTensorElement(const char* s, size_t index);
1513
1526 char* GetResizedStringTensorElementBuffer(size_t index, size_t buffer_length);
1527
1528#if !defined(DISABLE_SPARSE_TENSORS)
1537 void UseCooIndices(int64_t* indices_data, size_t indices_num);
1538
1549 void UseCsrIndices(int64_t* inner_data, size_t inner_num, int64_t* outer_data, size_t outer_num);
1550
1559 void UseBlockSparseIndices(const Shape& indices_shape, int32_t* indices_data);
1560
1570 void FillSparseTensorCoo(const OrtMemoryInfo* data_mem_info, const OrtSparseValuesParam& values_param,
1571 const int64_t* indices_data, size_t indices_num);
1572
1584 void FillSparseTensorCsr(const OrtMemoryInfo* data_mem_info,
1585 const OrtSparseValuesParam& values,
1586 const int64_t* inner_indices_data, size_t inner_indices_num,
1587 const int64_t* outer_indices_data, size_t outer_indices_num);
1588
1599 const OrtSparseValuesParam& values,
1600 const Shape& indices_shape,
1601 const int32_t* indices_data);
1602
1603#endif
1604};
1605
1606} // namespace detail
1607
1610
1614struct Value : detail::ValueImpl<OrtValue> {
1618
1619 explicit Value(std::nullptr_t) {}
1620 explicit Value(OrtValue* p) : Base{p} {}
1621 Value(Value&&) = default;
1622 Value& operator=(Value&&) = default;
1623
1624 ConstValue GetConst() const { return ConstValue{this->p_}; }
1625 UnownedValue GetUnowned() const { return UnownedValue{this->p_}; }
1626
1635 template <typename T>
1636 static Value CreateTensor(const OrtMemoryInfo* info, T* p_data, size_t p_data_element_count, const int64_t* shape, size_t shape_len);
1637
1647 static Value CreateTensor(const OrtMemoryInfo* info, void* p_data, size_t p_data_byte_count, const int64_t* shape, size_t shape_len,
1649
1661 template <typename T>
1662 static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len);
1663
1675 static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type);
1676
1685 static Value CreateMap(const Value& keys, const Value& values);
1686
1694 static Value CreateSequence(const std::vector<Value>& values);
1695
1704 template <typename T>
1705 static Value CreateOpaque(const char* domain, const char* type_name, const T& value);
1706
1707#if !defined(DISABLE_SPARSE_TENSORS)
1718 template <typename T>
1719 static Value CreateSparseTensor(const OrtMemoryInfo* info, T* p_data, const Shape& dense_shape,
1720 const Shape& values_shape);
1721
1738 static Value CreateSparseTensor(const OrtMemoryInfo* info, void* p_data, const Shape& dense_shape,
1739 const Shape& values_shape, ONNXTensorElementDataType type);
1740
1750 template <typename T>
1751 static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape);
1752
1764 static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape, ONNXTensorElementDataType type);
1765
1766#endif // !defined(DISABLE_SPARSE_TENSORS)
1767};
1768
1776 MemoryAllocation(OrtAllocator* allocator, void* p, size_t size);
1781 MemoryAllocation& operator=(MemoryAllocation&&) noexcept;
1782
1783 void* get() { return p_; }
1784 size_t size() const { return size_; }
1785
1786 private:
1787 OrtAllocator* allocator_;
1788 void* p_;
1789 size_t size_;
1790};
1791
1792namespace detail {
1793template <typename T>
1794struct AllocatorImpl : Base<T> {
1795 using B = Base<T>;
1796 using B::B;
1797
1798 void* Alloc(size_t size);
1799 MemoryAllocation GetAllocation(size_t size);
1800 void Free(void* p);
1801 ConstMemoryInfo GetInfo() const;
1802};
1803
1804} // namespace detail
1805
1809struct AllocatorWithDefaultOptions : detail::AllocatorImpl<detail::Unowned<OrtAllocator>> {
1810 explicit AllocatorWithDefaultOptions(std::nullptr_t) {}
1812};
1813
1817struct Allocator : detail::AllocatorImpl<OrtAllocator> {
1818 explicit Allocator(std::nullptr_t) {}
1819 Allocator(const Session& session, const OrtMemoryInfo*);
1820};
1821
1822using UnownedAllocator = detail::AllocatorImpl<detail::Unowned<OrtAllocator>>;
1823
1824namespace detail {
1825namespace binding_utils {
1826// Bring these out of template
1827std::vector<std::string> GetOutputNamesHelper(const OrtIoBinding* binding, OrtAllocator*);
1828std::vector<Value> GetOutputValuesHelper(const OrtIoBinding* binding, OrtAllocator*);
1829} // namespace binding_utils
1830
1831template <typename T>
1833 using B = Base<T>;
1834 using B::B;
1835
1836 std::vector<std::string> GetOutputNames() const;
1837 std::vector<std::string> GetOutputNames(OrtAllocator*) const;
1838 std::vector<Value> GetOutputValues() const;
1839 std::vector<Value> GetOutputValues(OrtAllocator*) const;
1840};
1841
1842template <typename T>
1845 using B::B;
1846
1847 void BindInput(const char* name, const Value&);
1848 void BindOutput(const char* name, const Value&);
1849 void BindOutput(const char* name, const OrtMemoryInfo*);
1854};
1855
1856} // namespace detail
1857
1860
1864struct IoBinding : detail::IoBindingImpl<OrtIoBinding> {
1865 explicit IoBinding(std::nullptr_t) {}
1866 explicit IoBinding(Session& session);
1867 ConstIoBinding GetConst() const { return ConstIoBinding{this->p_}; }
1868 UnownedIoBinding GetUnowned() const { return UnownedIoBinding{this->p_}; }
1869};
1870
1875struct ArenaCfg : detail::Base<OrtArenaCfg> {
1876 explicit ArenaCfg(std::nullptr_t) {}
1885 ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk);
1886};
1887
1888//
1889// Custom OPs (only needed to implement custom OPs)
1890//
1891
1895struct OpAttr : detail::Base<OrtOpAttr> {
1896 OpAttr(const char* name, const void* data, int len, OrtOpAttrType type);
1897};
1898
1907#define ORT_CXX_LOG(logger, message_severity, message) \
1908 do { \
1909 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1910 Ort::ThrowOnError(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
1911 static_cast<const char*>(__FUNCTION__), message)); \
1912 } \
1913 } while (false)
1914
1923#define ORT_CXX_LOG_NOEXCEPT(logger, message_severity, message) \
1924 do { \
1925 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1926 static_cast<void>(logger.LogMessage(message_severity, ORT_FILE, __LINE__, \
1927 static_cast<const char*>(__FUNCTION__), message)); \
1928 } \
1929 } while (false)
1930
1942#define ORT_CXX_LOGF(logger, message_severity, /*format,*/...) \
1943 do { \
1944 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1945 Ort::ThrowOnError(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
1946 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
1947 } \
1948 } while (false)
1949
1961#define ORT_CXX_LOGF_NOEXCEPT(logger, message_severity, /*format,*/...) \
1962 do { \
1963 if (message_severity >= logger.GetLoggingSeverityLevel()) { \
1964 static_cast<void>(logger.LogFormattedMessage(message_severity, ORT_FILE, __LINE__, \
1965 static_cast<const char*>(__FUNCTION__), __VA_ARGS__)); \
1966 } \
1967 } while (false)
1968
1979struct Logger {
1983 Logger() = default;
1984
1988 explicit Logger(std::nullptr_t) {}
1989
1996 explicit Logger(const OrtLogger* logger);
1997
1998 ~Logger() = default;
1999
2000 Logger(const Logger&) = default;
2001 Logger& operator=(const Logger&) = default;
2002
2003 Logger(Logger&& v) noexcept = default;
2004 Logger& operator=(Logger&& v) noexcept = default;
2005
2012
2025 Status LogMessage(OrtLoggingLevel log_severity_level, const ORTCHAR_T* file_path, int line_number,
2026 const char* func_name, const char* message) const noexcept;
2027
2042 template <typename... Args>
2043 Status LogFormattedMessage(OrtLoggingLevel log_severity_level, const ORTCHAR_T* file_path, int line_number,
2044 const char* func_name, const char* format, Args&&... args) const noexcept;
2045
2046 private:
2047 const OrtLogger* logger_{};
2048 OrtLoggingLevel cached_severity_level_{};
2049};
2050
2059 size_t GetInputCount() const;
2060 size_t GetOutputCount() const;
2061 // If input is optional and is not present, the method returns en empty ConstValue
2062 // which can be compared to nullptr.
2063 ConstValue GetInput(size_t index) const;
2064 // If outout is optional and is not present, the method returns en empty UnownedValue
2065 // which can be compared to nullptr.
2066 UnownedValue GetOutput(size_t index, const int64_t* dim_values, size_t dim_count) const;
2067 UnownedValue GetOutput(size_t index, const std::vector<int64_t>& dims) const;
2068 void* GetGPUComputeStream() const;
2070 OrtAllocator* GetAllocator(const OrtMemoryInfo& memory_info) const;
2071 OrtKernelContext* GetOrtKernelContext() const { return ctx_; }
2072 void ParallelFor(void (*fn)(void*, size_t), size_t total, size_t num_batch, void* usr_data) const;
2073
2074 private:
2075 OrtKernelContext* ctx_;
2076};
2077
2078struct KernelInfo;
2079
2080namespace detail {
2081namespace attr_utils {
2082void GetAttr(const OrtKernelInfo* p, const char* name, float&);
2083void GetAttr(const OrtKernelInfo* p, const char* name, int64_t&);
2084void GetAttr(const OrtKernelInfo* p, const char* name, std::string&);
2085void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<float>&);
2086void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<int64_t>&);
2087} // namespace attr_utils
2088
2089template <typename T>
2090struct KernelInfoImpl : Base<T> {
2091 using B = Base<T>;
2092 using B::B;
2093
2094 KernelInfo Copy() const;
2095
2096 template <typename R> // R is only implemented for float, int64_t, and string
2097 R GetAttribute(const char* name) const {
2098 R val;
2099 attr_utils::GetAttr(this->p_, name, val);
2100 return val;
2101 }
2102
2103 template <typename R> // R is only implemented for std::vector<float>, std::vector<int64_t>
2104 std::vector<R> GetAttributes(const char* name) const {
2105 std::vector<R> result;
2106 attr_utils::GetAttrs(this->p_, name, result);
2107 return result;
2108 }
2109
2110 Value GetTensorAttribute(const char* name, OrtAllocator* allocator) const;
2111
2112 size_t GetInputCount() const;
2113 size_t GetOutputCount() const;
2114
2115 std::string GetInputName(size_t index) const;
2116 std::string GetOutputName(size_t index) const;
2117
2118 TypeInfo GetInputTypeInfo(size_t index) const;
2119 TypeInfo GetOutputTypeInfo(size_t index) const;
2120
2121 ConstValue GetTensorConstantInput(size_t index, int* is_constant) const;
2122
2123 std::string GetNodeName() const;
2124 Logger GetLogger() const;
2125};
2126
2127} // namespace detail
2128
2129using ConstKernelInfo = detail::KernelInfoImpl<detail::Unowned<const OrtKernelInfo>>;
2130
2137struct KernelInfo : detail::KernelInfoImpl<OrtKernelInfo> {
2138 explicit KernelInfo(std::nullptr_t) {}
2139 explicit KernelInfo(OrtKernelInfo* info);
2140 ConstKernelInfo GetConst() const { return ConstKernelInfo{this->p_}; }
2141};
2142
2146struct Op : detail::Base<OrtOp> {
2147 explicit Op(std::nullptr_t) {}
2148
2149 explicit Op(OrtOp*);
2150
2151 static Op Create(const OrtKernelInfo* info, const char* op_name, const char* domain,
2152 int version, const char** type_constraint_names,
2153 const ONNXTensorElementDataType* type_constraint_values,
2154 size_t type_constraint_count,
2155 const OpAttr* attr_values,
2156 size_t attr_count,
2157 size_t input_count, size_t output_count);
2158
2159 void Invoke(const OrtKernelContext* context,
2160 const Value* input_values,
2161 size_t input_count,
2162 Value* output_values,
2163 size_t output_count);
2164
2165 // For easier refactoring
2166 void Invoke(const OrtKernelContext* context,
2167 const OrtValue* const* input_values,
2168 size_t input_count,
2169 OrtValue* const* output_values,
2170 size_t output_count);
2171};
2172
2178 SymbolicInteger(int64_t i) : i_(i), is_int_(true){};
2179 SymbolicInteger(const char* s) : s_(s), is_int_(false){};
2182
2185
2186 bool operator==(const SymbolicInteger& dim) const {
2187 if (is_int_ == dim.is_int_) {
2188 if (is_int_) {
2189 return i_ == dim.i_;
2190 } else {
2191 return std::string{s_} == std::string{dim.s_};
2192 }
2193 }
2194 return false;
2195 }
2196
2197 bool IsInt() const { return is_int_; }
2198 int64_t AsInt() const { return i_; }
2199 const char* AsSym() const { return s_; }
2200
2201 static constexpr int INVALID_INT_DIM = -2;
2202
2203 private:
2204 union {
2205 int64_t i_;
2206 const char* s_;
2207 };
2208 bool is_int_;
2209 };
2210
2211 using Shape = std::vector<SymbolicInteger>;
2212
2214
2215 const Shape& GetInputShape(size_t indice) const { return input_shapes_.at(indice); }
2216
2217 size_t GetInputCount() const { return input_shapes_.size(); }
2218
2219 Status SetOutputShape(size_t indice, const Shape& shape);
2220
2221 int64_t GetAttrInt(const char* attr_name);
2222
2223 using Ints = std::vector<int64_t>;
2224 Ints GetAttrInts(const char* attr_name);
2225
2226 float GetAttrFloat(const char* attr_name);
2227
2228 using Floats = std::vector<float>;
2229 Floats GetAttrFloats(const char* attr_name);
2230
2231 std::string GetAttrString(const char* attr_name);
2232
2233 using Strings = std::vector<std::string>;
2234 Strings GetAttrStrings(const char* attr_name);
2235
2236 private:
2237 const OrtOpAttr* GetAttrHdl(const char* attr_name) const;
2238 const OrtApi* ort_api_;
2240 std::vector<Shape> input_shapes_;
2241};
2242
2244
2245#define MAX_CUSTOM_OP_END_VER (1UL << 31) - 1
2246
2247template <typename TOp, typename TKernel, bool WithStatus = false>
2251 OrtCustomOp::GetName = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetName(); };
2252
2253 OrtCustomOp::GetExecutionProviderType = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetExecutionProviderType(); };
2254
2255 OrtCustomOp::GetInputTypeCount = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetInputTypeCount(); };
2256 OrtCustomOp::GetInputType = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputType(index); };
2257 OrtCustomOp::GetInputMemoryType = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputMemoryType(index); };
2258
2259 OrtCustomOp::GetOutputTypeCount = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetOutputTypeCount(); };
2260 OrtCustomOp::GetOutputType = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetOutputType(index); };
2261
2262#if defined(_MSC_VER) && !defined(__clang__)
2263#pragma warning(push)
2264#pragma warning(disable : 26409)
2265#endif
2266 OrtCustomOp::KernelDestroy = [](void* op_kernel) { delete static_cast<TKernel*>(op_kernel); };
2267#if defined(_MSC_VER) && !defined(__clang__)
2268#pragma warning(pop)
2269#endif
2270 OrtCustomOp::GetInputCharacteristic = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputCharacteristic(index); };
2271 OrtCustomOp::GetOutputCharacteristic = [](const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetOutputCharacteristic(index); };
2272
2273 OrtCustomOp::GetVariadicInputMinArity = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetVariadicInputMinArity(); };
2274 OrtCustomOp::GetVariadicInputHomogeneity = [](const OrtCustomOp* this_) { return static_cast<int>(static_cast<const TOp*>(this_)->GetVariadicInputHomogeneity()); };
2275 OrtCustomOp::GetVariadicOutputMinArity = [](const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetVariadicOutputMinArity(); };
2276 OrtCustomOp::GetVariadicOutputHomogeneity = [](const OrtCustomOp* this_) { return static_cast<int>(static_cast<const TOp*>(this_)->GetVariadicOutputHomogeneity()); };
2277#ifdef __cpp_if_constexpr
2278 if constexpr (WithStatus) {
2279#else
2280 if (WithStatus) {
2281#endif
2282 OrtCustomOp::CreateKernelV2 = [](const OrtCustomOp* this_, const OrtApi* api, const OrtKernelInfo* info, void** op_kernel) -> OrtStatusPtr {
2283 return static_cast<const TOp*>(this_)->CreateKernelV2(*api, info, op_kernel);
2284 };
2285 OrtCustomOp::KernelComputeV2 = [](void* op_kernel, OrtKernelContext* context) -> OrtStatusPtr {
2286 return static_cast<TKernel*>(op_kernel)->ComputeV2(context);
2287 };
2288 } else {
2291
2292 OrtCustomOp::CreateKernel = [](const OrtCustomOp* this_, const OrtApi* api, const OrtKernelInfo* info) { return static_cast<const TOp*>(this_)->CreateKernel(*api, info); };
2293 OrtCustomOp::KernelCompute = [](void* op_kernel, OrtKernelContext* context) {
2294 static_cast<TKernel*>(op_kernel)->Compute(context);
2295 };
2296 }
2297
2298 SetShapeInferFn<TOp>(0);
2299
2300 OrtCustomOp::GetStartVersion = [](const OrtCustomOp* this_) {
2301 return static_cast<const TOp*>(this_)->start_ver_;
2302 };
2303
2304 OrtCustomOp::GetEndVersion = [](const OrtCustomOp* this_) {
2305 return static_cast<const TOp*>(this_)->end_ver_;
2306 };
2307
2310 OrtCustomOp::GetAliasMap = nullptr;
2312 }
2313
2314 // Default implementation of GetExecutionProviderType that returns nullptr to default to the CPU provider
2315 const char* GetExecutionProviderType() const { return nullptr; }
2316
2317 // Default implementations of GetInputCharacteristic() and GetOutputCharacteristic() below
2318 // (inputs and outputs are required by default)
2320 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
2321 }
2322
2324 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
2325 }
2326
2327 // Default implemention of GetInputMemoryType() that returns OrtMemTypeDefault
2328 OrtMemType GetInputMemoryType(size_t /*index*/) const {
2329 return OrtMemTypeDefault;
2330 }
2331
2332 // Default implementation of GetVariadicInputMinArity() returns 1 to specify that a variadic input
2333 // should expect at least 1 argument.
2335 return 1;
2336 }
2337
2338 // Default implementation of GetVariadicInputHomegeneity() returns true to specify that all arguments
2339 // to a variadic input should be of the same type.
2341 return true;
2342 }
2343
2344 // Default implementation of GetVariadicOutputMinArity() returns 1 to specify that a variadic output
2345 // should produce at least 1 output value.
2347 return 1;
2348 }
2349
2350 // Default implementation of GetVariadicOutputHomegeneity() returns true to specify that all output values
2351 // produced by a variadic output should be of the same type.
2353 return true;
2354 }
2355
2356 // Declare list of session config entries used by this Custom Op.
2357 // Implement this function in order to get configs from CustomOpBase::GetSessionConfigs().
2358 // This default implementation returns an empty vector of config entries.
2359 std::vector<std::string> GetSessionConfigKeys() const {
2360 return std::vector<std::string>{};
2361 }
2362
2363 template <typename C>
2364 decltype(&C::InferOutputShape) SetShapeInferFn(decltype(&C::InferOutputShape)) {
2366 ShapeInferContext ctx(&GetApi(), ort_ctx);
2367 return C::InferOutputShape(ctx);
2368 };
2369 return {};
2370 }
2371
2372 template <typename C>
2376
2377 protected:
2378 // Helper function that returns a map of session config entries specified by CustomOpBase::GetSessionConfigKeys.
2379 void GetSessionConfigs(std::unordered_map<std::string, std::string>& out, ConstSessionOptions options) const;
2380
2381 int start_ver_ = 1;
2382 int end_ver_ = MAX_CUSTOM_OP_END_VER;
2383};
2384
2385} // namespace Ort
2386
2387#include "onnxruntime_cxx_inline.h"
struct OrtMemoryInfo OrtMemoryInfo
Definition onnxruntime_c_api.h:282
struct OrtKernelInfo OrtKernelInfo
Definition onnxruntime_c_api.h:368
OrtLoggingLevel
Logging severity levels.
Definition onnxruntime_c_api.h:237
OrtMemoryInfoDeviceType
This mimics OrtDevice type constants so they can be returned in the API.
Definition onnxruntime_c_api.h:392
struct OrtShapeInferContext OrtShapeInferContext
Definition onnxruntime_c_api.h:306
void(* OrtLoggingFunction)(void *param, OrtLoggingLevel severity, const char *category, const char *logid, const char *code_location, const char *message)
Definition onnxruntime_c_api.h:333
void(* OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle)
Custom thread join function.
Definition onnxruntime_c_api.h:715
OrtCustomOpInputOutputCharacteristic
Definition onnxruntime_c_api.h:4685
struct OrtTensorRTProviderOptionsV2 OrtTensorRTProviderOptionsV2
Definition onnxruntime_c_api.h:299
struct OrtOpAttr OrtOpAttr
Definition onnxruntime_c_api.h:304
struct OrtThreadingOptions OrtThreadingOptions
Definition onnxruntime_c_api.h:296
struct OrtSequenceTypeInfo OrtSequenceTypeInfo
Definition onnxruntime_c_api.h:290
struct OrtDnnlProviderOptions OrtDnnlProviderOptions
Definition onnxruntime_c_api.h:302
OrtSparseIndicesFormat
Definition onnxruntime_c_api.h:226
struct OrtPrepackedWeightsContainer OrtPrepackedWeightsContainer
Definition onnxruntime_c_api.h:298
struct OrtCustomOpDomain OrtCustomOpDomain
Definition onnxruntime_c_api.h:293
struct OrtIoBinding OrtIoBinding
Definition onnxruntime_c_api.h:283
OrtAllocatorType
Definition onnxruntime_c_api.h:374
struct OrtOp OrtOp
Definition onnxruntime_c_api.h:303
struct OrtModelMetadata OrtModelMetadata
Definition onnxruntime_c_api.h:294
struct OrtTypeInfo OrtTypeInfo
Definition onnxruntime_c_api.h:287
struct OrtTensorTypeAndShapeInfo OrtTensorTypeAndShapeInfo
Definition onnxruntime_c_api.h:288
struct OrtCUDAProviderOptionsV2 OrtCUDAProviderOptionsV2
Definition onnxruntime_c_api.h:300
struct OrtKernelContext OrtKernelContext
Definition onnxruntime_c_api.h:370
struct OrtCANNProviderOptions OrtCANNProviderOptions
Definition onnxruntime_c_api.h:301
void(* RunAsyncCallbackFn)(void *user_data, OrtValue **outputs, size_t num_outputs, OrtStatusPtr status)
Callback function for RunAsync.
Definition onnxruntime_c_api.h:726
struct OrtSessionOptions OrtSessionOptions
Definition onnxruntime_c_api.h:292
struct OrtValue OrtValue
Definition onnxruntime_c_api.h:285
GraphOptimizationLevel
Graph optimization level.
Definition onnxruntime_c_api.h:342
OrtStatus * OrtStatusPtr
Definition onnxruntime_c_api.h:311
OrtMemType
Memory types for allocated memory, execution provider specific types should be extended in each provi...
Definition onnxruntime_c_api.h:383
OrtSparseFormat
Definition onnxruntime_c_api.h:218
ONNXType
Definition onnxruntime_c_api.h:206
struct OrtEnv OrtEnv
Definition onnxruntime_c_api.h:280
OrtErrorCode
Definition onnxruntime_c_api.h:245
struct OrtStatus OrtStatus
Definition onnxruntime_c_api.h:281
#define ORT_API_VERSION
The API version defined in this header.
Definition onnxruntime_c_api.h:41
struct OrtLogger OrtLogger
Definition onnxruntime_c_api.h:305
struct OrtMapTypeInfo OrtMapTypeInfo
Definition onnxruntime_c_api.h:289
struct OrtArenaCfg OrtArenaCfg
Definition onnxruntime_c_api.h:297
ExecutionMode
Definition onnxruntime_c_api.h:349
OrtOpAttrType
Definition onnxruntime_c_api.h:260
OrtCustomThreadHandle(* OrtCustomCreateThreadFn)(void *ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void *ort_worker_fn_param)
Ort custom thread creation function.
Definition onnxruntime_c_api.h:708
ONNXTensorElementDataType
Definition onnxruntime_c_api.h:177
const OrtApiBase * OrtGetApiBase(void)
The Onnxruntime library's entry point to access the C API.
@ ORT_LOGGING_LEVEL_WARNING
Warning messages.
Definition onnxruntime_c_api.h:240
@ OrtMemTypeDefault
The default allocator for execution provider.
Definition onnxruntime_c_api.h:387
std::vector< Value > GetOutputValuesHelper(const OrtIoBinding *binding, OrtAllocator *)
std::vector< std::string > GetOutputNamesHelper(const OrtIoBinding *binding, OrtAllocator *)
void OrtRelease(OrtAllocator *ptr)
Definition onnxruntime_cxx_api.h:505
std::string MakeCustomOpConfigEntryKey(const char *custom_op_name, const char *config)
All C++ Onnxruntime APIs are defined inside this namespace.
Definition onnxruntime_cxx_api.h:47
std::unique_ptr< char, detail::AllocatedFree > AllocatedStringPtr
unique_ptr typedef used to own strings allocated by OrtAllocators and release them at the end of the ...
Definition onnxruntime_cxx_api.h:645
detail::ConstSessionOptionsImpl< detail::Unowned< const OrtSessionOptions > > ConstSessionOptions
Definition onnxruntime_cxx_api.h:914
detail::KernelInfoImpl< detail::Unowned< const OrtKernelInfo > > ConstKernelInfo
Definition onnxruntime_cxx_api.h:2129
const OrtApi & GetApi() noexcept
This returns a reference to the OrtApi interface in use.
Definition onnxruntime_cxx_api.h:124
detail::AllocatorImpl< detail::Unowned< OrtAllocator > > UnownedAllocator
Definition onnxruntime_cxx_api.h:1822
detail::SessionOptionsImpl< detail::Unowned< OrtSessionOptions > > UnownedSessionOptions
Definition onnxruntime_cxx_api.h:913
std::string GetBuildInfoString()
This function returns the onnxruntime build information: including git branch, git commit id,...
std::string GetVersionString()
This function returns the onnxruntime version string.
std::vector< std::string > GetAvailableProviders()
This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representin...
Ort::Status(*)(Ort::ShapeInferContext &) ShapeInferFn
Definition onnxruntime_cxx_api.h:2243
Wrapper around OrtAllocator.
Definition onnxruntime_cxx_api.h:1817
Allocator(const Session &session, const OrtMemoryInfo *)
Allocator(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1818
Wrapper around OrtAllocator default instance that is owned by Onnxruntime.
Definition onnxruntime_cxx_api.h:1809
AllocatorWithDefaultOptions(std::nullptr_t)
Convenience to create a class member and then replace with an instance.
Definition onnxruntime_cxx_api.h:1810
it is a structure that represents the configuration of an arena based allocator
Definition onnxruntime_cxx_api.h:1875
ArenaCfg(std::nullptr_t)
Create an empty ArenaCfg object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1876
ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk)
bfloat16 (Brain Floating Point) data type
Definition onnxruntime_cxx_api.h:306
bool operator==(const BFloat16_t &rhs) const noexcept
onnxruntime_float16::BFloat16Impl< BFloat16_t > Base
Definition onnxruntime_cxx_api.h:318
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:327
bool operator!=(const BFloat16_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:425
BFloat16_t(float v) noexcept
__ctor from float. Float is converted into bfloat16 16-bit representation.
Definition onnxruntime_cxx_api.h:333
float ToFloat() const noexcept
Converts bfloat16 to float.
Definition onnxruntime_cxx_api.h:339
bool operator<(const BFloat16_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:2248
OrtCustomOpInputOutputCharacteristic GetOutputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:2323
OrtCustomOpInputOutputCharacteristic GetInputCharacteristic(size_t) const
Definition onnxruntime_cxx_api.h:2319
OrtMemType GetInputMemoryType(size_t) const
Definition onnxruntime_cxx_api.h:2328
std::vector< std::string > GetSessionConfigKeys() const
Definition onnxruntime_cxx_api.h:2359
bool GetVariadicInputHomogeneity() const
Definition onnxruntime_cxx_api.h:2340
int GetVariadicInputMinArity() const
Definition onnxruntime_cxx_api.h:2334
void SetShapeInferFn(...)
Definition onnxruntime_cxx_api.h:2373
CustomOpBase()
Definition onnxruntime_cxx_api.h:2249
bool GetVariadicOutputHomogeneity() const
Definition onnxruntime_cxx_api.h:2352
int GetVariadicOutputMinArity() const
Definition onnxruntime_cxx_api.h:2346
decltype(&C::InferOutputShape) SetShapeInferFn(decltype(&C::InferOutputShape))
Definition onnxruntime_cxx_api.h:2364
const char * GetExecutionProviderType() const
Definition onnxruntime_cxx_api.h:2315
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:786
~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:729
CustomOpDomain(std::nullptr_t)
Create an empty CustomOpDomain object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:730
CustomOpDomain(const char *domain)
Wraps OrtApi::CreateCustomOpDomain.
void Add(const OrtCustomOp *op)
Wraps CustomOpDomain_Add.
The Env (Environment)
Definition onnxruntime_cxx_api.h:697
Env & EnableTelemetryEvents()
Wraps OrtApi::EnableTelemetryEvents.
Env(OrtEnv *p)
C Interop Helper.
Definition onnxruntime_cxx_api.h:714
Env & CreateAndRegisterAllocatorV2(const std::string &provider_type, const OrtMemoryInfo *mem_info, const std::unordered_map< std::string, std::string > &options, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocatorV2.
Env(std::nullptr_t)
Create an empty Env object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:698
Env(OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnv.
Env(const OrtThreadingOptions *tp_options, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnvWithGlobalThreadPools.
Env(const OrtThreadingOptions *tp_options, OrtLoggingFunction logging_function, void *logger_param, OrtLoggingLevel logging_level=ORT_LOGGING_LEVEL_WARNING, const char *logid="")
Wraps OrtApi::CreateEnvWithCustomLoggerAndGlobalThreadPools.
Env(OrtLoggingLevel logging_level, const char *logid, OrtLoggingFunction logging_function, void *logger_param)
Wraps OrtApi::CreateEnvWithCustomLogger.
Env & CreateAndRegisterAllocator(const OrtMemoryInfo *mem_info, const OrtArenaCfg *arena_cfg)
Wraps OrtApi::CreateAndRegisterAllocator.
Env & UpdateEnvWithCustomLogLevel(OrtLoggingLevel log_severity_level)
Wraps OrtApi::UpdateEnvWithCustomLogLevel.
Env & DisableTelemetryEvents()
Wraps OrtApi::DisableTelemetryEvents.
All C++ methods that can fail will throw an exception of this type.
Definition onnxruntime_cxx_api.h:53
const char * what() const noexcept override
Definition onnxruntime_cxx_api.h:57
OrtErrorCode GetOrtErrorCode() const
Definition onnxruntime_cxx_api.h:56
Exception(std::string &&string, OrtErrorCode code)
Definition onnxruntime_cxx_api.h:54
IEEE 754 half-precision floating point data type.
Definition onnxruntime_cxx_api.h:164
Float16_t()=default
Default constructor.
Float16_t(float v) noexcept
__ctor from float. Float is converted into float16 16-bit representation.
Definition onnxruntime_cxx_api.h:192
onnxruntime_float16::Float16Impl< Float16_t > Base
Definition onnxruntime_cxx_api.h:174
float ToFloat() const noexcept
Converts float16 to float.
Definition onnxruntime_cxx_api.h:198
static constexpr Float16_t FromBits(uint16_t v) noexcept
Explicit conversion to uint16_t representation of float16.
Definition onnxruntime_cxx_api.h:186
float8e4m3fn (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:436
uint8_t value
Definition onnxruntime_cxx_api.h:437
constexpr Float8E4M3FN_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:439
constexpr bool operator==(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:442
constexpr Float8E4M3FN_t() noexcept
Definition onnxruntime_cxx_api.h:438
constexpr bool operator!=(const Float8E4M3FN_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:443
float8e4m3fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:453
constexpr bool operator==(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:459
uint8_t value
Definition onnxruntime_cxx_api.h:454
constexpr Float8E4M3FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:455
constexpr bool operator!=(const Float8E4M3FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:460
constexpr Float8E4M3FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:456
float8e5m2 (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:470
constexpr Float8E5M2_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:473
uint8_t value
Definition onnxruntime_cxx_api.h:471
constexpr bool operator!=(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:477
constexpr Float8E5M2_t() noexcept
Definition onnxruntime_cxx_api.h:472
constexpr bool operator==(const Float8E5M2_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:476
float8e5m2fnuz (Float8 Floating Point) data type
Definition onnxruntime_cxx_api.h:487
constexpr Float8E5M2FNUZ_t() noexcept
Definition onnxruntime_cxx_api.h:489
constexpr Float8E5M2FNUZ_t(uint8_t v) noexcept
Definition onnxruntime_cxx_api.h:490
constexpr bool operator!=(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:494
constexpr bool operator==(const Float8E5M2FNUZ_t &rhs) const noexcept
Definition onnxruntime_cxx_api.h:493
uint8_t value
Definition onnxruntime_cxx_api.h:488
Definition onnxruntime_cxx_api.h:85
static const OrtApi * api_
Definition onnxruntime_cxx_api.h:86
Wrapper around OrtIoBinding.
Definition onnxruntime_cxx_api.h:1864
UnownedIoBinding GetUnowned() const
Definition onnxruntime_cxx_api.h:1868
ConstIoBinding GetConst() const
Definition onnxruntime_cxx_api.h:1867
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:1865
This class wraps a raw pointer OrtKernelContext* that is being passed to the custom kernel Compute() ...
Definition onnxruntime_cxx_api.h:2057
KernelContext(OrtKernelContext *context)
Logger GetLogger() const
ConstValue GetInput(size_t index) const
OrtKernelContext * GetOrtKernelContext() const
Definition onnxruntime_cxx_api.h:2071
void ParallelFor(void(*fn)(void *, size_t), size_t total, size_t num_batch, void *usr_data) const
OrtAllocator * GetAllocator(const OrtMemoryInfo &memory_info) const
void * GetGPUComputeStream() const
size_t GetInputCount() const
size_t GetOutputCount() const
UnownedValue GetOutput(size_t index, const std::vector< int64_t > &dims) const
UnownedValue GetOutput(size_t index, const int64_t *dim_values, size_t dim_count) const
This struct owns the OrtKernInfo* pointer when a copy is made. For convenient wrapping of OrtKernelIn...
Definition onnxruntime_cxx_api.h:2137
KernelInfo(OrtKernelInfo *info)
Take ownership of the instance.
ConstKernelInfo GetConst() const
Definition onnxruntime_cxx_api.h:2140
KernelInfo(std::nullptr_t)
Create an empty instance to initialize later.
Definition onnxruntime_cxx_api.h:2138
This class represents an ONNX Runtime logger that can be used to log information with an associated s...
Definition onnxruntime_cxx_api.h:1979
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:1988
Logger(const OrtLogger *logger)
OrtLoggingLevel GetLoggingSeverityLevel() const noexcept
Wrapper around OrtMapTypeInfo.
Definition onnxruntime_cxx_api.h:1247
ConstMapTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1250
MapTypeInfo(OrtMapTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1249
MapTypeInfo(std::nullptr_t)
Create an empty MapTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1248
Represents native memory allocation coming from one of the OrtAllocators registered with OnnxRuntime....
Definition onnxruntime_cxx_api.h:1775
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:1784
Wrapper around OrtMemoryInfo.
Definition onnxruntime_cxx_api.h:1154
MemoryInfo(const char *name, OrtAllocatorType type, int id, OrtMemType mem_type)
MemoryInfo(std::nullptr_t)
No instance is created.
Definition onnxruntime_cxx_api.h:1156
MemoryInfo(OrtMemoryInfo *p)
Take ownership of a pointer created by C Api.
Definition onnxruntime_cxx_api.h:1157
static MemoryInfo CreateCpu(OrtAllocatorType type, OrtMemType mem_type1)
ConstMemoryInfo GetConst() const
Definition onnxruntime_cxx_api.h:1159
Wrapper around OrtModelMetadata.
Definition onnxruntime_cxx_api.h:930
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:931
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.
ModelMetadata(OrtModelMetadata *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:932
AllocatedStringPtr GetDomainAllocated(OrtAllocator *allocator) const
Returns a copy of the domain name.
int64_t GetVersion() const
Wraps OrtApi::ModelMetadataGetVersion.
This struct provides life time management for custom op attribute.
Definition onnxruntime_cxx_api.h:1895
OpAttr(const char *name, const void *data, int len, OrtOpAttrType type)
Create and own custom defined operation.
Definition onnxruntime_cxx_api.h:2146
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:2147
void Invoke(const OrtKernelContext *context, const OrtValue *const *input_values, size_t input_count, OrtValue *const *output_values, size_t output_count)
void Invoke(const OrtKernelContext *context, const Value *input_values, size_t input_count, Value *output_values, size_t output_count)
RunOptions.
Definition onnxruntime_cxx_api.h:742
int GetRunLogSeverityLevel() const
Wraps OrtApi::RunOptionsGetRunLogSeverityLevel.
RunOptions & SetTerminate()
Terminates all currently executing Session::Run calls that were made using this RunOptions instance.
RunOptions & SetRunTag(const char *run_tag)
wraps OrtApi::RunOptionsSetRunTag
RunOptions & 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:743
RunOptions & SetRunLogVerbosityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogVerbosityLevel.
RunOptions & SetRunLogSeverityLevel(int)
Wraps OrtApi::RunOptionsSetRunLogSeverityLevel.
RunOptions & AddConfigEntry(const char *config_key, const char *config_value)
Wraps OrtApi::AddRunConfigEntry.
const char * GetRunTag() const
Wraps OrtApi::RunOptionsGetRunTag.
RunOptions()
Wraps OrtApi::CreateRunOptions.
Wrapper around OrtSequenceTypeInfo.
Definition onnxruntime_cxx_api.h:1212
SequenceTypeInfo(std::nullptr_t)
Create an empty SequenceTypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1213
ConstSequenceTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1215
SequenceTypeInfo(OrtSequenceTypeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1214
Wrapper around OrtSession.
Definition onnxruntime_cxx_api.h:1118
Session(std::nullptr_t)
Create an empty Session object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1119
UnownedSession GetUnowned() const
Definition onnxruntime_cxx_api.h:1128
Session(const Env &env, const char *model_path, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Wraps OrtApi::CreateSessionWithPrepackedWeightsContainer.
Session(const Env &env, const void *model_data, size_t model_data_length, const SessionOptions &options, OrtPrepackedWeightsContainer *prepacked_weights_container)
Wraps OrtApi::CreateSessionFromArrayWithPrepackedWeightsContainer.
Session(const Env &env, const char *model_path, const SessionOptions &options)
Wraps OrtApi::CreateSession.
ConstSession GetConst() const
Definition onnxruntime_cxx_api.h:1127
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:919
SessionOptions(std::nullptr_t)
Create an empty SessionOptions object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:920
UnownedSessionOptions GetUnowned() const
Definition onnxruntime_cxx_api.h:923
SessionOptions()
Wraps OrtApi::CreateSessionOptions.
ConstSessionOptions GetConst() const
Definition onnxruntime_cxx_api.h:924
SessionOptions(OrtSessionOptions *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:922
Definition onnxruntime_cxx_api.h:2177
SymbolicInteger & operator=(const SymbolicInteger &)=default
SymbolicInteger(const SymbolicInteger &)=default
int64_t AsInt() const
Definition onnxruntime_cxx_api.h:2198
int64_t i_
Definition onnxruntime_cxx_api.h:2205
const char * s_
Definition onnxruntime_cxx_api.h:2206
bool operator==(const SymbolicInteger &dim) const
Definition onnxruntime_cxx_api.h:2186
SymbolicInteger & operator=(SymbolicInteger &&)=default
SymbolicInteger(SymbolicInteger &&)=default
const char * AsSym() const
Definition onnxruntime_cxx_api.h:2199
SymbolicInteger(int64_t i)
Definition onnxruntime_cxx_api.h:2178
SymbolicInteger(const char *s)
Definition onnxruntime_cxx_api.h:2179
bool IsInt() const
Definition onnxruntime_cxx_api.h:2197
Provide access to per-node attributes and input shapes, so one could compute and set output shapes.
Definition onnxruntime_cxx_api.h:2176
Ints GetAttrInts(const char *attr_name)
Strings GetAttrStrings(const char *attr_name)
std::vector< SymbolicInteger > Shape
Definition onnxruntime_cxx_api.h:2211
std::vector< float > Floats
Definition onnxruntime_cxx_api.h:2228
std::string GetAttrString(const char *attr_name)
std::vector< int64_t > Ints
Definition onnxruntime_cxx_api.h:2223
ShapeInferContext(const OrtApi *ort_api, OrtShapeInferContext *ctx)
Status SetOutputShape(size_t indice, const Shape &shape)
int64_t GetAttrInt(const char *attr_name)
size_t GetInputCount() const
Definition onnxruntime_cxx_api.h:2217
std::vector< std::string > Strings
Definition onnxruntime_cxx_api.h:2233
Floats GetAttrFloats(const char *attr_name)
const Shape & GetInputShape(size_t indice) const
Definition onnxruntime_cxx_api.h:2215
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:651
OrtErrorCode GetErrorCode() const
Status(const char *message, OrtErrorCode code) noexcept
Creates status instance out of null-terminated string message.
bool IsOK() const noexcept
Returns true if instance represents an OK (non-error) status.
Status(OrtStatus *status) noexcept
Takes ownership of OrtStatus instance returned from the C API.
std::string GetErrorMessage() const
Status(const Exception &) noexcept
Creates status instance out of exception.
Status(const std::exception &) noexcept
Creates status instance out of exception.
Status(std::nullptr_t) noexcept
Create an empty object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:652
Wrapper around OrtTensorTypeAndShapeInfo.
Definition onnxruntime_cxx_api.h:1191
TensorTypeAndShapeInfo(std::nullptr_t)
Create an empty TensorTypeAndShapeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1192
ConstTensorTypeAndShapeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1194
TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1193
The ThreadingOptions.
Definition onnxruntime_cxx_api.h:666
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:1278
TypeInfo(std::nullptr_t)
Create an empty TypeInfo object, must be assigned a valid one to be used.
Definition onnxruntime_cxx_api.h:1279
ConstTypeInfo GetConst() const
Definition onnxruntime_cxx_api.h:1282
TypeInfo(OrtTypeInfo *p)
C API Interop.
Definition onnxruntime_cxx_api.h:1280
Wrapper around OrtValue.
Definition onnxruntime_cxx_api.h:1614
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:1619
static Value CreateTensor(const OrtMemoryInfo *info, T *p_data, size_t p_data_element_count, const int64_t *shape, size_t shape_len)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
Value(OrtValue *p)
Used for interop with the C API.
Definition onnxruntime_cxx_api.h:1620
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:1625
static Value CreateSequence(const std::vector< Value > &values)
Creates an OrtValue with a Sequence Onnx type representation. The API would ref-count the supplied Or...
static Value CreateMap(const Value &keys, const Value &values)
Creates an OrtValue with a Map Onnx type representation. The API would ref-count the supplied OrtValu...
static Value CreateTensor(const OrtMemoryInfo *info, void *p_data, size_t p_data_byte_count, const int64_t *shape, size_t shape_len, ONNXTensorElementDataType type)
Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
static Value CreateTensor(OrtAllocator *allocator, const int64_t *shape, size_t shape_len)
Creates an OrtValue with a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue...
static Value CreateOpaque(const char *domain, const char *type_name, const T &value)
Creates an OrtValue wrapping an Opaque type. This is used for experimental support of non-tensor type...
ConstValue GetConst() const
Definition onnxruntime_cxx_api.h:1624
Definition onnxruntime_cxx_api.h:624
AllocatedFree(OrtAllocator *allocator)
Definition onnxruntime_cxx_api.h:626
OrtAllocator * allocator_
Definition onnxruntime_cxx_api.h:625
void operator()(void *ptr) const
Definition onnxruntime_cxx_api.h:628
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:611
typename Unowned< T >::Type contained_type
Definition onnxruntime_cxx_api.h:600
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:610
Base(const Base &)=default
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:603
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:556
Base(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:566
constexpr Base()=default
contained_type * release()
Relinquishes ownership of the contained C object pointer The underlying object is not destroyed.
Definition onnxruntime_cxx_api.h:577
Base(const Base &)=delete
constexpr Base(contained_type *p) noexcept
Definition onnxruntime_cxx_api.h:560
Base & operator=(const Base &)=delete
Base & operator=(Base &&v) noexcept
Definition onnxruntime_cxx_api.h:567
contained_type * p_
Definition onnxruntime_cxx_api.h:584
~Base()
Definition onnxruntime_cxx_api.h:561
T contained_type
Definition onnxruntime_cxx_api.h:557
Definition onnxruntime_cxx_api.h:1832
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:1003
TypeInfo GetInputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetInputTypeInfo.
size_t GetOutputCount() const
Returns the number of model outputs.
uint64_t GetProfilingStartTimeNs() const
Wraps OrtApi::SessionGetProfilingStartTimeNs.
ModelMetadata GetModelMetadata() const
Wraps OrtApi::SessionGetModelMetadata.
size_t GetInputCount() const
Returns the number of model inputs.
TypeInfo GetOutputTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOutputTypeInfo.
AllocatedStringPtr GetOverridableInitializerNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of the overridable initializer name at then specified index.
AllocatedStringPtr GetOutputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of output name at then specified index.
size_t GetOverridableInitializerCount() const
Returns the number of inputs that have defaults that can be overridden.
AllocatedStringPtr GetInputNameAllocated(size_t index, OrtAllocator *allocator) const
Returns a copy of input name at the specified index.
TypeInfo GetOverridableInitializerTypeInfo(size_t index) const
Wraps OrtApi::SessionGetOverridableInitializerTypeInfo.
Definition onnxruntime_cxx_api.h:1311
void GetStringTensorContent(void *buffer, size_t buffer_length, size_t *offsets, size_t offsets_count) const
The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor into...
void GetStringTensorElement(size_t buffer_length, size_t element_index, void *buffer) const
The API copies UTF-8 encoded bytes for the requested string element contained within a tensor or a sp...
TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat format) const
The API returns type and shape information for the specified indices. Each supported indices have the...
const void * GetTensorRawData() const
Returns a non-typed pointer to a tensor contained data.
std::string GetStringTensorElement(size_t element_index) const
Returns string tensor UTF-8 encoded string element. Use of this API is recommended over GetStringTens...
size_t GetStringTensorElementLength(size_t element_index) const
The API returns a byte length of UTF-8 encoded string element contained in either a tensor or a spare...
size_t GetStringTensorDataLength() const
This API returns a full length of string data contained within either a tensor or a sparse Tensor....
bool IsSparseTensor() const
Returns true if the OrtValue contains a sparse tensor.
TypeInfo GetTypeInfo() const
The API returns type information for data contained in a tensor. For sparse tensors it returns type i...
const R * GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t &num_indices) const
The API retrieves a pointer to the internal indices buffer. The API merely performs a convenience dat...
bool IsTensor() const
Returns true if Value is a tensor, false for other types like map/sequence/etc.
ConstMemoryInfo GetTensorMemoryInfo() const
This API returns information about the memory allocation used to hold data.
const R * GetSparseTensorValues() const
The API returns a pointer to an internal buffer of the sparse tensor containing non-zero values....
TensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const
The API returns type information for data contained in a tensor. For sparse tensors it returns type i...
Value GetValue(int index, OrtAllocator *allocator) const
size_t GetCount() const
< Return true if OrtValue contains data and returns false if the OrtValue is a None
void GetOpaqueData(const char *domain, const char *type_name, R &) const
Obtains a pointer to a user defined data for experimental purposes.
TensorTypeAndShapeInfo GetSparseTensorValuesTypeAndShapeInfo() const
The API returns type and shape information for stored non-zero values of the sparse tensor....
const R * GetTensorData() const
Returns a const typed pointer to the tensor contained data. No type checking is performed,...
OrtSparseFormat GetSparseFormat() const
The API returns the sparse data format this OrtValue holds in a sparse tensor. If the sparse tensor w...
Definition onnxruntime_cxx_api.h:1843
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:1233
ONNXTensorElementDataType GetMapKeyType() const
Wraps OrtApi::GetMapKeyType.
TypeInfo GetMapValueType() const
Wraps OrtApi::GetMapValueType.
Definition onnxruntime_cxx_api.h:1133
std::string GetAllocatorName() const
OrtMemType GetMemoryType() const
OrtMemoryInfoDeviceType GetDeviceType() const
OrtAllocatorType GetAllocatorType() const
bool operator==(const MemoryInfoImpl< U > &o) const
Definition onnxruntime_cxx_api.h:1220
TypeInfo GetOptionalElementType() const
Wraps OrtApi::CastOptionalTypeToContainedTypeInfo.
Definition onnxruntime_cxx_api.h:1294
const char ** str
Definition onnxruntime_cxx_api.h:1299
const int64_t * values_shape
Definition onnxruntime_cxx_api.h:1295
size_t values_shape_len
Definition onnxruntime_cxx_api.h:1296
const void * p_data
Definition onnxruntime_cxx_api.h:1298
Definition onnxruntime_cxx_api.h:1199
TypeInfo GetSequenceElementType() const
Wraps OrtApi::GetSequenceElementType.
Definition onnxruntime_cxx_api.h:1047
AllocatedStringPtr EndProfilingAllocated(OrtAllocator *allocator)
End profiling and return a copy of the profiling file name.
void Run(const RunOptions &run_options, const IoBinding &)
Wraps OrtApi::RunWithBinding.
void RunAsync(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, Value *output_values, size_t output_count, RunAsyncCallbackFn callback, void *user_data)
Run the model asynchronously in a thread owned by intra op thread pool.
std::vector< Value > Run(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, size_t output_count)
Run the model returning results in an Ort allocated vector.
void Run(const RunOptions &run_options, const char *const *input_names, const Value *input_values, size_t input_count, const char *const *output_names, Value *output_values, size_t output_count)
Run the model returning results in user provided outputs Same as Run(const RunOptions&,...
Definition onnxruntime_cxx_api.h:1305
const int64_t * shape
Definition onnxruntime_cxx_api.h:1306
size_t shape_len
Definition onnxruntime_cxx_api.h:1307
Definition onnxruntime_cxx_api.h:1164
size_t GetElementCount() const
Wraps OrtApi::GetTensorShapeElementCount.
void GetDimensions(int64_t *values, size_t values_count) const
Wraps OrtApi::GetDimensions.
std::vector< int64_t > GetShape() const
Uses GetDimensionsCount & GetDimensions to return a std::vector of the shape.
void GetSymbolicDimensions(const char **values, size_t values_count) const
Wraps OrtApi::GetSymbolicDimensions.
size_t GetDimensionsCount() const
Wraps OrtApi::GetDimensionsCount.
ONNXTensorElementDataType GetElementType() const
Wraps OrtApi::GetTensorElementType.
Definition onnxruntime_cxx_api.h:1255
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:532
T Type
Definition onnxruntime_cxx_api.h:533
Definition onnxruntime_cxx_api.h:1472
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:320
void(* Free)(struct OrtAllocator *this_, void *p)
Free a block of memory previously allocated with OrtAllocator::Alloc.
Definition onnxruntime_c_api.h:323
const OrtApi *(* GetApi)(uint32_t version)
Get a pointer to the requested version of the OrtApi.
Definition onnxruntime_c_api.h:675
The C API.
Definition onnxruntime_c_api.h:735
CUDA Provider Options.
Definition onnxruntime_c_api.h:410
Definition onnxruntime_c_api.h:4695
int(* GetVariadicInputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4741
OrtCustomOpInputOutputCharacteristic(* GetOutputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4725
size_t(* GetInputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4713
int(* GetVariadicOutputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4745
size_t(* GetAliasMap)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:4778
int(* GetStartVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4763
void(* ReleaseMayInplace)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:4775
const char *(* GetName)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4706
size_t(* GetOutputTypeCount)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4715
void(* KernelDestroy)(void *op_kernel)
Definition onnxruntime_c_api.h:4721
int(* GetVariadicOutputHomogeneity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4750
OrtMemType(* GetInputMemoryType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4732
void *(* CreateKernel)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info)
Definition onnxruntime_c_api.h:4702
uint32_t version
Definition onnxruntime_c_api.h:4696
ONNXTensorElementDataType(* GetInputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4712
void(* ReleaseAliasMap)(int *input_index, int *output_index)
Definition onnxruntime_c_api.h:4779
OrtCustomOpInputOutputCharacteristic(* GetInputCharacteristic)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4724
const char *(* GetExecutionProviderType)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4709
ONNXTensorElementDataType(* GetOutputType)(const struct OrtCustomOp *op, size_t index)
Definition onnxruntime_c_api.h:4714
int(* GetVariadicInputMinArity)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4736
OrtStatusPtr(* InferOutputShapeFn)(const struct OrtCustomOp *op, OrtShapeInferContext *)
Definition onnxruntime_c_api.h:4760
int(* GetEndVersion)(const struct OrtCustomOp *op)
Definition onnxruntime_c_api.h:4764
OrtStatusPtr(* CreateKernelV2)(const struct OrtCustomOp *op, const OrtApi *api, const OrtKernelInfo *info, void **kernel)
Definition onnxruntime_c_api.h:4753
size_t(* GetMayInplace)(int **input_index, int **output_index)
Definition onnxruntime_c_api.h:4771
OrtStatusPtr(* KernelComputeV2)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4758
void(* KernelCompute)(void *op_kernel, OrtKernelContext *context)
Definition onnxruntime_c_api.h:4720
MIGraphX Provider Options.
Definition onnxruntime_c_api.h:614
OpenVINO Provider Options.
Definition onnxruntime_c_api.h:630
ROCM Provider Options.
Definition onnxruntime_c_api.h:497
TensorRT Provider Options.
Definition onnxruntime_c_api.h:586