.. _f-oploop:

module ``onnxrt.ops_cpu.op_loop``
=================================





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


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

module ``mlprodict.onnxrt.ops_cpu.op_loop``

Runtime operator.





Classes
+++++++

+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| class                                                 | truncated documentation                                                                                                          |
+=======================================================+==================================================================================================================================+
| :class:`Loop <mlprodict.onnxrt.ops_cpu.op_loop.Loop>` | Loop ==== Generic Looping construct. This loop has multiple termination conditions: 1) Trip count. Iteration count specified ... |
+-------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+






Properties
++++++++++

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






Methods
+++++++

+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| method                                                                    | truncated documentation                                                                                      |
+===========================================================================+==============================================================================================================+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_loop.Loop.__init__>`      |                                                                                                              |
+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_loop.Loop._run>`              |                                                                                                              |
+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :meth:`need_context <mlprodict.onnxrt.ops_cpu.op_loop.Loop.need_context>` | The operator Loop needs to know all results produced so far as the loop may silently access one of them. ... |
+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+


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

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