Source code for chmncc.optimizers.reduce_lr_on_plateau

"""Reduce LR on plateau scheduler"""
import torch


def get_plateau_scheduler(
    optimizer: torch.optim.Optimizer, patience: int
) -> torch.optim.lr_scheduler._LRScheduler:
    r"""
    Get Reduce on Plateau scheduler

    Args:
        optimizer [nn.Optimizer]
        patience [int]
    Returns:
        scheduler [torch.optim.lr_scheduler._LRScheduler]
    """
    return torch.optim.lr_scheduler.ReduceLROnPlateau(
        optimizer=optimizer, mode="min", patience=patience
    )