ksuit.schedules.linear.decreasing
=================================

.. py:module:: ksuit.schedules.linear.decreasing


Classes
-------

.. autoapisummary::

   ksuit.schedules.linear.decreasing.LinearDecreasingSchedule


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

.. py:class:: LinearDecreasingSchedule(config)

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


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

   .. rubric:: Example

   >>> schedule_config:
   >>>   kind: ksuit.schedules.LinearDecreasingSchedule
   >>>   max_value: ${model.optim.lr}
   >>>   end_value: 0.0

   Initialize the scheduler.

   :param max_value: The initial and thus maximum value of the scheduler.
   :param end_value: The final and thus minimum value of the scheduler.