pub struct RunningState<V> { /* private fields */ }
Expand description
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§
Source§impl<const D: usize, B: Backend> RunningState<Tensor<B, D>>
impl<const D: usize, B: Backend> RunningState<Tensor<B, D>>
Sourcepub fn from_record(record: Param<Tensor<B, D>>) -> Self
pub fn from_record(record: Param<Tensor<B, D>>) -> Self
Create a new running state from a record.
Sourcepub fn value_sync(&self) -> Tensor<B, D>
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§
Source§impl<const D: usize, B: AutodiffBackend> AutodiffModule<B> for RunningState<Tensor<B, D>>
impl<const D: usize, B: AutodiffBackend> AutodiffModule<B> for RunningState<Tensor<B, D>>
Source§type InnerModule = RunningState<Tensor<<B as AutodiffBackend>::InnerBackend, D>>
type InnerModule = RunningState<Tensor<<B as AutodiffBackend>::InnerBackend, D>>
Inner module without auto-differentiation.
Source§fn valid(&self) -> Self::InnerModule
fn valid(&self) -> Self::InnerModule
Get the same module, but on the inner backend without auto-differentiation.
Source§impl<V: Clone> Clone for RunningState<V>
impl<V: Clone> Clone for RunningState<V>
Source§fn clone(&self) -> RunningState<V>
fn clone(&self) -> RunningState<V>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl<V: Debug> Debug for RunningState<V>
impl<V: Debug> Debug for RunningState<V>
Source§impl<V> Display for RunningState<V>
impl<V> Display for RunningState<V>
Source§impl<const D: usize, B: Backend> Module<B> for RunningState<Tensor<B, D>>
impl<const D: usize, B: Backend> Module<B> for RunningState<Tensor<B, D>>
Source§fn visit<V: ModuleVisitor<B>>(&self, visitor: &mut V)
fn visit<V: ModuleVisitor<B>>(&self, visitor: &mut V)
Visit each tensor parameter in the module with a visitor.
Source§fn map<M: ModuleMapper<B>>(self, mapper: &mut M) -> Self
fn map<M: ModuleMapper<B>>(self, mapper: &mut M) -> Self
Map each tensor parameter in the module with a mapper.
Source§fn into_record(self) -> Self::Record
fn into_record(self) -> Self::Record
Convert the module into a record containing the state.
Source§fn load_record(self, record: Self::Record) -> Self
fn load_record(self, record: Self::Record) -> Self
Load the module state from a record.
Source§fn to_device(self, device: &Device<B>) -> Self
fn to_device(self, device: &Device<B>) -> Self
Move the module and all of its sub-modules to the given device. Read more
Source§fn fork(self, device: &Device<B>) -> Self
fn fork(self, device: &Device<B>) -> Self
Fork the module and all of its sub-modules to the given device. Read more
Source§fn collect_devices(&self, devices: Vec<Device<B>>) -> Vec<Device<B>> ⓘ
fn collect_devices(&self, devices: Vec<Device<B>>) -> Vec<Device<B>> ⓘ
Return all the devices found in the underneath module tree added to the given vector
without duplicates.
Source§fn devices(&self) -> Devices<B>
fn devices(&self) -> Devices<B>
Return all the devices found in the underneath module tree without duplicates.
Source§fn num_params(&self) -> usize
fn num_params(&self) -> usize
Get the number of parameters the module has, including all of its sub-modules.
Source§fn save_file<FR, PB>(
self,
file_path: PB,
recorder: &FR,
) -> Result<(), RecorderError>
fn save_file<FR, PB>( self, file_path: PB, recorder: &FR, ) -> Result<(), RecorderError>
Available on crate feature
std
only.Save the module to a file using the provided file recorder. Read more
Source§fn load_file<FR, PB>(
self,
file_path: PB,
recorder: &FR,
device: &B::Device,
) -> Result<Self, RecorderError>
fn load_file<FR, PB>( self, file_path: PB, recorder: &FR, device: &B::Device, ) -> Result<Self, RecorderError>
Available on crate feature
std
only.Load the module from a file using the provided file recorder. Read more
Source§fn quantize_weights(self, quantizer: &mut Quantizer) -> Self
fn quantize_weights(self, quantizer: &mut Quantizer) -> Self
Quantize the weights of the module.
Source§impl<V> ModuleDisplay for RunningState<V>
impl<V> ModuleDisplay for RunningState<V>
Source§fn format(&self, passed_settings: DisplaySettings) -> String
fn format(&self, passed_settings: DisplaySettings) -> String
Formats the module with provided display settings. Read more
Source§fn custom_settings(&self) -> Option<DisplaySettings>
fn custom_settings(&self) -> Option<DisplaySettings>
Custom display settings for the module. Read more
Source§impl<V> ModuleDisplayDefault for RunningState<V>
impl<V> ModuleDisplayDefault for RunningState<V>
Auto Trait Implementations§
impl<V> Freeze for RunningState<V>
impl<V> RefUnwindSafe for RunningState<V>
impl<V> Send for RunningState<V>where
V: Send,
impl<V> Sync for RunningState<V>where
V: Send,
impl<V> Unpin for RunningState<V>
impl<V> UnwindSafe for RunningState<V>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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