.. _f-sgdlearningpenalty:

module ``training.sgd_learning_penalty``
========================================





.. inheritance-diagram:: onnxcustom.training.sgd_learning_penalty


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

module ``onnxcustom.training.sgd_learning_penalty``

Helper for :epkg:`onnxruntime-training`.


:githublink:`%|py|6`




Classes
+++++++

+---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| class                                                                                             | truncated documentation                                                                                |
+===================================================================================================+========================================================================================================+
| :class:`BaseLearningPenalty <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty>`       | Class handling the penalty on the coefficients for class :class:`OrtGradientForwardBackwardOptimizer`. |
+---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :class:`ElasticLearningPenalty <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty>` | Implements a L1 or L2 regularization on weights.                                                       |
+---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+
| :class:`NoLearningPenalty <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty>`           | No regularization.                                                                                     |
+---------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------+








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

+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
| staticmethod                                                                            | truncated documentation                                   |
+=========================================================================================+===========================================================+
| :meth:`select <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.select>`    | Returns an instance of a given initialized with *kwargs*. |
+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`select <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.select>` | Returns an instance of a given initialized with *kwargs*. |
+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+
| :meth:`select <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.select>`      | Returns an instance of a given initialized with *kwargs*. |
+-----------------------------------------------------------------------------------------+-----------------------------------------------------------+




Methods
+++++++

+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| method                                                                                                            | truncated documentation                                                        |
+===================================================================================================================+================================================================================+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.__init__>`                       |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.__init__>`                    |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.__init__>`                         |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty._call_iobinding>`         |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty._call_iobinding>`      |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty._call_iobinding>`           |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.build_onnx_function>` |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.build_onnx_function>`      |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`penalty_loss <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.penalty_loss>`                  | Returns the received loss. Updates the loss inplace.                           |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`penalty_loss <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.penalty_loss>`               | Computes the penalty associated to every weights and adds them up to the loss. |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`penalty_loss <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.penalty_loss>`                    | Returns the received loss. Updates the loss inplace.                           |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.update_weights>`              | Returns the received loss. Updates the weight inplace.                         |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.update_weights>`           |                                                                                |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.update_weights>`                | Returns the received loss. Updates the weight inplace.                         |
+-------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------+


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

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