:mod:`heat.optim`
=================
.. py:module:: heat.optim

.. autoapi-nested-parse::

   Optimizer module.

   It contains data parallel specific optimizers and learning rate schedulers. It also includes all of the
   optimizers and learning rate schedulers in the torch namespace



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

   dp_optimizer/index.rst
   lr_scheduler/index.rst
   utils/index.rst


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


.. function:: __getattr__(name)

   Call the torch learning rate scheduler of a specified name


.. function:: __getattr__(name)

   When a function is called for the heat.optim module it will attempt to run the heat optimizer with that
   name, then, if there is no such heat optimizer, it will attempt to get the torch optimizer of that name.