Struct burn_core::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: Backend> RunningState<Tensor<B, D>>

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

Create a new running state.

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

Create a new running state.

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

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 synchonization needs to happen.

Trait Implementations

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

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

fn valid(&self) -> Self::InnerModule

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

impl<V: Clone> Clone for RunningState<V>

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> Debug for RunningState<V>

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

Formats the value using the given formatter.

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

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

Type to save and load the module.

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

Visit each tensor in the module with a visitor.

fn map<M: ModuleMapper<B>>(self, mapper: &mut M) -> Self

Map each tensor in the module with a mapper.

fn into_record(self) -> Self::Record

Convert the module into a record containing the state.

fn load_record(self, record: Self::Record) -> Self

Load the module state from a record.

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

Get the device list of the module and all of its sub-modules.

fn fork(self, device: &B::Device) -> Self

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

fn to_device(self, device: &B::Device) -> Self

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

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.