Struct SequentialLrSchedulerConfig 

pub struct SequentialLrSchedulerConfig { /* private fields */ }

Available on crate feature std only.

Configuration for a sequential learning rate scheduler.

Each milestone is the number of completed calls to LrScheduler::step at which the next scheduler takes over. Therefore, N schedulers require exactly N - 1 milestones. Milestones must be greater than zero and strictly increasing.

Example

The linear scheduler below handles the first 100 steps, after which the cosine scheduler starts from its own first step.

use burn_optim::lr_scheduler::{
    LrSchedulerConfig,
    cosine::CosineAnnealingLrSchedulerConfig, linear::LinearLrSchedulerConfig,
    sequential::SequentialLrSchedulerConfig,
};

let config = SequentialLrSchedulerConfig::new(
    vec![
        LrSchedulerConfig::Linear(LinearLrSchedulerConfig::new(1e-5, 1e-2, 100)),
        LrSchedulerConfig::Cosine(CosineAnnealingLrSchedulerConfig::new(1e-2, 900)),
    ],
    vec![100],
);
let scheduler = config.init().unwrap();

Implementations

impl SequentialLrSchedulerConfig

pub fn new(schedulers: Vec<LrSchedulerConfig>, milestones: Vec<usize>) -> Self

Create a new instance of the config.

Arguments

Required Arguments

schedulers

milestones

impl SequentialLrSchedulerConfig

pub fn init(&self) -> Result<ModuleLrScheduler, String>

Initializes a module learning rate scheduler.

Errors

An error is returned when there are no schedulers, the number of milestones is not one less than the number of schedulers, milestones are zero or not strictly increasing, or a child scheduler configuration is invalid.

Trait Implementations

impl Clone for SequentialLrSchedulerConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for SequentialLrSchedulerConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for SequentialLrSchedulerConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SequentialLrSchedulerConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SequentialLrSchedulerConfig

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

Formats the value using the given formatter.

impl From<SequentialLrSchedulerConfig> for LrSchedulerConfig

fn from(config: SequentialLrSchedulerConfig) -> Self

Converts to this type from the input type.

impl Serialize for SequentialLrSchedulerConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.