Struct burn::module::RunningState

pub struct RunningState<V> { /* private fields */ }

A state that can be updated during the forward pass while being thread safe.

Note

The state value is the average of all updates on all threads.

Implementations

impl<const D: usize, B> RunningState<Tensor<B, D>>

where B: Backend,

pub fn new(value: Tensor<B, D>) -> RunningState<Tensor<B, D>>

Create a new running state.

pub fn with_id(id: ParamId, value: Tensor<B, D>) -> RunningState<Tensor<B, D>>

Create a new running state.

pub fn from_record(record: Param<Tensor<B, D>>) -> RunningState<Tensor<B, D>>

Create a new running state from a record.

pub fn update(&self, value: Tensor<B, D>)

Update the value on the current thread.

pub fn value(&self) -> Tensor<B, D>

Get the current value,

Note

The current value might be outdated by one update.

pub fn value_sync(&self) -> Tensor<B, D>

Get the current value and make sure it is sync.

Note

Don’t use this function after an update on the same thread where other threads might have to register their update before the actual synchronization needs to happen.

Trait Implementations

impl<const D: usize, B> AutodiffModule<B> for RunningState<Tensor<B, D>>

where B: AutodiffBackend,

type InnerModule = RunningState<Tensor<<B as AutodiffBackend>::InnerBackend, D>>

Inner module without auto-differentiation.

fn valid( &self, ) -> <RunningState<Tensor<B, D>> as AutodiffModule<B>>::InnerModule

Get the same module, but on the inner backend without auto-differentiation.

impl<V> Clone for RunningState<V>

where V: Clone,

fn clone(&self) -> RunningState<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<V> Debug for RunningState<V>

where V: Debug,

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

Formats the value using the given formatter.

impl<V> Display for RunningState<V>

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

Formats the value using the given formatter.

impl<const D: usize, B> Module<B> for RunningState<Tensor<B, D>>

where B: Backend,

type Record = Param<Tensor<B, D>>

Type to save and load the module.

fn visit<V>(&self, visitor: &mut V)

where V: ModuleVisitor<B>,

Visit each tensor parameter in the module with a visitor.

fn map<M>(self, mapper: &mut M) -> RunningState<Tensor<B, D>>

where M: ModuleMapper<B>,

Map each tensor parameter in the module with a mapper.

fn into_record(self) -> <RunningState<Tensor<B, D>> as Module<B>>::Record

Convert the module into a record containing the state.

fn load_record( self, record: <RunningState<Tensor<B, D>> as Module<B>>::Record, ) -> RunningState<Tensor<B, D>>

Load the module state from a record.

fn to_device( self, device: &<B as Backend>::Device, ) -> RunningState<Tensor<B, D>>

Move the module and all of its sub-modules to the given device.

fn fork(self, device: &<B as Backend>::Device) -> RunningState<Tensor<B, D>>

Fork the module and all of its sub-modules to the given device.

fn collect_devices( &self, devices: Vec<<B as Backend>::Device>, ) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree added to the given vector without duplicates.

fn devices(&self) -> Vec<<B as Backend>::Device>

Return all the devices found in the underneath module tree without duplicates.

fn no_grad(self) -> Self

Each tensor in the module tree will not require grad.

fn num_params(&self) -> usize

Get the number of parameters the module has, including all of its sub-modules.

fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Save the module to a file using the provided file recorder.

fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &<B as Backend>::Device, ) -> Result<Self, RecorderError>

where FR: FileRecorder<B>, PB: Into<PathBuf>,

Load the module from a file using the provided file recorder.

fn quantize_weights<C>(self, quantizer: &mut Quantizer<C>) -> Self

where C: Calibration,

Quantize the weights of the module.

impl<V> ModuleDisplay for RunningState<V>

fn format(&self, passed_settings: DisplaySettings) -> String

Formats the module with provided display settings.

fn custom_settings(&self) -> Option<DisplaySettings>

Custom display settings for the module.

fn custom_content(&self, _content: Content) -> Option<Content>

Custom attributes for the module.

impl<V> ModuleDisplayDefault for RunningState<V>

fn content(&self, content: Content) -> Option<Content>

Attributes of the module used for display purposes.

fn num_params(&self) -> usize

Gets the number of the parameters of the module.