.. _f-optimizerspartial:

module ``training.optimizers_partial``
======================================





.. inheritance-diagram:: onnxcustom.training.optimizers_partial


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

module ``onnxcustom.training.optimizers_partial``

Optimizer with :epkg:`onnxruntime-training` forward backward training.


:githublink:`%|py|5`




Classes
+++++++

+---------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                                     | truncated documentation                                                                                                                                |
+===========================================================================================================================+========================================================================================================================================================+
| :class:`OrtGradientForwardBackwardOptimizer <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer>` | Implements a simple :epkg:`Stochastic Gradient Descent` with :epkg:`onnxruntime-training`. It leverages class :class:`OrtGradientForwardBackward`. ... |
+---------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

+------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| property                                                                                                         | truncated documentation                                                 |
+==================================================================================================================+=========================================================================+
| :meth:`needs_grad <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.needs_grad>`       | Returns the True if the gradient update needs to retain past gradients. |
+------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+
| :meth:`trained_coef_ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.trained_coef_>` | Returns the trained coefficients a dictionary.                          |
+------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------+






Methods
+++++++

+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                                                                    | truncated documentation                                                                                       |
+===========================================================================================================================================+===============================================================================================================+
| :py:meth:`__getstate__ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.__getstate__>`                         | Removes any non pickable attribute.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.__init__>`                                 |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.__setstate__>`                         | Restores any non pickable attribute.                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_create_training_session <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._create_training_session>` |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_evaluation <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._evaluation>`                           |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_att_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._get_att_state>`                     |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_iteration <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._iteration>`                             |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.build_onnx_function>`              | Creates ONNX graph and *InferenceSession* related to any operations applying on *OrtValue*.                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`fit <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.fit>`                                              | Trains the model.                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_full_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.get_full_state>`                        | Returns the trained weights and the inputs.                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.get_state>`                                  | Returns the trained weights.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_trained_onnx <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.get_trained_onnx>`                    | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`losses <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.losses>`                                        | Returns the losses associated to every observation.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`score <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.score>`                                          | Return the whole score associated.                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`set_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.set_state>`                                  | Changes the trained weights.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+


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

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