Struct ScheduleConfig

pub struct ScheduleConfig { /* private fields */ }

Configuration for scheduling the forward computation in MNN.

The ScheduleConfig struct is used to configure various parameters for scheduling the forward computation in the MNN framework. It allows setting the type of backend, the number of threads, the mode of computation, and other options.

Example

use mnn::schedule::{ScheduleConfig, ForwardType};

let mut config = ScheduleConfig::new();
config.set_type(ForwardType::Auto);
config.set_num_threads(4);
config.set_mode(0);

Fields

• inner: A raw pointer to the underlying MNNScheduleConfig structure.
• backend_config: Specifies backend-specific configurations.
• __marker: A marker to ensure the struct is !Send by default.

Methods

• new() -> Self: Creates a new ScheduleConfig with default settings.
• as_ptr_mut(&mut self) -> *mut MNNScheduleConfig: Returns a mutable raw pointer to the underlying MNNScheduleConfig.
• set_save_tensors(&mut self, save_tensors: &[&str]) -> Result<()>: Sets the tensors to be saved during computation.
• set_type(&mut self, forward_type: ForwardType): Sets the type of backend to be used for computation.
• set_num_threads(&mut self, num_threads: i32): Sets the number of threads to be used for computation.
• set_mode(&mut self, mode: i32): Sets the mode of computation.
• set_backup_type(&mut self, backup_type: ForwardType): Sets the backup type of backend to be used if the primary backend fails.
• set_backend_config(&mut self, backend_config: impl Into<Option<BackendConfig>>): Sets the backend-specific configuration.

Safety

The ScheduleConfig struct contains raw pointers and interacts with the underlying C API of MNN. Users should be cautious when using this struct to avoid undefined behavior.

Warning

Warning: The Drop implementation for ScheduleConfig ensures that the underlying MNNScheduleConfig is properly destroyed when the struct goes out of scope. Users should not manually free the inner pointer.

Implementations

impl ScheduleConfig

pub fn as_ptr_mut(&mut self) -> *mut MNNScheduleConfig

Returns a mutable raw pointer to the underlying MNNScheduleConfig.

pub fn new() -> Self

Creates a new ScheduleConfig with default settings.

pub fn set_save_tensors(&mut self, save_tensors: &[&str]) -> Result<&mut Self>

Sets the tensors to be saved during computation.

Arguments

• save_tensors: A slice of tensor names to be saved.

Errors

Returns an error if any of the tensor names contain null bytes.

pub fn set_type(&mut self, forward_type: ForwardType) -> &mut Self

Sets the type of backend to be used for computation.

Arguments

• forward_type: The type of backend to be used.

pub fn with_type(self, forward_type: ForwardType) -> Self

Sets the type of backend to be used for computation.

pub fn get_type(&self) -> ForwardType

Gets the type of backend to be used for computation.

pub fn set_num_threads(&mut self, num_threads: i32) -> &mut Self

Sets the number of threads to be used for computation.

Arguments

• num_threads: The number of threads to be used.

pub fn with_num_threads(self, num_threads: i32) -> Self

Sets the number of threads to be used for computation.

pub fn set_mode(&mut self, mode: i32) -> &mut Self

Sets the mode of computation.

Arguments

• mode: The mode of computation.

pub fn with_mode(self, mode: i32) -> Self

Sets the mode of computation.

pub fn set_backup_type(&mut self, backup_type: ForwardType) -> &mut Self

Sets the backup type of backend to be used if the primary backend fails.

Arguments

• backup_type: The backup type of backend to be used.

pub fn with_backup_type(self, backup_type: ForwardType) -> Self

Sets the backup type of backend to be used if the primary backend fails.

pub fn get_backup_type(&self) -> ForwardType

Gets the backup type of backend to be used if the primary backend fails.

pub fn set_backend_config( &mut self, backend_config: impl Into<Option<BackendConfig>>, ) -> &mut Self

Sets the backend-specific configuration.

Arguments

• backend_config: specifies additional backend-specific configurations.

pub fn with_backend_config( self, backend_config: impl Into<Option<BackendConfig>>, ) -> Self

Sets the backend-specific configuration.

Trait Implementations

impl Clone for ScheduleConfig

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduleConfig

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

Formats the value using the given formatter.

impl Default for ScheduleConfig

fn default() -> Self

Returns the “default value” for a type.

impl Drop for ScheduleConfig

fn drop(&mut self)

Executes the destructor for this type.

impl FromIterator<ScheduleConfig> for ScheduleConfigs

fn from_iter<T: IntoIterator<Item = ScheduleConfig>>(iter: T) -> Self

Creates a value from an iterator.

impl Send for ScheduleConfig