Module audiocraft.optim.linear_warmup_lr_scheduler

Classes

class LinearWarmupLRScheduler (optimizer: torch.optim.optimizer.Optimizer,
warmup_steps: int,
warmup_init_lr: float | None = 0)

Expand source code

class LinearWarmupLRScheduler(_LRScheduler):
    """Inverse square root LR scheduler.

    Args:
        optimizer (Optimizer): Torch optimizer.
        warmup_steps (int): Number of warmup steps.
        warmup_init_lr (tp.Optional[float]): Initial learning rate
            during warmup phase. When not set, use the provided learning rate.
    """
    def __init__(self, optimizer: Optimizer, warmup_steps: int, warmup_init_lr: tp.Optional[float] = 0):
        self.warmup_steps = warmup_steps
        self.warmup_init_lr = warmup_init_lr
        super().__init__(optimizer)

    def _get_sched_lr(self, lr: float, step: int):
        if step < self.warmup_steps:
            warmup_init_lr = self.warmup_init_lr or 0
            lr_step = (lr - warmup_init_lr) / self.warmup_steps
            lr = warmup_init_lr + step * lr_step
        return lr

    def get_lr(self):
        return [self._get_sched_lr(base_lr, self.last_epoch) for base_lr in self.base_lrs]

Inverse square root LR scheduler.

Args

optimizer : Optimizer

Torch optimizer.

warmup_steps : int

Number of warmup steps.

warmup_init_lr : tp.Optional[float]

Initial learning rate during warmup phase. When not set, use the provided learning rate.

Ancestors

• torch.optim.lr_scheduler._LRScheduler
• torch.optim.lr_scheduler.LRScheduler

Methods

def get_lr(self)

Expand source code

def get_lr(self):
    return [self._get_sched_lr(base_lr, self.last_epoch) for base_lr in self.base_lrs]