struct dnnl::pooling_forward::primitive

Intel® oneAPI Deep Neural Network Developer Guide and Reference

Download PDF

ID 768875

Date 6/20/2024

Version

Public

A newer version of this document is available. Customers should click here to go to the newest version.

Visible to Intel only — GUID: GUID-D1EDAA8F-C2E9-45BE-B025-AA4235A7056E

View Details

struct dnnl::pooling_forward::primitive_desc

Overview

Primitive descriptor for a pooling forward propagation primitive. More…


#include <dnnl.hpp>

struct primitive_desc: public dnnl::primitive_desc
{
    // construction

    primitive_desc();

    primitive_desc(
        const engine& aengine,
        prop_kind aprop_kind,
        algorithm aalgorithm,
        const memory::desc& src_desc,
        const memory::desc& dst_desc,
        const memory::dims& strides,
        const memory::dims& kernel,
        const memory::dims& dilation,
        const memory::dims& padding_l,
        const memory::dims& padding_r,
        const primitive_attr& attr = default_attr(),
        bool allow_empty = false
        );

    primitive_desc(dnnl_primitive_desc_t pd);

    // methods

    memory::desc src_desc() const;
    memory::desc dst_desc() const;
    memory::desc workspace_desc() const;
    algorithm get_algorithm() const;
    prop_kind get_prop_kind() const;
    memory::dims get_strides() const;
    memory::dims get_kernel() const;
    memory::dims get_dilations() const;
    memory::dims get_padding_l() const;
    memory::dims get_padding_r() const;
};

Inherited Members


public:
    // methods

    handle<T, traits>& operator = (const handle<T, traits>&);
    handle<T, traits>& operator = (handle<T, traits>&&);
    void reset(T t, bool weak = false);
    T get(bool allow_empty = false) const;
    operator T () const;
    operator bool () const;
    bool operator == (const handle<T, traits>& other) const;
    bool operator != (const handle& other) const;
    engine get_engine() const;
    const char* impl_info_str() const;
    memory::dim query_s64(query what) const;
    memory::dims get_strides() const;
    memory::dims get_dilations() const;
    memory::dims get_padding_l() const;
    memory::dims get_padding_r() const;
    float get_epsilon() const;

    template <typename T = unsigned>
    T get_flags() const;

    dnnl::algorithm get_algorithm() const;
    float get_alpha() const;
    float get_beta() const;
    int get_axis() const;
    memory::dim get_local_size() const;
    float get_k() const;
    float get_p() const;
    std::vector<float> get_factors() const;
    dnnl::algorithm get_cell_kind() const;
    dnnl::rnn_direction get_direction() const;
    dnnl::algorithm get_activation_kind() const;
    memory::dims get_kernel() const;
    memory::dim get_group_size() const;
    dnnl::prop_kind get_prop_kind() const;
    memory::desc query_md(query what, int idx = 0) const;
    memory::desc src_desc(int idx) const;
    memory::desc dst_desc(int idx) const;
    memory::desc weights_desc(int idx) const;
    memory::desc diff_src_desc(int idx) const;
    memory::desc diff_dst_desc(int idx) const;
    memory::desc diff_weights_desc(int idx) const;
    memory::desc src_desc() const;
    memory::desc dst_desc() const;
    memory::desc weights_desc() const;
    memory::desc diff_src_desc() const;
    memory::desc diff_dst_desc() const;
    memory::desc diff_weights_desc() const;
    memory::desc workspace_desc() const;
    memory::desc scratchpad_desc() const;
    engine scratchpad_engine() const;
    primitive_attr get_primitive_attr() const;
    dnnl::primitive::kind get_kind() const;
    std::vector<uint8_t> get_cache_blob_id() const;
    bool next_impl();
    primitive_desc_base();
    primitive_desc_base();
    primitive_desc_base();
    primitive_desc_base();

Detailed Documentation

Primitive descriptor for a pooling forward propagation primitive.

Construction


primitive_desc()

Default constructor. Produces an empty object.


primitive_desc(
    const engine& aengine,
    prop_kind aprop_kind,
    algorithm aalgorithm,
    const memory::desc& src_desc,
    const memory::desc& dst_desc,
    const memory::dims& strides,
    const memory::dims& kernel,
    const memory::dims& dilation,
    const memory::dims& padding_l,
    const memory::dims& padding_r,
    const primitive_attr& attr = default_attr(),
    bool allow_empty = false
    )

Constructs a primitive descriptor for pooling 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.

Parameters:

aengine	Engine to use.
aprop_kind	Propagation kind. Possible values are dnnl::prop_kind::forward_training, and dnnl::prop_kind::forward_inference.
aalgorithm	Pooling algorithm kind: either dnnl::algorithm::pooling_max, dnnl::algorithm::pooling_avg_include_padding, or dnnl::algorithm::pooling_avg_exclude_padding.
src_desc	Source memory descriptor.
dst_desc	Destination memory descriptor.
strides	Vector of strides for spatial dimension.
kernel	Vector of kernel spatial dimensions.
dilation	Array of dilations for spatial dimension.
padding_l	Vector of padding values for low indices for each spatial dimension `([[front,] top,] left)`.
padding_r	Vector of padding values for high indices for each spatial dimension `([[back,] bottom,] right)`.
attr	Primitive attributes to use. Attributes are optional and default to empty attributes.
allow_empty	A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false.


primitive_desc(dnnl_primitive_desc_t pd)

Constructs a primitive descriptor for a pooling forward propagation primitive from a C API primitive descriptor that must have a matching kind.

Parameters:

pd	C API primitive descriptor for a pooling forward propagation primitive.

Methods


memory::desc src_desc() const

Returns a source memory descriptor.

Returns:

Source memory descriptor.

A zero memory descriptor if the primitive does not have a source parameter.


memory::desc dst_desc() const

Returns a destination memory descriptor.

Returns:

Destination memory descriptor.

A zero memory descriptor if the primitive does not have a destination parameter.


memory::desc workspace_desc() const

Returns the workspace memory descriptor.

Returns:

Workspace memory descriptor.

A zero memory descriptor if the primitive does not require workspace parameter.


algorithm get_algorithm() const

Returns an algorithm kind.

Returns:

An algorithm kind.

dnnl::algorithm::undef if the primitive does not have an algorithm parameter.


prop_kind get_prop_kind() const

Returns a propagation kind.

Returns:

A propagation kind.

dnnl::prop_kind::undef if the primitive does not have a propagation parameter.


memory::dims get_strides() const

Returns strides.

Returns:

Strides.

An empty dnnl::memory::dims if the primitive does not have a strides parameter.


memory::dims get_kernel() const

Returns a pooling kernel parameter.

Returns:

A pooling kernel parameter.

An empty dnnl::memory::dims if the primitive does not have a pooling kernel parameter.


memory::dims get_dilations() const

Returns dilations.

Returns:

Dilations.

An empty dnnl::memory::dims if the primitive does not have a dilations parameter.


memory::dims get_padding_l() const

Returns a left padding.

Returns:

A left padding.

An empty dnnl::memory::dims if the primitive does not have a left padding parameter.


memory::dims get_padding_r() const

Returns a right padding.

Returns:

A right padding.

An empty dnnl::memory::dims if the primitive does not have a right padding parameter.

Select Your Language

Using Intel.com Search

Quick Links

Recent Searches

Advanced Search

Only search in

Intel® oneAPI Deep Neural Network Developer Guide and Reference

struct dnnl::pooling_forward::primitive_desc

Overview

Detailed Documentation