Skip to main content

OrtSessionConfig

Struct OrtSessionConfig 

Source
pub struct OrtSessionConfig {
    pub intra_threads: Option<usize>,
    pub inter_threads: Option<usize>,
    pub parallel_execution: Option<bool>,
    pub optimization_level: Option<OrtGraphOptimizationLevel>,
    pub execution_providers: Option<Vec<OrtExecutionProvider>>,
    pub enable_mem_pattern: Option<bool>,
    pub log_severity_level: Option<i32>,
    pub log_verbosity_level: Option<i32>,
    pub session_config_entries: Option<HashMap<String, String>>,
}
Expand description

Configuration for ONNX Runtime sessions.

This struct contains various configuration options for ONNX Runtime sessions, including threading, memory management, and optimization settings.

Fields§

§intra_threads: Option<usize>

Number of threads used to parallelize execution within nodes

§inter_threads: Option<usize>

Number of threads used to parallelize execution across nodes

§parallel_execution: Option<bool>

Enable parallel execution mode

§optimization_level: Option<OrtGraphOptimizationLevel>

Graph optimization level

§execution_providers: Option<Vec<OrtExecutionProvider>>

Execution providers in order of preference

§enable_mem_pattern: Option<bool>

Enable memory pattern optimization

§log_severity_level: Option<i32>

Log severity level (0=Verbose, 1=Info, 2=Warning, 3=Error, 4=Fatal)

§log_verbosity_level: Option<i32>

Log verbosity level

§session_config_entries: Option<HashMap<String, String>>

Session configuration entries (key-value pairs)

Implementations§

Source§

impl OrtSessionConfig

Source

pub fn new() -> OrtSessionConfig

Creates a new OrtSessionConfig with default values.

Source

pub fn with_intra_threads(self, threads: usize) -> OrtSessionConfig

Sets the number of intra-op threads.

Source

pub fn with_inter_threads(self, threads: usize) -> OrtSessionConfig

Sets the number of inter-op threads.

Source

pub fn with_parallel_execution(self, enabled: bool) -> OrtSessionConfig

Enables or disables parallel execution.

Source

pub fn with_optimization_level( self, level: OrtGraphOptimizationLevel, ) -> OrtSessionConfig

Sets the graph optimization level.

Source

pub fn with_execution_providers( self, providers: Vec<OrtExecutionProvider>, ) -> OrtSessionConfig

Sets the execution providers, in order of preference.

Source

pub fn add_execution_provider( self, provider: OrtExecutionProvider, ) -> OrtSessionConfig

Appends a single execution provider.

Source

pub fn with_memory_pattern(self, enable: bool) -> OrtSessionConfig

Enables or disables memory pattern optimization.

Source

pub fn with_log_severity_level(self, level: i32) -> OrtSessionConfig

Sets the log severity level (0=Verbose, 1=Info, 2=Warning, 3=Error, 4=Fatal).

Source

pub fn with_log_verbosity_level(self, level: i32) -> OrtSessionConfig

Sets the log verbosity level.

Source

pub fn add_config_entry<K, V>(self, key: K, value: V) -> OrtSessionConfig
where K: Into<String>, V: Into<String>,

Adds a session configuration entry.

Source

pub fn with_coreml_config(self, config: OrtCoreMLConfig) -> OrtSessionConfig

Sets advanced options for any CoreML execution provider in this session.

Source

pub fn get_intra_threads(&self) -> usize

Effective intra-op thread count, defaulting to available parallelism.

Source

pub fn get_inter_threads(&self) -> usize

Effective inter-op thread count, defaulting to 1.

Source

pub fn get_optimization_level(&self) -> OrtGraphOptimizationLevel

Effective graph optimization level, defaulting to OrtGraphOptimizationLevel::default().

Source

pub fn get_execution_providers(&self) -> Vec<OrtExecutionProvider>

Configured execution providers, defaulting to CPU.

Source

pub fn has_accelerator_provider(&self) -> bool

Returns whether an explicitly configured hardware accelerator is present.

execution_providers is a preference-ordered list: ONNX Runtime lets each provider claim graph nodes in list order, and CPU can claim almost any node, so a CPU entry listed first effectively runs the session on CPU regardless of what accelerators follow it. Only the first provider therefore determines whether this is an accelerated configuration. No provider configuration, an empty provider list, and a CPU-first list (including CPU alone) all use CPU-oriented pipeline defaults; an accelerator listed first with a CPU fallback after it (CUDA, TensorRT, DirectML, OpenVINO, CoreML, or WebGPU) counts as accelerated.

Trait Implementations§

Source§

impl Clone for OrtSessionConfig

Source§

fn clone(&self) -> OrtSessionConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OrtSessionConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl Default for OrtSessionConfig

Source§

fn default() -> OrtSessionConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for OrtSessionConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<OrtSessionConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for OrtSessionConfig

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more