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

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


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   configure_optimizers/index.rst
   keep_and_linearly_decay_lr_scheduler/index.rst
   warmup_lr_scheduler/index.rst


Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   lightning_template.utils.optim.KeepAndLinearlyDecayLrScheduler
   lightning_template.utils.optim.WarmupScheduler



Functions
~~~~~~~~~

.. autoapisummary::

   lightning_template.utils.optim.get_configure_optimizers_method



.. py:function:: get_configure_optimizers_method(optim_config)


.. py:class:: KeepAndLinearlyDecayLrScheduler(optimizer, keep_epochs, decay_epochs, last_epoch=-1, verbose=False)


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

   Keep lr first then decay learning rate linearly in optimizer.

   :param optimizer: Wrapped optimizer.
   :type optimizer: Optimizer
   :param keep_epochs: target keep epoch.
   :param decay_epochs: target decay epoch.

   .. py:method:: get_lr()



.. 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()