.. index:: pair: group; Pooling_v2 .. _doxid-group__dnnl__api__pooling__v2: Pooling_v2 ========== .. toctree:: :hidden: struct_dnnl_pooling_v2_desc_t.rst struct_dnnl_pooling_v2_backward.rst struct_dnnl_pooling_v2_forward.rst Overview ~~~~~~~~ A primitive to perform max or average pooling with dilation. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // structs struct :ref:`dnnl_pooling_v2_desc_t`; struct :ref:`dnnl::pooling_v2_backward`; struct :ref:`dnnl::pooling_v2_forward`; // global functions :ref:`dnnl_status_t` DNNL_API :ref:`dnnl_pooling_v2_forward_desc_init`( :ref:`dnnl_pooling_v2_desc_t`* pool_desc, :ref:`dnnl_prop_kind_t` prop_kind, :ref:`dnnl_alg_kind_t` alg_kind, const :ref:`dnnl_memory_desc_t`* src_desc, const :ref:`dnnl_memory_desc_t`* dst_desc, const :ref:`dnnl_dims_t` strides, const :ref:`dnnl_dims_t` kernel, const :ref:`dnnl_dims_t` dilation, const :ref:`dnnl_dims_t` padding_l, const :ref:`dnnl_dims_t` padding_r ); :ref:`dnnl_status_t` DNNL_API :ref:`dnnl_pooling_v2_backward_desc_init`( :ref:`dnnl_pooling_v2_desc_t`* pool_desc, :ref:`dnnl_alg_kind_t` alg_kind, const :ref:`dnnl_memory_desc_t`* diff_src_desc, const :ref:`dnnl_memory_desc_t`* diff_dst_desc, const :ref:`dnnl_dims_t` strides, const :ref:`dnnl_dims_t` kernel, const :ref:`dnnl_dims_t` dilation, const :ref:`dnnl_dims_t` padding_l, const :ref:`dnnl_dims_t` padding_r ); .. _details-group__dnnl__api__pooling__v2: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ A primitive to perform max or average pooling with dilation. .. rubric:: See also: :ref:`Pooling ` in developer guide Global Functions ---------------- .. index:: pair: function; dnnl_pooling_v2_forward_desc_init .. _doxid-group__dnnl__api__pooling__v2_1gadedbffa2fa02e7afdff750c9b622da86: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`dnnl_status_t` DNNL_API dnnl_pooling_v2_forward_desc_init( :ref:`dnnl_pooling_v2_desc_t`* pool_desc, :ref:`dnnl_prop_kind_t` prop_kind, :ref:`dnnl_alg_kind_t` alg_kind, const :ref:`dnnl_memory_desc_t`* src_desc, const :ref:`dnnl_memory_desc_t`* dst_desc, const :ref:`dnnl_dims_t` strides, const :ref:`dnnl_dims_t` kernel, const :ref:`dnnl_dims_t` dilation, const :ref:`dnnl_dims_t` padding_l, const :ref:`dnnl_dims_t` padding_r ) Initializes a descriptor for pooling v2 (pooling with dilation support) forward propagation primitive. Arrays ``strides``, ``kernel``, ``dilation``, ``padding_l`` and ``padding_r`` contain values for spatial dimensions only and hence must have the same number of elements as there are spatial dimensions. The order of values is the same as in the tensor: depth (for 3D tensors), height (for 3D and 2D tensors), and width. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pool_desc - Output descriptor for a pooling primitive. * - prop_kind - Propagation kind. Possible values are :ref:`dnnl_forward_training ` and :ref:`dnnl_forward_inference `. * - alg_kind - Pooling algorithm kind: either :ref:`dnnl_pooling_max `, :ref:`dnnl_pooling_avg_include_padding `, or :ref:`dnnl_pooling_avg ` (same as :ref:`dnnl_pooling_avg_exclude_padding `). * - src_desc - Source memory descriptor. * - dst_desc - Destination memory descriptor. * - strides - Array of strides for spatial dimension. * - kernel - Array of kernel spatial dimensions. * - dilation - Array of dilations for spatial dimension. * - padding_l - Array of padding values for low indices for each spatial dimension ``([[front,] top,] left)``. * - padding_r - Array of padding values for high indices for each spatial dimension ``([[back,] bottom,] right)``. Can be NULL in which case padding is considered to be symmetrical. .. rubric:: Returns: :ref:`dnnl_success ` on success and a status describing the error otherwise. .. index:: pair: function; dnnl_pooling_v2_backward_desc_init .. _doxid-group__dnnl__api__pooling__v2_1gacfb930c7d22ce1db2ffbca016a1c39aa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`dnnl_status_t` DNNL_API dnnl_pooling_v2_backward_desc_init( :ref:`dnnl_pooling_v2_desc_t`* pool_desc, :ref:`dnnl_alg_kind_t` alg_kind, const :ref:`dnnl_memory_desc_t`* diff_src_desc, const :ref:`dnnl_memory_desc_t`* diff_dst_desc, const :ref:`dnnl_dims_t` strides, const :ref:`dnnl_dims_t` kernel, const :ref:`dnnl_dims_t` dilation, const :ref:`dnnl_dims_t` padding_l, const :ref:`dnnl_dims_t` padding_r ) Initializes a descriptor for pooling v2 (pooling with dilation support) backward propagation primitive. Arrays ``strides``, ``kernel``, ``dilation``, ``padding_l`` and ``padding_r`` contain values for spatial dimensions only and hence must have the same number of elements as there are spatial dimensions. The order of values is the same as in the tensor: depth (for 3D tensors), height (for 3D and 2D tensors), and width. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pool_desc - Output descriptor for a pooling primitive. * - alg_kind - Pooling algorithm kind: either :ref:`dnnl_pooling_max `, :ref:`dnnl_pooling_avg_include_padding `, or :ref:`dnnl_pooling_avg ` (same as :ref:`dnnl_pooling_avg_exclude_padding `). * - diff_src_desc - Diff source memory descriptor. * - diff_dst_desc - Diff destination memory descriptor. * - strides - Array of strides for spatial dimension. * - kernel - Array of kernel spatial dimensions. * - dilation - Array of dilations for spatial dimension. * - padding_l - Array of padding values for low indices for each spatial dimension ``([[front,] top,] left)``. * - padding_r - Array of padding values for high indices for each spatial dimension ``([[back,] bottom,] right)``. Can be NULL in which case padding is considered to be symmetrical. .. rubric:: Returns: :ref:`dnnl_success ` on success and a status describing the error otherwise.