artist.core.learning_rate_schedulers
====================================

.. py:module:: artist.core.learning_rate_schedulers


Functions
---------

.. autoapisummary::

   artist.core.learning_rate_schedulers.exponential
   artist.core.learning_rate_schedulers.cyclic
   artist.core.learning_rate_schedulers.reduce_on_plateau


Module Contents
---------------

.. py:function:: exponential(optimizer: torch.optim.Optimizer, parameters: dict[str, float]) -> torch.optim.lr_scheduler.LRScheduler

   Create an exponential learning rate scheduler.

   Parameters
   ----------
   optimizer : Optimizer
       The optimizer.
   parameters : dict[str, float]
       The scheduler parameters.

   Returns
   -------
   LRScheduler
       An exponential learning rate scheduler.


.. py:function:: cyclic(optimizer: torch.optim.Optimizer, parameters: dict[str, float]) -> torch.optim.lr_scheduler.LRScheduler

   Create a cyclic learning rate scheduler.

   Parameters
   ----------
   optimizer : Optimizer
       The optimizer.
   parameters : dict[str, float]
       The scheduler parameters.

   Returns
   -------
   LRScheduler
       A cyclic learning rate scheduler.


.. py:function:: reduce_on_plateau(optimizer: torch.optim.Optimizer, parameters: dict[str, float]) -> torch.optim.lr_scheduler.LRScheduler

   Create learning rate scheduler that reduces on plateaus.

   Parameters
   ----------
   optimizer : Optimizer
       The optimizer.
   parameters : dict[str, float]
       The scheduler parameters.

   Returns
   -------
   LRScheduler
       A learning rate scheduler that reduces on plateaus.