.. _f-optimizers:

module ``training.optimizers``
==============================





.. inheritance-diagram:: onnxcustom.training.optimizers


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

module ``onnxcustom.training.optimizers``

Optimizer with :epkg:`onnxruntime-training`.


:githublink:`%|py|5`




Classes
+++++++

+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+
| class                                                                               | truncated documentation                                                                    |
+=====================================================================================+============================================================================================+
| :class:`OrtGradientOptimizer <onnxcustom.training.optimizers.OrtGradientOptimizer>` | Implements a simple :epkg:`Stochastic Gradient Descent` with :epkg:`onnxruntime-training`. |
+-------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+










Methods
+++++++

+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                                             | truncated documentation                                                                                       |
+====================================================================================================================+===============================================================================================================+
| :py:meth:`__init__ <onnxcustom.training.optimizers.OrtGradientOptimizer.__init__>`                                 |                                                                                                               |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_bind_input_ortvalue <onnxcustom.training.optimizers.OrtGradientOptimizer._bind_input_ortvalue>`         | Binds :epkg:`C_OrtValue` to the structure used by :epkg:`InferenceSession` to run inference.                  |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_create_training_session <onnxcustom.training.optimizers.OrtGradientOptimizer._create_training_session>` | Creates an instance of :epkg:`TrainingSession`.                                                               |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_evaluation <onnxcustom.training.optimizers.OrtGradientOptimizer._evaluation>`                           |                                                                                                               |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_iteration <onnxcustom.training.optimizers.OrtGradientOptimizer._iteration>`                             |                                                                                                               |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`fit <onnxcustom.training.optimizers.OrtGradientOptimizer.fit>`                                              | Trains the model.                                                                                             |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_state <onnxcustom.training.optimizers.OrtGradientOptimizer.get_state>`                                  | Returns the trained weights.                                                                                  |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_trained_onnx <onnxcustom.training.optimizers.OrtGradientOptimizer.get_trained_onnx>`                    | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`set_state <onnxcustom.training.optimizers.OrtGradientOptimizer.set_state>`                                  | Changes the trained weights.                                                                                  |
+--------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+


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

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