.. _f-opglobalaveragepool:

module ``onnxrt.ops_cpu.op_global_average_pool``
================================================





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


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

module ``mlprodict.onnxrt.ops_cpu.op_global_average_pool``

Runtime operator.


:githublink:`%|py|7`




Classes
+++++++

+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| class                                                                                          | truncated documentation                                                                                                     |
+================================================================================================+=============================================================================================================================+
| :class:`GlobalAveragePool <mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalAveragePool>` | GlobalAveragePool ================= GlobalAveragePool consumes an input tensor X and applies average pooling across the ... |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| :class:`GlobalMaxPool <mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalMaxPool>`         | GlobalMaxPool ============= GlobalMaxPool consumes an input tensor X and applies max pooling across the values in the ...   |
+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+




Functions
+++++++++

+-----------------------------------------------------------------------------------------------------+-------------------------+
| function                                                                                            | truncated documentation |
+=====================================================================================================+=========================+
| :func:`_global_average_pool <mlprodict.onnxrt.ops_cpu.op_global_average_pool._global_average_pool>` |                         |
+-----------------------------------------------------------------------------------------------------+-------------------------+
| :func:`_global_max_pool <mlprodict.onnxrt.ops_cpu.op_global_average_pool._global_max_pool>`         |                         |
+-----------------------------------------------------------------------------------------------------+-------------------------+




Properties
++++++++++

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






Methods
+++++++

+--------------------------------------------------------------------------------------------------+-------------------------+
| method                                                                                           | truncated documentation |
+==================================================================================================+=========================+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalAveragePool.__init__>` |                         |
+--------------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`__init__ <mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalMaxPool.__init__>`     |                         |
+--------------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalAveragePool._run>`         |                         |
+--------------------------------------------------------------------------------------------------+-------------------------+
| :py:meth:`_run <mlprodict.onnxrt.ops_cpu.op_global_average_pool.GlobalMaxPool._run>`             |                         |
+--------------------------------------------------------------------------------------------------+-------------------------+


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

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