.. _f-opmomentum:

module ``onnxrt.ops_cpu.op_momentum``
=====================================





.. inheritance-diagram:: mlprodict.onnxrt.ops_cpu.op_momentum


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

module ``mlprodict.onnxrt.ops_cpu.op_momentum``

Runtime operator.


:githublink:`%|py|7`




Classes
+++++++

+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
| class                                                             | truncated documentation                                                                                                         |
+===================================================================+=================================================================================================================================+
| :class:`Momentum <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum>` | Momentum (ai.onnx.preview.training) =================================== Compute one iteration of stochastic gradient update ... |
+-------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+--------------------------------------------------------------------------------+-------------------------+
| function                                                                       | truncated documentation |
+================================================================================+=========================+
| :func:`_apply_momentum <mlprodict.onnxrt.ops_cpu.op_momentum._apply_momentum>` |                         |
+--------------------------------------------------------------------------------+-------------------------+




Properties
++++++++++

+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| property                                                                                            | truncated documentation                                                                                               |
+=====================================================================================================+=======================================================================================================================+
| :meth:`args_default <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum.args_default>`                   | Returns the list of arguments as well as the list of parameters with the default values (close to the signature). ... |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_default_modified <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum.args_default_modified>` | Returns the list of modified parameters.                                                                              |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_mandatory <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum.args_mandatory>`               | Returns the list of optional arguments.                                                                               |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_optional <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum.args_optional>`                 | Returns the list of optional arguments.                                                                               |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`atts_value <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum.atts_value>`                       | Returns all parameters in a dictionary.                                                                               |
+-----------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

+------------------------------------------------------------------------------+-------------------------+
| method                                                                       | truncated documentation |
+==============================================================================+=========================+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum.__init__>` |                         |
+------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum._run>`         |                         |
+------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run1 <mlprodict.onnxrt.ops_cpu.op_momentum.Momentum._run1>`       |                         |
+------------------------------------------------------------------------------+-------------------------+


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

.. automodule:: mlprodict.onnxrt.ops_cpu.op_momentum
    :members:
    :special-members: __init__
    :show-inheritance: