lightning_template.utils.optim.warmup_lr_scheduler
==================================================

.. py:module:: lightning_template.utils.optim.warmup_lr_scheduler


Classes
-------

.. autoapisummary::

   lightning_template.utils.optim.warmup_lr_scheduler.WarmupScheduler


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

.. py:class:: WarmupScheduler(*args, warmup_iters, warmup_ratio=0.1, warmup_mode='linear', **kwargs)

   Bases: :py:obj:`torch.optim.lr_scheduler._LRScheduler`


   Warm-up(increasing) learning rate in optimizer.

   :param optimizer: Wrapped optimizer.
   :type optimizer: Optimizer
   :param warmup_iters: target warm up epoch.


   .. py:attribute:: warmup_iters


   .. py:attribute:: warmup_ratio
      :value: 0.1



   .. py:attribute:: warmup_mode
      :value: 'linear'



   .. py:method:: get_lr()

      Compute learning rate using chainable form of the scheduler.