.. _l-methods:

Methods
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                                                                    | class parent                        | truncated documentation                                                                                       |
+===========================================================================================================================================+=====================================+===============================================================================================================+
| :py:meth:`__getstate__ <onnxcustom.training._base_estimator.BaseEstimator.__getstate__>`                                                  | BaseEstimator                       | Removes any non pickable attribute.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getstate__ <onnxcustom.training._base_onnx_function.BaseLearningOnnx.__getstate__>`                                           | BaseLearningOnnx                    | Overwrites getstate to get rid of InferenceSession.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getstate__ <onnxcustom.training.data_loader.OrtDataLoader.__getstate__>`                                                      | OrtDataLoader                       | Removes any non pickable attribute.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getstate__ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.__getstate__>`                         | OrtGradientForwardBackwardOptimizer | Removes any non pickable attribute.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__getstate__ <onnxcustom.training.ortgradient.OrtGradientForwardBackward.__getstate__>`                                         | OrtGradientForwardBackward          | Removes any non pickable attribute.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training._base_estimator.BaseEstimator.__init__>`                                                          | BaseEstimator                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training._base_onnx_function.BaseLearningOnnx.__init__>`                                                   | BaseLearningOnnx                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.data_loader.OrtDataLoader.__init__>`                                                              | OrtDataLoader                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.optimizers.OrtGradientOptimizer.__init__>`                                                        | OrtGradientOptimizer                |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.__init__>`                                 | OrtGradientForwardBackwardOptimizer |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.ortgradient.OrtGradientForwardBackward.__init__>`                                                 | OrtGradientForwardBackward          |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.ortgradient.OrtGradientForwardBackwardFunction.__init__>`                                         | OrtGradientForwardBackwardFunction  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_loss.AbsoluteLearningLoss.__init__>`                                                 | AbsoluteLearningLoss                |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_loss.BaseLearningLoss.__init__>`                                                     | BaseLearningLoss                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_loss.ElasticLearningLoss.__init__>`                                                  | ElasticLearningLoss                 |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_loss.NegLogLearningLoss.__init__>`                                                   | NegLogLearningLoss                  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_loss.SquareLearningLoss.__init__>`                                                   | SquareLearningLoss                  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.__init__>`                                               | BaseLearningPenalty                 |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.__init__>`                                            | ElasticLearningPenalty              |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.__init__>`                                                 | NoLearningPenalty                   |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_rate.BaseLearningRate.__init__>`                                                     | BaseLearningRate                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_rate.LearningRateSGD.__init__>`                                                      | LearningRateSGD                     |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.__init__>`                                              | LearningRateSGDNesterov             |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.utils.onnx_split.OnnxSegment.__init__>`                                                                    | OnnxSegment                         |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.utils.onnx_split.OnnxSplitting.__init__>`                                                                  | OnnxSplitting                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__len__ <onnxcustom.training.data_loader.OrtDataLoader.__len__>`                                                                | OrtDataLoader                       | Returns the number of observations.                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.training._base_estimator.BaseEstimator.__repr__>`                                                          | BaseEstimator                       | Usual.                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.training._base_onnx_function.BaseLearningOnnx.__repr__>`                                                   | BaseLearningOnnx                    | Usual                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.training.data_loader.OrtDataLoader.__repr__>`                                                              | OrtDataLoader                       | usual                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.training.ortgradient.OrtGradientForwardBackward.__repr__>`                                                 | OrtGradientForwardBackward          | usual                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.utils.onnx_split.OnnxSegment.__repr__>`                                                                    | OnnxSegment                         |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training._base_onnx_function.BaseLearningOnnx.__repr_extended__>`                                 | BaseLearningOnnx                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training.sgd_learning_rate.BaseLearningRate.__repr_extended__>`                                   | BaseLearningRate                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training.sgd_learning_rate.LearningRateSGD.__repr_extended__>`                                    | LearningRateSGD                     |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr_extended__ <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.__repr_extended__>`                            | LearningRateSGDNesterov             |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training._base_estimator.BaseEstimator.__setstate__>`                                                  | BaseEstimator                       | Restores any non pickable attribute.                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training._base_onnx_function.BaseLearningOnnx.__setstate__>`                                           | BaseLearningOnnx                    | Overwrites getstate to get rid of InferenceSession.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training.data_loader.OrtDataLoader.__setstate__>`                                                      | OrtDataLoader                       | Restores any non pickable attribute.                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.__setstate__>`                         | OrtGradientForwardBackwardOptimizer | Restores any non pickable attribute.                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training.ortgradient.OrtGradientForwardBackward.__setstate__>`                                         | OrtGradientForwardBackward          | Restores any non pickable attribute.                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_bind_input_ortvalue <onnxcustom.training._base_onnx_function.BaseLearningOnnx._bind_input_ortvalue>`                           | BaseLearningOnnx                    | Binds :epkg:`C_OrtValue` to the structure used by :epkg:`InferenceSession` to run inference.                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_bind_input_ortvalue <onnxcustom.training.optimizers.OrtGradientOptimizer._bind_input_ortvalue>`                                | OrtGradientOptimizer                | Binds :epkg:`C_OrtValue` to the structure used by :epkg:`InferenceSession` to run inference.                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_bind_output_ortvalue <onnxcustom.training._base_onnx_function.BaseLearningOnnx._bind_output_ortvalue>`                         | BaseLearningOnnx                    | Binds :epkg:`C_OrtValue` to the structure used by :epkg:`InferenceSession` to run inference.                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_loss.AbsoluteLearningLoss._call_iobinding>`                                   | AbsoluteLearningLoss                |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_loss.BaseLearningLoss._call_iobinding>`                                       | BaseLearningLoss                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_loss.ElasticLearningLoss._call_iobinding>`                                    | ElasticLearningLoss                 |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_loss.NegLogLearningLoss._call_iobinding>`                                     | NegLogLearningLoss                  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_loss.SquareLearningLoss._call_iobinding>`                                     | SquareLearningLoss                  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty._call_iobinding>`                                 | BaseLearningPenalty                 |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty._call_iobinding>`                              | ElasticLearningPenalty              |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty._call_iobinding>`                                   | NoLearningPenalty                   |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_rate.BaseLearningRate._call_iobinding>`                                       | BaseLearningRate                    |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_rate.LearningRateSGD._call_iobinding>`                                        | LearningRateSGD                     |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_call_iobinding <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov._call_iobinding>`                                | LearningRateSGDNesterov             |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_create_onnx_graphs <onnxcustom.training.ortgradient.OrtGradientForwardBackward._create_onnx_graphs>`                           | OrtGradientForwardBackward          | Creates forward and backward ONNX graph. The new class has the following attributes:                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_create_training_session <onnxcustom.training.optimizers.OrtGradientOptimizer._create_training_session>`                        | OrtGradientOptimizer                | Creates an instance of :epkg:`TrainingSession`.                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_create_training_session <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._create_training_session>` | OrtGradientForwardBackwardOptimizer |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_evaluation <onnxcustom.training.optimizers.OrtGradientOptimizer._evaluation>`                                                  | OrtGradientOptimizer                |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_evaluation <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._evaluation>`                           | OrtGradientForwardBackwardOptimizer |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_att_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._get_att_state>`                     | OrtGradientForwardBackwardOptimizer |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_cutting_points <onnxcustom.utils.onnx_split.OnnxSplitting._get_cutting_points>`                                            | OnnxSplitting                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_trained_onnx <onnxcustom.training._base_estimator.BaseEstimator._get_trained_onnx>`                                        | BaseEstimator                       | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_init <onnxcustom.utils.onnx_split.OnnxSplitting._init>`                                                                        | OnnxSplitting                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_init_next <onnxcustom.training.ortgradient.OrtGradientForwardBackward._init_next>`                                             | OrtGradientForwardBackward          |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_iteration <onnxcustom.training.optimizers.OrtGradientOptimizer._iteration>`                                                    | OrtGradientOptimizer                |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_iteration <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer._iteration>`                             | OrtGradientForwardBackwardOptimizer |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_make_onnx <onnxcustom.utils.onnx_split.OnnxSplitting._make_onnx>`                                                              | OnnxSplitting                       | Builds one onnx subpart including segments from a to b (excluded).                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_make_segment <onnxcustom.utils.onnx_split.OnnxSplitting._make_segment>`                                                        | OnnxSplitting                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_next_iter <onnxcustom.training.data_loader.OrtDataLoader._next_iter>`                                                          | OrtDataLoader                       |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_split_2 <onnxcustom.utils.onnx_split.OnnxSplitting._split_2>`                                                                  | OnnxSplitting                       | Splits the segments into two groups of the same size.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`backward <onnxcustom.training.ortgradient.OrtGradientForwardBackwardFunction.backward>`                                            | OrtGradientForwardBackwardFunction  | Implements backward function. The function returns an :epkg:`OrtValueVector`.                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training._base_onnx_function.BaseLearningOnnx.build_onnx_function>`                                | BaseLearningOnnx                    | This class computes a function represented as an ONNX graph. This method builds it. This function creates ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.build_onnx_function>`              | OrtGradientForwardBackwardOptimizer | Creates ONNX graph and *InferenceSession* related to any operations applying on *OrtValue*.                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_loss.AbsoluteLearningLoss.build_onnx_function>`                              | AbsoluteLearningLoss                |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_loss.ElasticLearningLoss.build_onnx_function>`                               | ElasticLearningLoss                 |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_loss.NegLogLearningLoss.build_onnx_function>`                                | NegLogLearningLoss                  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_loss.SquareLearningLoss.build_onnx_function>`                                | SquareLearningLoss                  |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.build_onnx_function>`                         | ElasticLearningPenalty              |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.build_onnx_function>`                              | NoLearningPenalty                   |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_rate.LearningRateSGD.build_onnx_function>`                                   | LearningRateSGD                     |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_function <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.build_onnx_function>`                           | LearningRateSGDNesterov             |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_score_function <onnxcustom.training.sgd_learning_loss.AbsoluteLearningLoss.build_onnx_score_function>`                  | AbsoluteLearningLoss                | Assuming the loss function was created. This one takes the onnx graph and generate the onnx graph for the ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_score_function <onnxcustom.training.sgd_learning_loss.BaseLearningLoss.build_onnx_score_function>`                      | BaseLearningLoss                    | Assuming the loss function was created. This one takes the onnx graph and generate the onnx graph for the ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_score_function <onnxcustom.training.sgd_learning_loss.ElasticLearningLoss.build_onnx_score_function>`                   | ElasticLearningLoss                 | Assuming the loss function was created. This one takes the onnx graph and generate the onnx graph for the ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_score_function <onnxcustom.training.sgd_learning_loss.NegLogLearningLoss.build_onnx_score_function>`                    | NegLogLearningLoss                  | Assuming the loss function was created. This one takes the onnx graph and generate the onnx graph for the ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`build_onnx_score_function <onnxcustom.training.sgd_learning_loss.SquareLearningLoss.build_onnx_score_function>`                    | SquareLearningLoss                  | Assuming the loss function was created. This one takes the onnx graph and generate the onnx graph for the ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`clear_binding_inputs <onnxcustom.training._base_onnx_function.BaseLearningOnnx.clear_binding_inputs>`                              | BaseLearningOnnx                    | Clears binding and empty cache.                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`fit <onnxcustom.training.optimizers.OrtGradientOptimizer.fit>`                                                                     | OrtGradientOptimizer                | Trains the model.                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`fit <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.fit>`                                              | OrtGradientForwardBackwardOptimizer | Trains the model.                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`forward <onnxcustom.training.ortgradient.OrtGradientForwardBackwardFunction.forward>`                                              | OrtGradientForwardBackwardFunction  | Implements forward function.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_full_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.get_full_state>`                        | OrtGradientForwardBackwardOptimizer | Returns the trained weights and the inputs.                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_initializer <onnxcustom.training.ortgradient.OrtGradientForwardBackward.get_initializer>`                                      | OrtGradientForwardBackward          | Returns an initializer as numpy arrays.                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_params <onnxcustom.training._base_estimator.BaseEstimator.get_params>`                                                         | BaseEstimator                       | Returns the list of parameters. Parameter *deep* is unused.                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_state <onnxcustom.training.optimizers.OrtGradientOptimizer.get_state>`                                                         | OrtGradientOptimizer                | Returns the trained weights.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.get_state>`                                  | OrtGradientForwardBackwardOptimizer | Returns the trained weights.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_trained_onnx <onnxcustom.training._base_estimator.BaseEstimator.get_trained_onnx>`                                             | BaseEstimator                       | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_trained_onnx <onnxcustom.training.optimizers.OrtGradientOptimizer.get_trained_onnx>`                                           | OrtGradientOptimizer                | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_trained_onnx <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.get_trained_onnx>`                    | OrtGradientForwardBackwardOptimizer | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`init_learning_rate <onnxcustom.training.sgd_learning_rate.BaseLearningRate.init_learning_rate>`                                    | BaseLearningRate                    | Initializes the learning rate at the beginning of the training.                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`init_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGD.init_learning_rate>`                                     | LearningRateSGD                     | Updates the learning rate at the end of an iteration.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`init_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.init_learning_rate>`                             | LearningRateSGDNesterov             | Updates the learning rate at the end of an iteration.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`iter_bind <onnxcustom.training.data_loader.OrtDataLoader.iter_bind>`                                                               | OrtDataLoader                       | Iterates over the datasets by drawing *batch_size* consecutive observations. Modifies a bind structure.       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`iter_numpy <onnxcustom.training.data_loader.OrtDataLoader.iter_numpy>`                                                             | OrtDataLoader                       | Iterates over the datasets by drawing *batch_size* consecutive observations. This iterator is slow as it ...  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`iter_ortvalue <onnxcustom.training.data_loader.OrtDataLoader.iter_ortvalue>`                                                       | OrtDataLoader                       | Iterates over the datasets by drawing *batch_size* consecutive observations. This iterator is slow as it ...  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loop <onnxcustom.training.sgd_learning_rate.BaseLearningRate.loop>`                                                                | BaseLearningRate                    | Loops over learning rate values, *n* to be precise.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loop <onnxcustom.training.sgd_learning_rate.LearningRateSGD.loop>`                                                                 | LearningRateSGD                     | Loops over learning rate values, *n* to be precise.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loop <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.loop>`                                                         | LearningRateSGDNesterov             | Loops over learning rate values, *n* to be precise.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_gradient <onnxcustom.training.sgd_learning_loss.AbsoluteLearningLoss.loss_gradient>`                                          | AbsoluteLearningLoss                | Returns the loss and the gradient as OrtValue.                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_gradient <onnxcustom.training.sgd_learning_loss.BaseLearningLoss.loss_gradient>`                                              | BaseLearningLoss                    | Returns the loss and the gradient as OrtValue.                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_gradient <onnxcustom.training.sgd_learning_loss.ElasticLearningLoss.loss_gradient>`                                           | ElasticLearningLoss                 | Returns the loss and the gradient as OrtValue.                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_gradient <onnxcustom.training.sgd_learning_loss.NegLogLearningLoss.loss_gradient>`                                            | NegLogLearningLoss                  | Returns the loss and the gradient as OrtValue.                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_gradient <onnxcustom.training.sgd_learning_loss.SquareLearningLoss.loss_gradient>`                                            | SquareLearningLoss                  | Returns the loss and the gradient as OrtValue.                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_scores <onnxcustom.training.sgd_learning_loss.AbsoluteLearningLoss.loss_scores>`                                              | AbsoluteLearningLoss                | Returns the weighted loss (or score) for every observation as OrtValue.                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_scores <onnxcustom.training.sgd_learning_loss.BaseLearningLoss.loss_scores>`                                                  | BaseLearningLoss                    | Returns the weighted loss (or score) for every observation as OrtValue.                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_scores <onnxcustom.training.sgd_learning_loss.ElasticLearningLoss.loss_scores>`                                               | ElasticLearningLoss                 | Returns the weighted loss (or score) for every observation as OrtValue.                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_scores <onnxcustom.training.sgd_learning_loss.NegLogLearningLoss.loss_scores>`                                                | NegLogLearningLoss                  | Returns the weighted loss (or score) for every observation as OrtValue.                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`loss_scores <onnxcustom.training.sgd_learning_loss.SquareLearningLoss.loss_scores>`                                                | SquareLearningLoss                  | Returns the weighted loss (or score) for every observation as OrtValue.                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`losses <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.losses>`                                        | OrtGradientForwardBackwardOptimizer | Returns the losses associated to every observation.                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`make_onnx <onnxcustom.utils.onnx_split.OnnxSplitting.make_onnx>`                                                                   | OnnxSplitting                       | Builds onnx subparts based on the segmentation defined by extremities.                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`new_instance <onnxcustom.training.ortgradient.OrtGradientForwardBackward.new_instance>`                                            | OrtGradientForwardBackward          | Creates an instance of class `self.cls_type_`. It implements methods *forward* and *backward*.                |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`penalty_loss <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.penalty_loss>`                                          | BaseLearningPenalty                 | Returns the received loss. Updates the loss inplace.                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`penalty_loss <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.penalty_loss>`                                       | ElasticLearningPenalty              | 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>`                                            | NoLearningPenalty                   | Returns the received loss. Updates the loss inplace.                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`save_for_backward <onnxcustom.training.ortgradient.OrtGradientForwardBackwardFunction.save_for_backward>`                          | OrtGradientForwardBackwardFunction  | Saves inputs furing forward steps. The list inputs is copied (simple copy, no deep copy).                     |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`save_onnx_graph <onnxcustom.training._base.BaseOnnxClass.save_onnx_graph>`                                                         | BaseOnnxClass                       | Saves all ONNX files stored in this class.                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`score <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.score>`                                          | OrtGradientForwardBackwardOptimizer | Return the whole score associated.                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`set_params <onnxcustom.training._base_estimator.BaseEstimator.set_params>`                                                         | BaseEstimator                       | Returns the list of parameters. Parameter *deep* is unused.                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`set_state <onnxcustom.training.optimizers.OrtGradientOptimizer.set_state>`                                                         | OrtGradientOptimizer                | Changes the trained weights.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`set_state <onnxcustom.training.optimizers_partial.OrtGradientForwardBackwardOptimizer.set_state>`                                  | OrtGradientForwardBackwardOptimizer | Changes the trained weights.                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`split_segment <onnxcustom.utils.onnx_split.OnnxSplitting.split_segment>`                                                           | OnnxSplitting                       | Splits the segments into `n_parts` segments                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_learning_rate <onnxcustom.training.sgd_learning_rate.BaseLearningRate.update_learning_rate>`                                | BaseLearningRate                    | Updates the learning rate at the end of an iteration.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGD.update_learning_rate>`                                 | LearningRateSGD                     | Updates the learning rate at the end of an iteration.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_learning_rate <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.update_learning_rate>`                         | LearningRateSGDNesterov             | Updates the learning rate at the end of an iteration.                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_penalty.BaseLearningPenalty.update_weights>`                                      | BaseLearningPenalty                 | Returns the received loss. Updates the weight inplace.                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_penalty.ElasticLearningPenalty.update_weights>`                                   | ElasticLearningPenalty              |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_penalty.NoLearningPenalty.update_weights>`                                        | NoLearningPenalty                   | Returns the received loss. Updates the weight inplace.                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_rate.BaseLearningRate.update_weights>`                                            | BaseLearningRate                    | Updates weights based on the algorithm this class is setting up.                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_rate.LearningRateSGD.update_weights>`                                             | LearningRateSGD                     |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`update_weights <onnxcustom.training.sgd_learning_rate.LearningRateSGDNesterov.update_weights>`                                     | LearningRateSGDNesterov             |                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------+---------------------------------------------------------------------------------------------------------------+