.. _f-sgdlearningrate:

module ``training.sgd_learning_rate``
=====================================





.. inheritance-diagram:: onnxcustom.training.sgd_learning_rate


Short summary
+++++++++++++

module ``onnxcustom.training.sgd_learning_rate``

Helper for :epkg:`onnxruntime-training`.


:githublink:`%|py|6`




Classes
+++++++

+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| class                                                                                            | truncated documentation                                                                                             |
+==================================================================================================+=====================================================================================================================+
| :class:`BaseLearningRate <onnxcustom.training.sgd_learning_rate.BaseLearningRate>`               | Class handling the learning rate update after every iteration of a gradient. Two methods need to be overwritten ... |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :class:`LearningRateSGD <onnxcustom.training.sgd_learning_rate.LearningRateSGD>`                 | Implements the learning the same way as :class:`sklearn.linear_model.SGDRegressor`.                                 |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+
| :class:`LearningRateSGDNesterov <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov>` | Implements the learning the same way as :class:`sklearn.linear_model.SGDRegressor`.                                 |
+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| property                                                                                      | truncated documentation                                                 |
+===============================================================================================+=========================================================================+
| :meth:`needs_grad <onnxcustom.training.sgd_learning_rate.BaseLearningRate.needs_grad>`        | Returns the True if the gradient update needs to retain past gradients. |
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`needs_grad <onnxcustom.training.sgd_learning_rate.LearningRateSGD.needs_grad>`         | Returns the True if the gradient update needs to retain past gradients. |
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`needs_grad <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.needs_grad>` | Returns the True if the gradient update needs to retain past gradients. |
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`value <onnxcustom.training.sgd_learning_rate.BaseLearningRate.value>`                  | Returns the current learning rate.                                      |
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`value <onnxcustom.training.sgd_learning_rate.LearningRateSGD.value>`                   | Returns the current learning rate.                                      |
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`value <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.value>`           | Returns the current learning rate.                                      |
+-----------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+




Static Methods
++++++++++++++

+---------------------------------------------------------------------------------------+-----------------------------------------------------------+
| staticmethod                                                                          | truncated documentation                                   |
+=======================================================================================+===========================================================+
| :meth:`select <onnxcustom.training.sgd_learning_rate.BaseLearningRate.select>`        | Returns an instance of a given initialized with *kwargs*. |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`select <onnxcustom.training.sgd_learning_rate.LearningRateSGD.select>`         | Returns an instance of a given initialized with *kwargs*. |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`select <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.select>` | Returns an instance of a given initialized with *kwargs*. |
+---------------------------------------------------------------------------------------+-----------------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| method                                                                                                            | truncated documentation                                          |
+===================================================================================================================+==================================================================+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_rate.BaseLearningRate.__init__>`                             |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_rate.LearningRateSGD.__init__>`                              |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.__init__>`                      |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training.sgd_learning_rate.BaseLearningRate.__repr_extended__>`           |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training.sgd_learning_rate.LearningRateSGD.__repr_extended__>`            |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.__repr_extended__>`    |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_rate.BaseLearningRate._call_iobinding>`               |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_rate.LearningRateSGD._call_iobinding>`                |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov._call_iobinding>`        |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_rate.LearningRateSGD.build_onnx_function>`           |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.build_onnx_function>`   |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`init_learning_rate <onnxcustom.training.sgd_learning_rate.BaseLearningRate.init_learning_rate>`            | Initializes the learning rate at the beginning of the training.  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`init_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGD.init_learning_rate>`             | Updates the learning rate at the end of an iteration.            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`init_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.init_learning_rate>`     | Updates the learning rate at the end of an iteration.            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`loop <onnxcustom.training.sgd_learning_rate.BaseLearningRate.loop>`                                        | Loops over learning rate values, *n* to be precise.              |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`loop <onnxcustom.training.sgd_learning_rate.LearningRateSGD.loop>`                                         | Loops over learning rate values, *n* to be precise.              |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`loop <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.loop>`                                 | Loops over learning rate values, *n* to be precise.              |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`update_learning_rate <onnxcustom.training.sgd_learning_rate.BaseLearningRate.update_learning_rate>`        | Updates the learning rate at the end of an iteration.            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`update_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGD.update_learning_rate>`         | Updates the learning rate at the end of an iteration.            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`update_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.update_learning_rate>` | Updates the learning rate at the end of an iteration.            |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_rate.BaseLearningRate.update_weights>`                    | Updates weights based on the algorithm this class is setting up. |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_rate.LearningRateSGD.update_weights>`                     |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.update_weights>`             |                                                                  |
+-------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: onnxcustom.training.sgd_learning_rate
    :members:
    :special-members: __init__
    :show-inheritance: