.. _f-baseestimator:

module ``training._base_estimator``
===================================





.. inheritance-diagram:: onnxcustom.training._base_estimator


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

module ``onnxcustom.training._base_estimator``

Optimizer with :epkg:`onnxruntime-training`.


:githublink:`%|py|5`




Classes
+++++++

+----------------------------------------------------------------------------+-----------------------------------------------------------------------+
| class                                                                      | truncated documentation                                               |
+============================================================================+=======================================================================+
| :class:`BaseEstimator <onnxcustom.training._base_estimator.BaseEstimator>` | Base class for optimizers. Implements common methods such `__repr__`. |
+----------------------------------------------------------------------------+-----------------------------------------------------------------------+








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

+--------------------------------------------------------------------------------------------------+---------------------------------------+
| staticmethod                                                                                     | truncated documentation               |
+==================================================================================================+=======================================+
| :py:meth:`_get_param_names <onnxcustom.training._base_estimator.BaseEstimator._get_param_names>` | Extracts all parameters to serialize. |
+--------------------------------------------------------------------------------------------------+---------------------------------------+




Methods
+++++++

+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| method                                                                                             | truncated documentation                                                                                       |
+====================================================================================================+===============================================================================================================+
| :py:meth:`__getstate__ <onnxcustom.training._base_estimator.BaseEstimator.__getstate__>`           | Removes any non pickable attribute.                                                                           |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__init__ <onnxcustom.training._base_estimator.BaseEstimator.__init__>`                   |                                                                                                               |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__repr__ <onnxcustom.training._base_estimator.BaseEstimator.__repr__>`                   | Usual.                                                                                                        |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`__setstate__ <onnxcustom.training._base_estimator.BaseEstimator.__setstate__>`           | Restores any non pickable attribute.                                                                          |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :py:meth:`_get_trained_onnx <onnxcustom.training._base_estimator.BaseEstimator._get_trained_onnx>` | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_params <onnxcustom.training._base_estimator.BaseEstimator.get_params>`                  | Returns the list of parameters. Parameter *deep* is unused.                                                   |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`get_trained_onnx <onnxcustom.training._base_estimator.BaseEstimator.get_trained_onnx>`      | Returns the trained onnx graph, the initial graph modified by replacing the initializers with the trained ... |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+
| :meth:`set_params <onnxcustom.training._base_estimator.BaseEstimator.set_params>`                  | Returns the list of parameters. Parameter *deep* is unused.                                                   |
+----------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+


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

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