# OnnxRuntime: Ort::detail::SessionOptionsImpl< T > Struct Template Reference

Loading...
Searching...
No Matches
Ort::detail::SessionOptionsImpl< T > Struct Template Reference

`#include <onnxruntime_cxx_api.h>`

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

## Public Types

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

## Public Member Functions

SessionOptionsImpl & | SetIntraOpNumThreads (int intra_op_num_threads)
| Wraps OrtApi::SetIntraOpNumThreads.
SessionOptionsImpl & | SetInterOpNumThreads (int inter_op_num_threads)
| Wraps OrtApi::SetInterOpNumThreads.
SessionOptionsImpl & | SetGraphOptimizationLevel (GraphOptimizationLevel graph_optimization_level)
| Wraps OrtApi::SetSessionGraphOptimizationLevel.
SessionOptionsImpl & | EnableCpuMemArena ()
| Wraps OrtApi::EnableCpuMemArena.
SessionOptionsImpl & | DisableCpuMemArena ()
| Wraps OrtApi::DisableCpuMemArena.
SessionOptionsImpl & | SetOptimizedModelFilePath (const char *optimized_model_file)
| Wraps OrtApi::SetOptimizedModelFilePath.
SessionOptionsImpl & | EnableProfiling (const char *profile_file_prefix)
| Wraps OrtApi::EnableProfiling.
SessionOptionsImpl & | DisableProfiling ()
| Wraps OrtApi::DisableProfiling.
SessionOptionsImpl & | EnableOrtCustomOps ()
| Wraps OrtApi::EnableOrtCustomOps.
SessionOptionsImpl & | EnableMemPattern ()
| Wraps OrtApi::EnableMemPattern.
SessionOptionsImpl & | DisableMemPattern ()
| Wraps OrtApi::DisableMemPattern.
SessionOptionsImpl & | SetExecutionMode (ExecutionMode execution_mode)
| Wraps OrtApi::SetSessionExecutionMode.
SessionOptionsImpl & | SetLogId (const char *logid)
| Wraps OrtApi::SetSessionLogId.
SessionOptionsImpl & | SetLogSeverityLevel (int level)
| Wraps OrtApi::SetSessionLogSeverityLevel.
SessionOptionsImpl & | Add (OrtCustomOpDomain *custom_op_domain)
| Wraps OrtApi::AddCustomOpDomain.
SessionOptionsImpl & | DisablePerSessionThreads ()
| Wraps OrtApi::DisablePerSessionThreads.
SessionOptionsImpl & | AddConfigEntry (const char *config_key, const char *config_value)
| Wraps OrtApi::AddSessionConfigEntry.
SessionOptionsImpl & | AddInitializer (const char *name, const OrtValue *ort_val)
| Wraps OrtApi::AddInitializer.
SessionOptionsImpl & | AddExternalInitializers (const std::vector< std::string > &names, const std::vector< Value > &ort_values)
| Wraps OrtApi::AddExternalInitializers.
SessionOptionsImpl & | AppendExecutionProvider_CUDA (const OrtCUDAProviderOptions &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA.
SessionOptionsImpl & | AppendExecutionProvider_CUDA_V2 (const OrtCUDAProviderOptionsV2 &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA_V2.
SessionOptionsImpl & | AppendExecutionProvider_ROCM (const OrtROCMProviderOptions &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_ROCM.
SessionOptionsImpl & | AppendExecutionProvider_OpenVINO (const OrtOpenVINOProviderOptions &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO.
SessionOptionsImpl & | AppendExecutionProvider_TensorRT (const OrtTensorRTProviderOptions &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT.
SessionOptionsImpl & | AppendExecutionProvider_TensorRT_V2 (const OrtTensorRTProviderOptionsV2 &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT.
SessionOptionsImpl & | AppendExecutionProvider_MIGraphX (const OrtMIGraphXProviderOptions &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_CANN.
SessionOptionsImpl & | AppendExecutionProvider_CANN (const OrtCANNProviderOptions &provider_options)
| Wraps OrtApi::SessionOptionsAppendExecutionProvider_Dnnl.
SessionOptionsImpl & | AppendExecutionProvider_Dnnl (const OrtDnnlProviderOptions &provider_options)
SessionOptionsImpl & | AppendExecutionProvider (const std::string &provider_name, const std::unordered_map< std::string, std::string > &provider_options={})
| Wraps OrtApi::SessionOptionsAppendExecutionProvider. Currently supports SNPE and XNNPACK.
SessionOptionsImpl & | SetCustomCreateThreadFn (OrtCustomCreateThreadFn ort_custom_create_thread_fn)
| Wraps OrtApi::SessionOptionsSetCustomCreateThreadFn.
SessionOptionsImpl & | SetCustomThreadCreationOptions (void *ort_custom_thread_creation_options)
| Wraps OrtApi::SessionOptionsSetCustomThreadCreationOptions.
SessionOptionsImpl & | SetCustomJoinThreadFn (OrtCustomJoinThreadFn ort_custom_join_thread_fn)
| Wraps OrtApi::SessionOptionsSetCustomJoinThreadFn.
SessionOptionsImpl & | RegisterCustomOpsLibrary (const char *library_name, const CustomOpConfigs &custom_op_configs={})
SessionOptionsImpl & | RegisterCustomOpsUsingFunction (const char *function_name)
| Wraps OrtApi::RegisterCustomOpsUsingFunction.
Public Member Functions inherited from Ort::detail::ConstSessionOptionsImpl< T >
SessionOptions | Clone () const
| Creates and returns a copy of this SessionOptions object. Wraps OrtApi::CloneSessionOptions.
std::string | GetConfigEntry (const char *config_key) const
| Wraps OrtApi::GetSessionConfigEntry.
bool | HasConfigEntry (const char *config_key) const
| Wraps OrtApi::HasSessionConfigEntry.
std::string | GetConfigEntryOrDefault (const char *config_key, const std::string &def)
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.

## Additional Inherited Members

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

## Member Typedef Documentation

## B [1/2]

template<typename T >

using Ort::detail::SessionOptionsImpl< T >::B = ConstSessionOptionsImpl<T>

## B [2/2]

template<typename T >

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

## Member Function Documentation

## Add()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::Add | ( | OrtCustomOpDomain * | custom_op_domain | ) |

Wraps OrtApi::AddCustomOpDomain.

## AddConfigEntry()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AddConfigEntry | ( | const char * | config_key,
|  | const char * | config_value
| ) |  |

Wraps OrtApi::AddSessionConfigEntry.

## AddExternalInitializers()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AddExternalInitializers | ( | const std::vector< std::string > & | names,
|  | const std::vector< Value > & | ort_values
| ) |  |

Wraps OrtApi::AddExternalInitializers.

## AddInitializer()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AddInitializer | ( | const char * | name,
|  | const OrtValue * | ort_val
| ) |  |

Wraps OrtApi::AddInitializer.

## AppendExecutionProvider()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::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_CANN()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_CANN | ( | const OrtCANNProviderOptions & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_Dnnl.

## AppendExecutionProvider_CUDA()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_CUDA | ( | const OrtCUDAProviderOptions & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA.

## AppendExecutionProvider_CUDA_V2()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_CUDA_V2 | ( | const OrtCUDAProviderOptionsV2 & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA_V2.

## AppendExecutionProvider_Dnnl()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_Dnnl | ( | const OrtDnnlProviderOptions & | provider_options | ) |

## AppendExecutionProvider_MIGraphX()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_MIGraphX | ( | const OrtMIGraphXProviderOptions & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_CANN.

Wraps OrtApi::SessionOptionsAppendExecutionProvider_MIGraphX

## AppendExecutionProvider_OpenVINO()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_OpenVINO | ( | const OrtOpenVINOProviderOptions & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO.

## AppendExecutionProvider_ROCM()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_ROCM | ( | const OrtROCMProviderOptions & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_ROCM.

## AppendExecutionProvider_TensorRT()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_TensorRT | ( | const OrtTensorRTProviderOptions & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT.

## AppendExecutionProvider_TensorRT_V2()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::AppendExecutionProvider_TensorRT_V2 | ( | const OrtTensorRTProviderOptionsV2 & | provider_options | ) |

Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT.

## DisableCpuMemArena()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::DisableCpuMemArena | ( |  | ) |

Wraps OrtApi::DisableCpuMemArena.

## DisableMemPattern()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::DisableMemPattern | ( |  | ) |

Wraps OrtApi::DisableMemPattern.

## DisablePerSessionThreads()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::DisablePerSessionThreads | ( |  | ) |

Wraps OrtApi::DisablePerSessionThreads.

## DisableProfiling()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::DisableProfiling | ( |  | ) |

Wraps OrtApi::DisableProfiling.

## EnableCpuMemArena()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::EnableCpuMemArena | ( |  | ) |

Wraps OrtApi::EnableCpuMemArena.

## EnableMemPattern()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::EnableMemPattern | ( |  | ) |

Wraps OrtApi::EnableMemPattern.

## EnableOrtCustomOps()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::EnableOrtCustomOps | ( |  | ) |

Wraps OrtApi::EnableOrtCustomOps.

## EnableProfiling()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::EnableProfiling | ( | const char * | profile_file_prefix | ) |

Wraps OrtApi::EnableProfiling.

## RegisterCustomOpsLibrary()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::RegisterCustomOpsLibrary | ( | const char * | library_name,
|  | const CustomOpConfigs & | custom_op_configs = `{}`
| ) |  |

## RegisterCustomOpsUsingFunction()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::RegisterCustomOpsUsingFunction | ( | const char * | function_name | ) |

Wraps OrtApi::RegisterCustomOpsUsingFunction.

## SetCustomCreateThreadFn()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetCustomCreateThreadFn | ( | OrtCustomCreateThreadFn | ort_custom_create_thread_fn | ) |

Wraps OrtApi::SessionOptionsSetCustomCreateThreadFn.

## SetCustomJoinThreadFn()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetCustomJoinThreadFn | ( | OrtCustomJoinThreadFn | ort_custom_join_thread_fn | ) |

Wraps OrtApi::SessionOptionsSetCustomJoinThreadFn.

Registers the custom operator from the specified shared library via OrtApi::RegisterCustomOpsLibrary_V2. The custom operator configurations are optional. If provided, custom operator configs are set via OrtApi::AddSessionConfigEntry.

## SetCustomThreadCreationOptions()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetCustomThreadCreationOptions | ( | void * | ort_custom_thread_creation_options | ) |

Wraps OrtApi::SessionOptionsSetCustomThreadCreationOptions.

## SetExecutionMode()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetExecutionMode | ( | ExecutionMode | execution_mode | ) |

Wraps OrtApi::SetSessionExecutionMode.

## SetGraphOptimizationLevel()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetGraphOptimizationLevel | ( | GraphOptimizationLevel | graph_optimization_level | ) |

Wraps OrtApi::SetSessionGraphOptimizationLevel.

## SetInterOpNumThreads()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetInterOpNumThreads | ( | int | inter_op_num_threads | ) |

Wraps OrtApi::SetInterOpNumThreads.

## SetIntraOpNumThreads()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetIntraOpNumThreads | ( | int | intra_op_num_threads | ) |

Wraps OrtApi::SetIntraOpNumThreads.

## SetLogId()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetLogId | ( | const char * | logid | ) |

Wraps OrtApi::SetSessionLogId.

## SetLogSeverityLevel()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetLogSeverityLevel | ( | int | level | ) |

Wraps OrtApi::SetSessionLogSeverityLevel.

## SetOptimizedModelFilePath()

template<typename T >

SessionOptionsImpl & Ort::detail::SessionOptionsImpl< T >::SetOptimizedModelFilePath | ( | const char * | optimized_model_file | ) |

Wraps OrtApi::SetOptimizedModelFilePath.