ksuit.schedules.polynomial.decreasing
=====================================

.. py:module:: ksuit.schedules.polynomial.decreasing


Classes
-------

.. autoapisummary::

   ksuit.schedules.polynomial.decreasing.PolynomialDecreasingSchedule


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

.. py:class:: PolynomialDecreasingSchedule(config)

   Bases: :py:obj:`ksuit.schedules.base.DecreasingProgressSchedule`


   A scheduler that decreases polynomially from the maximum to minimum value over the total number of steps.

   Initialize the scheduler.

   :param config: Configuration for the polynomial decreasing schedule.

   .. rubric:: Example

   >>> schedule_config:
   >>>     kind: ksuit.schedules.PolynomialDecreasingSchedule
   >>>     power: 2.0
   >>>     start_value: ${model.optim.lr} # reference to the lr defined above
   >>>     end_value: 1e-6


   .. py:attribute:: power