pub struct CyclicalScheduler { /* private fields */ }Expand description
Cyclical learning rates (CLR) — oscillates between min_lr and max_lr.
Uses triangular policy: linear up then linear down, period = 2 * step_size.
Implementations§
Source§impl CyclicalScheduler
impl CyclicalScheduler
Sourcepub fn new(
min_lr: f64,
max_lr: f64,
step_size: usize,
) -> Result<Self, SchedulerError>
pub fn new( min_lr: f64, max_lr: f64, step_size: usize, ) -> Result<Self, SchedulerError>
Create a new cyclical learning rate scheduler.
§Errors
Returns SchedulerError::InvalidConfig if any parameter is invalid.
Trait Implementations§
Source§impl LrSchedulerV2 for CyclicalScheduler
impl LrSchedulerV2 for CyclicalScheduler
Source§fn current_lr(&self) -> f64
fn current_lr(&self) -> f64
Return the current learning rate without advancing.
Source§fn steps_taken(&self) -> usize
fn steps_taken(&self) -> usize
Total number of steps taken.
Source§fn completed_cycle(&self) -> bool
fn completed_cycle(&self) -> bool
Whether the scheduler has completed a cycle (if applicable).
Auto Trait Implementations§
impl Freeze for CyclicalScheduler
impl RefUnwindSafe for CyclicalScheduler
impl Send for CyclicalScheduler
impl Sync for CyclicalScheduler
impl Unpin for CyclicalScheduler
impl UnsafeUnpin for CyclicalScheduler
impl UnwindSafe for CyclicalScheduler
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> 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