ksuit.schedules.step.fixed
==========================

.. py:module:: ksuit.schedules.step.fixed


Classes
-------

.. autoapisummary::

   ksuit.schedules.step.fixed.StepFixedSchedule


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

.. py:class:: StepFixedSchedule(config)

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


   A scheduler that progresses at fixed steps and increases or decreases by some factor at these steps.

   Initialize the scheduler.

   :param config: Configuration for the step fixed schedule.

   .. rubric:: Example

   >>> schedule_config:
   >>> kind: ksuit.schedules.StepFixedSchedule
   >>> factor: 0.1
   >>> start_value: ${model.optim.lr}
   >>> steps:
   >>>   - 0.01
   >>>   - 0.02
   >>>   - 0.03

   Lower LR by factor 0.1 at 1%, 2%, and 3% of total training steps.


   .. py:attribute:: steps


   .. py:attribute:: start_value


   .. py:attribute:: factor