:py:mod:`mipcandy.common.optim.lr_scheduler`
============================================

.. py:module:: mipcandy.common.optim.lr_scheduler

.. autodoc2-docstring:: mipcandy.common.optim.lr_scheduler
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`AbsoluteLinearLR <mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR>`
     - .. autodoc2-docstring:: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR
          :summary:
   * - :py:obj:`PolyLRScheduler <mipcandy.common.optim.lr_scheduler.PolyLRScheduler>`
     -

API
~~~

.. py:class:: AbsoluteLinearLR(optimizer: torch.optim.Optimizer, k: float, b: float, *, min_lr: float = 1e-06, restart: bool = False, last_epoch: int = -1)
   :canonical: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR

   Bases: :py:obj:`torch.optim.lr_scheduler.LRScheduler`

   .. autodoc2-docstring:: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR

   .. rubric:: Initialization

   .. autodoc2-docstring:: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR.__init__

   .. py:method:: _interp(epoch: int) -> float
      :canonical: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR._interp

      .. autodoc2-docstring:: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR._interp

   .. py:method:: get_lr() -> list[float]
      :canonical: mipcandy.common.optim.lr_scheduler.AbsoluteLinearLR.get_lr

.. py:class:: PolyLRScheduler(optimizer: torch.optim.Optimizer, initial_lr: float, max_steps: int, *, exponent: float = 0.9, last_epoch: int = -1)
   :canonical: mipcandy.common.optim.lr_scheduler.PolyLRScheduler

   Bases: :py:obj:`torch.optim.lr_scheduler.LRScheduler`

   .. py:method:: _interp(epoch: int) -> float
      :canonical: mipcandy.common.optim.lr_scheduler.PolyLRScheduler._interp

      .. autodoc2-docstring:: mipcandy.common.optim.lr_scheduler.PolyLRScheduler._interp

   .. py:method:: get_lr() -> list[float]
      :canonical: mipcandy.common.optim.lr_scheduler.PolyLRScheduler.get_lr