AvgPool {#dev_guide_op_avgpool}
===============================

## General

AvgPool operation performs the computation following the below formulas.
Variable names follow the standard @ref dev_guide_conventions.

\f[
    \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)
\f]

where,

- when attribute `exclude_pad` is set to false, in which case
  \f$DENOM = KH \cdot KW\f$,

- when attribute `exclude_pad` is set to true, in which case \f$DENOM\f$ equals
  to the size of overlap between an averaging window and images.

## Operation attributes

| Attribute Name                                             | Description                                                                                                                                                                                       | Value Type | Supported Values                                      | Required or Optional |
|:-----------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------|:------------------------------------------------------|:---------------------|
| [strides](@ref dnnl::graph::op::attr::strides)             | Controls the strides the window is moved.                                                                                                                                                         | s64        | A s64 list containing positive values.                | Required             |
| [pads_begin](@ref dnnl::graph::op::attr::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             |
| [pads_end](@ref dnnl::graph::op::attr::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             |
| [kernel](@ref dnnl::graph::op::attr::kernel)               | Size of pooling window.                                                                                                                                                                           | s64        | A s64 list containing positive values.                | Required             |
| [exclude_pad](@ref dnnl::graph::op::attr::exclude_pad)     | Controls whether the padded values are counted.                                                                                                                                                   | bool       | True, False                                           | Required             |
| [rounding_type](@ref dnnl::graph::op::attr::rounding_type) | Controls how to do rounding.                                                                                                                                                                      | string     | `floor` (default), `ceil`                             | Optional             |
| [auto_pad](@ref dnnl::graph::op::attr::auto_pad)           | Controls how the paddings are calculated.                                                                                                                                                         | string     | `none` (default), `same_upper`, `same_lower`, `valid` | Optional             |
| [data_format](@ref dnnl::graph::op::attr::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  |