Ort::SessionOptions Struct Reference

Options object used when creating a new Session object. More...

#include <onnxruntime_cxx_api.h>

Inherits Ort::Base< OrtSessionOptions >.

Public Member Functions
	SessionOptions (std::nullptr_t)
	Create an empty SessionOptions object, must be assigned a valid one to be used. More...
	SessionOptions ()
	Wraps OrtApi::CreateSessionOptions. More...
	SessionOptions (OrtSessionOptions *p)
	Used for interop with the C API. More...
SessionOptions	Clone () const
	Creates and returns a copy of this SessionOptions object. Wraps OrtApi::CloneSessionOptions. More...
SessionOptions &	SetIntraOpNumThreads (int intra_op_num_threads)
	Wraps OrtApi::SetIntraOpNumThreads. More...
SessionOptions &	SetInterOpNumThreads (int inter_op_num_threads)
	Wraps OrtApi::SetInterOpNumThreads. More...
SessionOptions &	SetGraphOptimizationLevel (GraphOptimizationLevel graph_optimization_level)
	Wraps OrtApi::SetSessionGraphOptimizationLevel. More...
SessionOptions &	EnableCpuMemArena ()
	Wraps OrtApi::EnableCpuMemArena. More...
SessionOptions &	DisableCpuMemArena ()
	Wraps OrtApi::DisableCpuMemArena. More...
SessionOptions &	SetOptimizedModelFilePath (const char *optimized_model_file)
	Wraps OrtApi::SetOptimizedModelFilePath. More...
SessionOptions &	EnableProfiling (const char *profile_file_prefix)
	Wraps OrtApi::EnableProfiling. More...
SessionOptions &	DisableProfiling ()
	Wraps OrtApi::DisableProfiling. More...
SessionOptions &	EnableOrtCustomOps ()
	Wraps OrtApi::EnableOrtCustomOps. More...
SessionOptions &	EnableMemPattern ()
	Wraps OrtApi::EnableMemPattern. More...
SessionOptions &	DisableMemPattern ()
	Wraps OrtApi::DisableMemPattern. More...
SessionOptions &	SetExecutionMode (ExecutionMode execution_mode)
	Wraps OrtApi::SetSessionExecutionMode. More...
SessionOptions &	SetLogId (const char *logid)
	Wraps OrtApi::SetSessionLogId. More...
SessionOptions &	SetLogSeverityLevel (int level)
	Wraps OrtApi::SetSessionLogSeverityLevel. More...
SessionOptions &	Add (OrtCustomOpDomain *custom_op_domain)
	Wraps OrtApi::AddCustomOpDomain. More...
SessionOptions &	DisablePerSessionThreads ()
	Wraps OrtApi::DisablePerSessionThreads. More...
SessionOptions &	AddConfigEntry (const char *config_key, const char *config_value)
	Wraps OrtApi::AddSessionConfigEntry. More...
SessionOptions &	AddInitializer (const char *name, const OrtValue *ort_val)
	Wraps OrtApi::AddInitializer. More...
SessionOptions &	AddExternalInitializers (const std::vector< std::string > &names, const std::vector< Value > &ort_values)
	Wraps OrtApi::AddExternalInitializers. More...
SessionOptions &	AppendExecutionProvider_CUDA (const OrtCUDAProviderOptions &provider_options)
	Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA. More...
SessionOptions &	AppendExecutionProvider_CUDA_V2 (const OrtCUDAProviderOptionsV2 &provider_options)
	Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA_V2. More...
SessionOptions &	AppendExecutionProvider_ROCM (const OrtROCMProviderOptions &provider_options)
	Wraps OrtApi::SessionOptionsAppendExecutionProvider_ROCM. More...
SessionOptions &	AppendExecutionProvider_OpenVINO (const OrtOpenVINOProviderOptions &provider_options)
	Wraps OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO. More...
SessionOptions &	AppendExecutionProvider_TensorRT (const OrtTensorRTProviderOptions &provider_options)
	Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT. More...
SessionOptions &	AppendExecutionProvider_TensorRT_V2 (const OrtTensorRTProviderOptionsV2 &provider_options)
	Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT. More...
SessionOptions &	AppendExecutionProvider_MIGraphX (const OrtMIGraphXProviderOptions &provider_options)
SessionOptions &	AppendExecutionProvider (const std::string &provider_name, const std::unordered_map< std::string, std::string > &provider_options={})
	Wraps OrtApi::SessionOptionsAppendExecutionProvider. Currently supports SNPE and XNNPACK. More...
SessionOptions &	SetCustomCreateThreadFn (OrtCustomCreateThreadFn ort_custom_create_thread_fn)
	Wraps OrtApi::SessionOptionsSetCustomCreateThreadFn. More...
SessionOptions &	SetCustomThreadCreationOptions (void *ort_custom_thread_creation_options)
	Wraps OrtApi::SessionOptionsSetCustomThreadCreationOptions. More...
SessionOptions &	SetCustomJoinThreadFn (OrtCustomJoinThreadFn ort_custom_join_thread_fn)
	Wraps OrtApi::SessionOptionsSetCustomJoinThreadFn. More...
Public Member Functions inherited from Ort::Base< OrtSessionOptions >
	Base ()=default
	Base (OrtSessionOptions *p)
	~Base ()
	operator OrtSessionOptions * ()
	operator const OrtSessionOptions * () const
OrtSessionOptions *	release ()
	Releases ownership of the contained pointer. More...

Additional Inherited Members
Public Types inherited from Ort::Base< OrtSessionOptions >
using	contained_type = OrtSessionOptions
Protected Member Functions inherited from Ort::Base< OrtSessionOptions >
	Base (const Base &)=delete
	Base (Base &&v) noexcept
Base &	operator= (const Base &)=delete
void	operator= (Base &&v) noexcept
Protected Attributes inherited from Ort::Base< OrtSessionOptions >
OrtSessionOptions *	p_

Detailed Description

Options object used when creating a new Session object.

Wraps OrtSessionOptions object and methods

Constructor & Destructor Documentation

SessionOptions() [1/3]

Ort::SessionOptions::SessionOptions ( std::nullptr_t  )

inlineexplicit

Create an empty SessionOptions object, must be assigned a valid one to be used.

SessionOptions() [2/3]

Ort::SessionOptions::SessionOptions

(

)

Wraps OrtApi::CreateSessionOptions.

SessionOptions() [3/3]

Ort::SessionOptions::SessionOptions ( OrtSessionOptions *  p )

inlineexplicit

Used for interop with the C API.

Member Function Documentation

Add()

SessionOptions & Ort::SessionOptions::Add

(

OrtCustomOpDomain *

custom_op_domain

)

Wraps OrtApi::AddCustomOpDomain.

AddConfigEntry()

SessionOptions & Ort::SessionOptions::AddConfigEntry	(	const char *	config_key,
		const char *	config_value
	)

Wraps OrtApi::AddSessionConfigEntry.

AddExternalInitializers()

SessionOptions & Ort::SessionOptions::AddExternalInitializers	(	const std::vector< std::string > &	names,
		const std::vector< Value > &	ort_values
	)

Wraps OrtApi::AddExternalInitializers.

AddInitializer()

SessionOptions & Ort::SessionOptions::AddInitializer	(	const char *	name,
		const OrtValue *	ort_val
	)

Wraps OrtApi::AddInitializer.

AppendExecutionProvider()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider	(	const std::string &	provider_name,
		const std::unordered_map< std::string, std::string > &	provider_options = {}
	)

Wraps OrtApi::SessionOptionsAppendExecutionProvider. Currently supports SNPE and XNNPACK.

AppendExecutionProvider_CUDA()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_CUDA

(

const OrtCUDAProviderOptions &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA.

AppendExecutionProvider_CUDA_V2()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_CUDA_V2

(

const OrtCUDAProviderOptionsV2 &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA_V2.

AppendExecutionProvider_MIGraphX()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_MIGraphX

(

const OrtMIGraphXProviderOptions &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_MIGraphX

AppendExecutionProvider_OpenVINO()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_OpenVINO

(

const OrtOpenVINOProviderOptions &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO.

AppendExecutionProvider_ROCM()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_ROCM

(

const OrtROCMProviderOptions &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_ROCM.

AppendExecutionProvider_TensorRT()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_TensorRT

(

const OrtTensorRTProviderOptions &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT.

AppendExecutionProvider_TensorRT_V2()

SessionOptions & Ort::SessionOptions::AppendExecutionProvider_TensorRT_V2

(

const OrtTensorRTProviderOptionsV2 &

provider_options

)

Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT.

Clone()

SessionOptions Ort::SessionOptions::Clone

(

)

const

Creates and returns a copy of this SessionOptions object. Wraps OrtApi::CloneSessionOptions.

DisableCpuMemArena()

SessionOptions & Ort::SessionOptions::DisableCpuMemArena

(

)

Wraps OrtApi::DisableCpuMemArena.

DisableMemPattern()

SessionOptions & Ort::SessionOptions::DisableMemPattern

(

)

Wraps OrtApi::DisableMemPattern.

DisablePerSessionThreads()

SessionOptions & Ort::SessionOptions::DisablePerSessionThreads

(

)

Wraps OrtApi::DisablePerSessionThreads.

DisableProfiling()

SessionOptions & Ort::SessionOptions::DisableProfiling

(

)

Wraps OrtApi::DisableProfiling.

EnableCpuMemArena()

SessionOptions & Ort::SessionOptions::EnableCpuMemArena

(

)

Wraps OrtApi::EnableCpuMemArena.

EnableMemPattern()

SessionOptions & Ort::SessionOptions::EnableMemPattern

(

)

Wraps OrtApi::EnableMemPattern.

EnableOrtCustomOps()

SessionOptions & Ort::SessionOptions::EnableOrtCustomOps

(

)

Wraps OrtApi::EnableOrtCustomOps.

EnableProfiling()

SessionOptions & Ort::SessionOptions::EnableProfiling

(

const char *

profile_file_prefix

)

Wraps OrtApi::EnableProfiling.

SetCustomCreateThreadFn()

SessionOptions & Ort::SessionOptions::SetCustomCreateThreadFn

(

OrtCustomCreateThreadFn

ort_custom_create_thread_fn

)

Wraps OrtApi::SessionOptionsSetCustomCreateThreadFn.

SetCustomJoinThreadFn()

SessionOptions & Ort::SessionOptions::SetCustomJoinThreadFn

(

OrtCustomJoinThreadFn

ort_custom_join_thread_fn

)

Wraps OrtApi::SessionOptionsSetCustomJoinThreadFn.

SetCustomThreadCreationOptions()

SessionOptions & Ort::SessionOptions::SetCustomThreadCreationOptions

(

void *

ort_custom_thread_creation_options

)

Wraps OrtApi::SessionOptionsSetCustomThreadCreationOptions.

SetExecutionMode()

SessionOptions & Ort::SessionOptions::SetExecutionMode

(

ExecutionMode

execution_mode

)

Wraps OrtApi::SetSessionExecutionMode.

SetGraphOptimizationLevel()

SessionOptions & Ort::SessionOptions::SetGraphOptimizationLevel

(

GraphOptimizationLevel

graph_optimization_level

)

Wraps OrtApi::SetSessionGraphOptimizationLevel.

SetInterOpNumThreads()

SessionOptions & Ort::SessionOptions::SetInterOpNumThreads

(

int

inter_op_num_threads

)

Wraps OrtApi::SetInterOpNumThreads.

SetIntraOpNumThreads()

SessionOptions & Ort::SessionOptions::SetIntraOpNumThreads

(

int

intra_op_num_threads

)

Wraps OrtApi::SetIntraOpNumThreads.

SetLogId()

SessionOptions & Ort::SessionOptions::SetLogId

(

const char *

logid

)

Wraps OrtApi::SetSessionLogId.

SetLogSeverityLevel()

SessionOptions & Ort::SessionOptions::SetLogSeverityLevel

(

int

level

)

Wraps OrtApi::SetSessionLogSeverityLevel.

SetOptimizedModelFilePath()

SessionOptions & Ort::SessionOptions::SetOptimizedModelFilePath

(

const char *

optimized_model_file

)

Wraps OrtApi::SetOptimizedModelFilePath.