:py:mod:`neural_compressor.experimental.common.optimizer`
=========================================================

.. py:module:: neural_compressor.experimental.common.optimizer

.. autoapi-nested-parse::

   Intel Neural Compressor built-in Optimizers on multiple framework backends.



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

Classes
~~~~~~~

.. autoapisummary::

   neural_compressor.experimental.common.optimizer.TensorflowOptimizers
   neural_compressor.experimental.common.optimizer.PyTorchOptimizers
   neural_compressor.experimental.common.optimizer.Optimizers
   neural_compressor.experimental.common.optimizer.TensorFlowSGD
   neural_compressor.experimental.common.optimizer.TensorFlowAdamW
   neural_compressor.experimental.common.optimizer.PyTorchSGD



Functions
~~~~~~~~~

.. autoapisummary::

   neural_compressor.experimental.common.optimizer.optimizer_registry



.. py:class:: TensorflowOptimizers




   Class to get all registered TensorFlow Optimizers once only.


.. py:class:: PyTorchOptimizers




   Class to get all registered PyTorch Optimizers once only.


.. py:class:: Optimizers(framework)




   Main entry to get the specific type of optimizer.


.. py:function:: optimizer_registry(optimizer_type, framework)

   Class decorator used to register all Optimizer subclasses.

      Cross framework optimizer is supported by add param as framework='tensorflow, pytorch'

   :param optimizer_type: The string of supported criterion.
   :type optimizer_type: str
   :param framework: The string of supported framework.
   :type framework: str

   :returns: The class of register.
   :rtype: cls


.. py:class:: TensorFlowSGD(param_dict)




   TensorFlow keras SGD optimizer.

   :param param_dict: The dict of parameters setting by user for SGD optimizer
   :type param_dict: dict


.. py:class:: TensorFlowAdamW(param_dict)




   tensorflow_addons AdamW optimizer.

   :param param_dict: The dict of parameters setting by user for AdamW optimizer
   :type param_dict: dict


.. py:class:: PyTorchSGD(param_dict)




   PyTorch SGD optimizer.

   :param param_dict: The dict of parameters setting by user for SGD optimizer
   :type param_dict: dict