:py:mod:`lightning_template.utils.optim.warmup_lr_scheduler`
============================================================

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


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

Classes
~~~~~~~

.. autoapisummary::

   lightning_template.utils.optim.warmup_lr_scheduler.WarmupScheduler




.. py:class:: WarmupScheduler(optimizer, warmup_iters, warmup_ratio=0.1, warmup_mode='linear', last_epoch=-1, verbose=False)


   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:method:: get_lr()