ksuit.schedules.linear.increasing
=================================

.. py:module:: ksuit.schedules.linear.increasing


Classes
-------

.. autoapisummary::

   ksuit.schedules.linear.increasing.LinearIncreasingSchedule


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

.. py:class:: LinearIncreasingSchedule(config)

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


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

   .. rubric:: Example

   >>> schedule_config:
   >>>   kind: ksuit.schedules.LinearIncreasingSchedule
   >>>   max_value: ${model.optim.lr}
   >>>   start_value: 0.0

   Initialize the scheduler.

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