.. index:: pair: page; AvgPool .. _doxid-dev_guide_op_avgpool: AvgPool ======= General ~~~~~~~ AvgPool operation performs the computation following the below formulas. Variable names follow the standard :ref:`Naming Conventions `. .. math:: \dst(n, c, oh, ow) = \frac{1}{DENOM} \sum\limits_{kh, kw} \src(n, c, oh \cdot SH + kh \cdot (DH + 1) - PH_L, ow \cdot SW + kw \cdot (DW + 1) - PW_L) where, * when attribute ``exclude_pad`` is set to false, in which case :math:`DENOM = KH \cdot KW`, * when attribute ``exclude_pad`` is set to true, in which case :math:`DENOM` equals to the size of overlap between an averaging window and images. Operation attributes ~~~~~~~~~~~~~~~~~~~~ ========================================================================================================================== ============================================================================================================================================================================================================ =========== ================================================================ ===================== Attribute Name Description Value Type Supported Values Required or Optional ========================================================================================================================== ============================================================================================================================================================================================================ =========== ================================================================ ===================== :ref:`strides ` Controls the strides the window is moved. s64 A s64 list containing positive values. Required :ref:`pads_begin ` Controls number of zeros to be add to the front/top/left of spatial dimensions, the attribute will be ignored when ``auto_pad`` attribute is specified to ``same_upper`` , ``same_lower`` or ``valid`` . s64 A s64 list containing non-negative values. Required :ref:`pads_end ` Controls number of zeros to be add to the back/bottom/right of spatial dimensions, the attribute will be ignored when ``auto_pad`` attribute is specified to ``same_upper`` , ``same_lower`` or ``valid`` . s64 A s64 list containing non-negative values. Required :ref:`kernel ` Size of pooling window. s64 A s64 list containing positive values. Required :ref:`exclude_pad ` Controls whether the padded values are counted. bool True, False Required :ref:`rounding_type ` Controls how to do rounding. string ``floor`` (default), ``ceil`` Optional :ref:`auto_pad ` Controls how the paddings are calculated. string ``none`` (default), ``same_upper`` , ``same_lower`` , ``valid`` Optional :ref:`data_format ` Controls how to interpret the shape of ``src`` and ``dst`` . string ``NCX`` , ``NXC`` (default) Optional ========================================================================================================================== ============================================================================================================================================================================================================ =========== ================================================================ ===================== Execution arguments ~~~~~~~~~~~~~~~~~~~ The inputs and outputs must be provided according to below index order when constructing an operation. Inputs ------ ====== ============== ===================== Index Argument Name Required or Optional ====== ============== ===================== 0 ``src`` Required ====== ============== ===================== Outputs ------- ====== ============== ===================== Index Argument Name Required or Optional ====== ============== ===================== 0 ``dst`` Required ====== ============== ===================== Supported data types ~~~~~~~~~~~~~~~~~~~~ AvgPool operation supports the following data type combinations. ===== ===== Src Dst ===== ===== f32 f32 bf16 bf16 f16 f16 ===== =====