composer.optim.scheduler_hparams#
Hyperparameters for schedulers.
Hparams
These classes are used with yahp
for YAML
-based configuration.
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Hyperparameters for the |
|
Base class for scheduler hyperparameter classes. |
|
Hyperparameters for the |
- class composer.optim.scheduler_hparams.ConstantSchedulerHparams(alpha=1.0, t_max='1dur')[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
ConstantScheduler
scheduler.See
ConstantScheduler
for documentation.- Parameters
alpha (float, optional) โ See
ConstantScheduler
.t_max (str, optional) โ See
ConstantScheduler
.
- class composer.optim.scheduler_hparams.CosineAnnealingSchedulerHparams(t_max='1dur', alpha_f=0.0)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
CosineAnnealingScheduler
scheduler.See
CosineAnnealingScheduler
for documentation.- Parameters
t_max (str, optional) โ See
CosineAnnealingScheduler
.alpha_f (float, optional) โ See
CosineAnnealingScheduler
.
- class composer.optim.scheduler_hparams.CosineAnnealingWarmRestartsSchedulerHparams(t_0='1dur', alpha_f=0.0, t_mult=1.0)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
CosineAnnealingWarmRestartsScheduler
scheduler.See
CosineAnnealingWarmRestartsScheduler
for documentation.- Parameters
t_0 (str, optional) โ See
CosineAnnealingWarmRestartsScheduler
.alpha_f (float, optional) โ See
CosineAnnealingWarmRestartsScheduler
.t_mult (float, optional) โ See
CosineAnnealingWarmRestartsScheduler
.
- class composer.optim.scheduler_hparams.CosineAnnealingWithWarmupSchedulerHparams(t_warmup, t_max='1dur', alpha_f=0.0)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
CosineAnnealingWithWarmupScheduler
scheduler.See
CosineAnnealingWithWarmupScheduler
for documentation.- Parameters
t_warmup (str) โ See
CosineAnnealingWithWarmupScheduler
.t_max (str, optional) โ See
CosineAnnealingWithWarmupScheduler
.alpha_f (float, optional) โ See
CosineAnnealingWithWarmupScheduler
.
- class composer.optim.scheduler_hparams.ExponentialSchedulerHparams(gamma, decay_period='1ep')[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
ExponentialScheduler
scheduler.See
ExponentialScheduler
for documentation.- Parameters
gamma (float) โ See
ExponentialScheduler
.decay_period (str, optional) โ See
ExponentialScheduler
.
- class composer.optim.scheduler_hparams.LinearSchedulerHparams(alpha_i=1.0, alpha_f=0.0, t_max='1dur')[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
LinearScheduler
scheduler.See
LinearScheduler
for documentation.- Parameters
alpha_i (float, optional) โ See
LinearScheduler
.alpha_f (float, optional) โ See
LinearScheduler
.t_max (str, optional) โ See
LinearScheduler
.
- class composer.optim.scheduler_hparams.LinearWithWarmupSchedulerHparams(t_warmup, alpha_i=1.0, alpha_f=0.0, t_max='1dur')[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
LinearWithWarmupScheduler
scheduler.See
LinearWithWarmupScheduler
for documentation.- Parameters
t_warmup (str) โ See
LinearWithWarmupScheduler
.alpha_i (float, optional) โ See
LinearWithWarmupScheduler
.alpha_f (float, optional) โ See
LinearWithWarmupScheduler
.t_max (str, optional) โ See
LinearWithWarmupScheduler
.
- class composer.optim.scheduler_hparams.MultiStepSchedulerHparams(milestones, gamma=0.1)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
MultiStepScheduler
scheduler.See
MultiStepScheduler
for documentation.- Parameters
milestones (List[str]) โ See
MultiStepScheduler
.gamma (float, optional) โ See
MultiStepScheduler
.
- class composer.optim.scheduler_hparams.MultiStepWithWarmupSchedulerHparams(t_warmup, milestones, gamma=0.1)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
MultiStepWithWarmupScheduler
scheduler.See
MultiStepWithWarmupScheduler
for documentation.- Parameters
t_warmup (str,) โ See
MultiStepWithWarmupScheduler
.milestones (List[str]) โ See
MultiStepWithWarmupScheduler
.gamma (float, optional) โ See
MultiStepWithWarmupScheduler
.
- class composer.optim.scheduler_hparams.PolynomialSchedulerHparams(power, t_max='1dur', alpha_f=0.0)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
PolynomialScheduler
scheduler.See
PolynomialScheduler
for documentation.- Parameters
power (float) โ See
PolynomialScheduler
.t_max (str, optional) โ See
PolynomialScheduler
.alpha_f (float, optional) โ See
PolynomialScheduler
.
- class composer.optim.scheduler_hparams.SchedulerHparams[source]#
Bases:
yahp.hparams.Hparams
,abc.ABC
Base class for scheduler hyperparameter classes.
Scheduler parameters that are added to
TrainerHparams
(e.g. via YAML or the CLI) are initialized in the training loop.
- class composer.optim.scheduler_hparams.StepSchedulerHparams(step_size, gamma=0.1)[source]#
Bases:
composer.optim.scheduler_hparams.SchedulerHparams
Hyperparameters for the
StepScheduler
scheduler.See
StepScheduler
for documentation.- Parameters
step_size (str, optional) โ See
StepScheduler
.gamma (float, optional) โ See
StepScheduler
.