ksuit.schedules.linear_warmup_cosine_decay
==========================================

.. py:module:: ksuit.schedules.linear_warmup_cosine_decay


Classes
-------

.. autoapisummary::

   ksuit.schedules.linear_warmup_cosine_decay.LinearWarmupCosineDecaySchedule


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

.. py:class:: LinearWarmupCosineDecaySchedule(config)

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


   A cosine annealing scheduler with linear increasing warmup phase."

   .. rubric:: Example

   >>> schedule_config:
   >>>   kind: ksuit.schedules.LinearWarmupCosineDecaySchedule
   >>>   warmup_percent: 0.05
   >>>   end_value: 1.0e-6
   >>>   max_value: ${model.optim.lr}

   Initialize the scheduler.

   Takes either warmup_steps or warmup_percent as argument to determine the length of the warmup phase.

   :param config: Configuration for the linear warmup cosine decay schedule.


   .. py:attribute:: schedule
      :type:  ksuit.schedules.base.ScheduleBase


   .. py:attribute:: warmup_steps


   .. py:attribute:: warmup_percent