lightning_template.utils.optim.configure_optimizers
===================================================

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


Functions
---------

.. autoapisummary::

   lightning_template.utils.optim.configure_optimizers.parser_optim_config
   lightning_template.utils.optim.configure_optimizers.get_parameters
   lightning_template.utils.optim.configure_optimizers.construct_lr_scheduler
   lightning_template.utils.optim.configure_optimizers.get_configure_optimizers_method


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

.. py:function:: parser_optim_config(optim_config)

   Parse the optimizer config.

   :param optim_config: The optimizer and lr_scheduler config.
   :type optim_config: dict


.. py:function:: get_parameters(model, all_required_parameters: set, finetune_rest=False, return_rest=False)

   Get all optimizer parameters.

   :param model: a LightningModule.
   :param all_required_parameters: a set of required parameter names.


.. py:function:: construct_lr_scheduler(lr_scheduler, optimizer)

   Constructs the lr_scheduler.

   :param lr_scheduler: dictionary containing lr_scheduler configuration.
   :param optimizer: optimizer used to construct lr_scheduler.


.. py:function:: get_configure_optimizers_method(optim_config)