Struct burn::lr_scheduler::linear::LinearLrScheduler
pub struct LinearLrScheduler { /* private fields */ }Expand description
A linear learning rate scheduler.
See LinearLrSchedulerConfig for more information.
Trait Implementations§
§impl Clone for LinearLrScheduler
impl Clone for LinearLrScheduler
§fn clone(&self) -> LinearLrScheduler
fn clone(&self) -> LinearLrScheduler
Returns a copy 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 more§impl Debug for LinearLrScheduler
impl Debug for LinearLrScheduler
§impl LrScheduler for LinearLrScheduler
impl LrScheduler for LinearLrScheduler
§type Record<B: Backend> = usize
type Record<B: Backend> = usize
Scheduler associative type to be used when saving and loading the state.
§fn step(&mut self) -> f64
fn step(&mut self) -> f64
Perform the scheduler step, potentially updating its state, and returning the effective
learning rate.
§fn to_record<B>(&self) -> <LinearLrScheduler as LrScheduler>::Record<B>where
B: Backend,
fn to_record<B>(&self) -> <LinearLrScheduler as LrScheduler>::Record<B>where
B: Backend,
Get the current state of the scheduler as a record.
§fn load_record<B>(
self,
record: <LinearLrScheduler as LrScheduler>::Record<B>,
) -> LinearLrSchedulerwhere
B: Backend,
fn load_record<B>(
self,
record: <LinearLrScheduler as LrScheduler>::Record<B>,
) -> LinearLrSchedulerwhere
B: Backend,
Load the state of the scheduler as a record.
impl Copy for LinearLrScheduler
Auto Trait Implementations§
impl Freeze for LinearLrScheduler
impl RefUnwindSafe for LinearLrScheduler
impl Send for LinearLrScheduler
impl Sync for LinearLrScheduler
impl Unpin for LinearLrScheduler
impl UnwindSafe for LinearLrScheduler
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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