struct dnnl::softmax_backward::primitive

Intel® oneAPI Deep Neural Network Developer Guide and Reference

Download PDF

ID 768875

Date 2/28/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-1C2DAF6A-5CF9-4431-B754-61B9FEFFCB04

View Details

struct dnnl::softmax_backward::primitive_desc

Overview

Primitive descriptor for a softmax backward propagation primitive. More…


#include <dnnl.hpp>

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

    primitive_desc();

    primitive_desc(
        const engine& aengine,
        algorithm aalgorithm,
        const memory::desc& diff_src_desc,
        const memory::desc& diff_dst_desc,
        const memory::desc& dst_desc,
        int axis,
        const softmax_forward::primitive_desc& hint_fwd_pd,
        const primitive_attr& attr = default_attr(),
        bool allow_empty = false
        );

    primitive_desc(dnnl_primitive_desc_t pd);

    // methods

    memory::desc dst_desc() const;
    memory::desc diff_src_desc() const;
    memory::desc diff_dst_desc() const;
    dnnl::algorithm get_algorithm() const;
    dnnl::prop_kind get_prop_kind() const;
    int get_axis() 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 softmax backward propagation primitive.

Construction


primitive_desc()

Default constructor. Produces an empty object.


primitive_desc(
    const engine& aengine,
    algorithm aalgorithm,
    const memory::desc& diff_src_desc,
    const memory::desc& diff_dst_desc,
    const memory::desc& dst_desc,
    int axis,
    const softmax_forward::primitive_desc& hint_fwd_pd,
    const primitive_attr& attr = default_attr(),
    bool allow_empty = false
    )

Constructs a primitive descriptor for a softmax backward propagation primitive.

Parameters:

aengine	Engine to use.
aalgorithm	Softmax algorithm kind: either dnnl::algorithm::softmax_accurate, or dnnl::algorithm::softmax_log.
diff_src_desc	Diff source memory descriptor.
diff_dst_desc	Diff destination memory descriptor.
dst_desc	Destination memory descriptor.
axis	Axis over which softmax is computed.
hint_fwd_pd	Primitive descriptor for a softmax forward propagation primitive. It is used as a hint for deciding which memory format to use.
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 softmax backward propagation primitive from a C API primitive descriptor that must have a matching kind.

Parameters:

pd	C API primitive descriptor for a softmax backward propagation primitive.

Methods


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 diff_src_desc() const

Returns a diff source memory descriptor.

Returns:

Diff source memory descriptor.

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


memory::desc diff_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.


dnnl::algorithm get_algorithm() const

Returns an algorithm kind.

Returns:

An algorithm kind.

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


dnnl::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.


int get_axis() const

Returns an axis.

Returns:

An axis.

A negative number if the primitive does not have an axis 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::softmax_backward::primitive_desc

Overview

Detailed Documentation