#include <onnxruntime_cxx_api.h>

Inheritance diagram for Ort::detail::SessionImpl< T >:

Public Types
using	B = ConstSessionImpl< T >

using	B = Base< T >

Public Types inherited from Ort::detail::ConstSessionImpl< T >
using	B = Base< T >

Public Types inherited from Ort::detail::Base< T >
using	contained_type = T

Public Member Functions
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. More...

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&, const char* const, const Value, size_t,const char* const*, size_t) More...

void	Run (const RunOptions &run_options, const IoBinding &)
	Wraps OrtApi::RunWithBinding. More...

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. More...

AllocatedStringPtr	EndProfilingAllocated (OrtAllocator *allocator)
	End profiling and return a copy of the profiling file name. More...

Public Member Functions inherited from Ort::detail::ConstSessionImpl< T >
size_t	GetInputCount () const
	Returns the number of model inputs. More...

size_t	GetOutputCount () const
	Returns the number of model outputs. More...

size_t	GetOverridableInitializerCount () const
	Returns the number of inputs that have defaults that can be overridden. More...

AllocatedStringPtr	GetInputNameAllocated (size_t index, OrtAllocator *allocator) const
	Returns a copy of input name at the specified index. More...

AllocatedStringPtr	GetOutputNameAllocated (size_t index, OrtAllocator *allocator) const
	Returns a copy of output name at then specified index. More...

AllocatedStringPtr	GetOverridableInitializerNameAllocated (size_t index, OrtAllocator *allocator) const
	Returns a copy of the overridable initializer name at then specified index. More...

uint64_t	GetProfilingStartTimeNs () const
	Wraps OrtApi::SessionGetProfilingStartTimeNs. More...

ModelMetadata	GetModelMetadata () const
	Wraps OrtApi::SessionGetModelMetadata. More...

TypeInfo	GetInputTypeInfo (size_t index) const
	Wraps OrtApi::SessionGetInputTypeInfo. More...

TypeInfo	GetOutputTypeInfo (size_t index) const
	Wraps OrtApi::SessionGetOutputTypeInfo. More...

TypeInfo	GetOverridableInitializerTypeInfo (size_t index) const
	Wraps OrtApi::SessionGetOverridableInitializerTypeInfo. More...

Public Member Functions inherited from Ort::detail::Base< T >
constexpr	Base ()=default

constexpr	Base (contained_type *p) noexcept

	~Base ()

	Base (const Base &)=delete

Base &	operator= (const Base &)=delete

	Base (Base &&v) noexcept

Base &	operator= (Base &&v) noexcept

constexpr	operator contained_type * () const noexcept

contained_type *	release ()
	Relinquishes ownership of the contained C object pointer The underlying object is not destroyed. More...

Additional Inherited Members
Protected Attributes inherited from Ort::detail::Base< T >
contained_type *	p_ {}

Detailed Description

template<typename T>
struct Ort::detail::SessionImpl< T >

Definition at line 1041 of file onnxruntime_cxx_api.h.

Member Typedef Documentation

template<typename T>

using Ort::detail::SessionImpl< T >::B = ConstSessionImpl<T>

Definition at line 1042 of file onnxruntime_cxx_api.h.

template<typename T>

using Ort::detail::ConstSessionImpl< T >::B = Base<T>

Definition at line 998 of file onnxruntime_cxx_api.h.

Member Function Documentation

template<typename T >

AllocatedStringPtr Ort::detail::SessionImpl< T >::EndProfilingAllocated ( OrtAllocator * allocator )

inline

End profiling and return a copy of the profiling file name.

Parameters

allocator to allocate memory for the copy of the string returned

Returns: a instance of smart pointer that would deallocate the buffer when out of scope. The OrtAllocator instances must be valid at the point of memory release.Wraps OrtApi::SessionEndProfiling

Definition at line 1021 of file onnxruntime_cxx_inline.h.

template<typename T >

std::vector< Value > Ort::detail::SessionImpl< T >::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
	)

inline

Run the model returning results in an Ort allocated vector.

Wraps OrtApi::Run

The caller provides a list of inputs and a list of the desired outputs to return.

See the output logs for more information on warnings/errors that occur while processing the model. Common errors are.. (TODO)

Parameters

[in]	run_options
[in]	input_names	Array of null terminated strings of length input_count that is the list of input names
[in]	input_values	Array of Value objects of length input_count that is the list of input values
[in]	input_count	Number of inputs (the size of the input_names & input_values arrays)
[in]	output_names	Array of C style strings of length output_count that is the list of output names
[in]	output_count	Number of outputs (the size of the output_names array)

Returns: A std::vector of Value objects that directly maps to the output_names array (eg. output_name[0] is the first entry of the returned vector)

Definition at line 986 of file onnxruntime_cxx_inline.h.

template<typename T >

void Ort::detail::SessionImpl< T >::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
	)

inline

Run the model returning results in user provided outputs Same as Run(const RunOptions&, const char* const*, const Value*, size_t,const char* const*, size_t)

Definition at line 997 of file onnxruntime_cxx_inline.h.

template<typename T >

void Ort::detail::SessionImpl< T >::Run	(	const RunOptions &	run_options,
		const IoBinding &	io_binding
	)

inline

Wraps OrtApi::RunWithBinding.

Definition at line 1006 of file onnxruntime_cxx_inline.h.

template<typename T >

void Ort::detail::SessionImpl< T >::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
	)

inline

Run the model asynchronously in a thread owned by intra op thread pool.

Wraps OrtApi::RunAsync

Parameters

[in]	run_options
[in]	input_names	Array of null terminated UTF8 encoded strings of the input names
[in]	input_values	Array of Value objects of length input_count
[in]	input_count	Number of elements in the input_names and inputs arrays
[in]	output_names	Array of null terminated UTF8 encoded strings of the output names
[out]	output_values	Array of provided Values to be filled with outputs. On calling RunAsync, output_values[i] could either be initialized by a null pointer or a preallocated OrtValue. Later, on invoking the callback, each output_values[i] of null will be filled with an OrtValue allocated by onnxruntime. Then, an OrtValue** pointer will be casted from output_values, and pass to the callback. NOTE: it is customer's duty to finally release output_values and each of its member, regardless of whether the member (Ort::Value) is allocated by onnxruntime or preallocated by the customer.
[in]	output_count	Number of elements in the output_names and outputs array
[in]	callback	Callback function on model run completion
[in]	user_data	User data that pass back to the callback

Definition at line 1011 of file onnxruntime_cxx_inline.h.

The documentation for this struct was generated from the following files:

onnxruntime/core/session/onnxruntime_cxx_api.h
onnxruntime/core/session/onnxruntime_cxx_inline.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> struct Ort::detail::SessionImpl< T >

Member Typedef Documentation

Member Function Documentation

template<typename T>
struct Ort::detail::SessionImpl< T >