.. _f-opadam:

module ``onnxrt.ops_cpu.op_adam``
=================================





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


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

module ``mlprodict.onnxrt.ops_cpu.op_adam``

Runtime operator.


:githublink:`%|py|7`




Classes
+++++++

+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
| class                                                 | truncated documentation                                                                                                        |
+=======================================================+================================================================================================================================+
| :class:`Adam <mlprodict.onnxrt.ops_cpu.op_adam.Adam>` | Adam (ai.onnx.preview.training) =============================== Compute one iteration of Adam, a stochastic gradient based ... |
+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

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




Properties
++++++++++

+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| property                                                                                    | truncated documentation                                                                                               |
+=============================================================================================+=======================================================================================================================+
| :meth:`args_default <mlprodict.onnxrt.ops_cpu.op_adam.Adam.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_adam.Adam.args_default_modified>` | Returns the list of modified parameters.                                                                              |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_mandatory <mlprodict.onnxrt.ops_cpu.op_adam.Adam.args_mandatory>`               | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`args_optional <mlprodict.onnxrt.ops_cpu.op_adam.Adam.args_optional>`                 | Returns the list of optional arguments.                                                                               |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| :meth:`atts_value <mlprodict.onnxrt.ops_cpu.op_adam.Adam.atts_value>`                       | Returns all parameters in a dictionary.                                                                               |
+---------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------+






Methods
+++++++

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


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

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