Struct SessionBuilder

pub struct SessionBuilder<'a> { /* private fields */ }

Type used to create a session using the builder pattern

A SessionBuilder is created by calling the Environment::new_session_builder() method on the environment.

Once created, use the different methods to configure the session.

Once configured, use the SessionBuilder::with_model_from_file() method to “commit” the builder configuration into a Session.

Example

let environment = Environment::builder()
    .with_name("test")
    .with_log_level(LoggingLevel::Verbose)
    .build()?;
let mut session = environment
    .new_session_builder()?
    .with_optimization_level(GraphOptimizationLevel::Basic)?
    .with_number_threads(1)?
    .with_model_from_file("squeezenet.onnx")?;

Implementations

impl<'a> SessionBuilder<'a>

pub fn with_number_threads(self, num_threads: i16) -> Result<SessionBuilder<'a>>

Configure the session to use a number of threads

pub fn with_optimization_level( self, opt_level: GraphOptimizationLevel, ) -> Result<SessionBuilder<'a>>

Set the session’s optimization level

pub fn with_allocator( self, allocator: AllocatorType, ) -> Result<SessionBuilder<'a>>

Set the session’s allocator

Defaults to AllocatorType::Arena

pub fn with_memory_type( self, memory_type: MemType, ) -> Result<SessionBuilder<'a>>

Set the session’s memory type

Defaults to MemType::Default

pub fn with_model_downloaded<M>(self, model: M) -> Result<Session<'a>>

where M: Into<AvailableOnnxModel>,

Download an ONNX pre-trained model from the ONNX Model Zoo and commit the session

pub fn with_model_from_file<P>( self, model_filepath_ref: P, ) -> Result<Session<'a>>

where P: AsRef<Path> + 'a,

Load an ONNX graph from a file and commit the session

pub fn with_model_from_memory<B>(self, model_bytes: B) -> Result<Session<'a>>

where B: AsRef<[u8]>,

Load an ONNX graph from memory and commit the session

Trait Implementations

impl<'a> Debug for SessionBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Drop for SessionBuilder<'a>

fn drop(&mut self)

Executes the destructor for this type.