Intel® oneAPI Deep Neural Network Library Developer Guide and Reference

Developer Guide and Reference

  • 2022.1
  • 04/11/2022
  • Public Content
Contents

Softmax_v2

Overview

A primitive to perform softmax. More…
// structs

struct dnnl_softmax_v2_desc_t;
struct dnnl::softmax_v2_backward;
struct dnnl::softmax_v2_forward;

// global functions

dnnl_status_t DNNL_API dnnl_softmax_v2_forward_desc_init(
    dnnl_softmax_v2_desc_t* softmax_desc,
    dnnl_prop_kind_t prop_kind,
    dnnl_alg_kind_t alg_kind,
    const dnnl_memory_desc_t* src_desc,
    const dnnl_memory_desc_t* dst_desc,
    int softmax_axis
    );

dnnl_status_t DNNL_API dnnl_softmax_v2_backward_desc_init(
    dnnl_softmax_v2_desc_t* softmax_desc,
    dnnl_alg_kind_t alg_kind,
    const dnnl_memory_desc_t* diff_src_desc,
    const dnnl_memory_desc_t* diff_dst_desc,
    const dnnl_memory_desc_t* dst_desc,
    int softmax_axis
    );

Detailed Documentation

A primitive to perform softmax.
See also:
Softmax in developer guide
Global Functions
dnnl_status_t DNNL_API dnnl_softmax_v2_forward_desc_init(
    dnnl_softmax_v2_desc_t* softmax_desc,
    dnnl_prop_kind_t prop_kind,
    dnnl_alg_kind_t alg_kind,
    const dnnl_memory_desc_t* src_desc,
    const dnnl_memory_desc_t* dst_desc,
    int softmax_axis
    )
Initializes a descriptor for softmax v2 forward propagation primitive.
Parameters:
softmax_desc
Output descriptor for a softmax primitive.
prop_kind
Propagation kind. Possible values are dnnl_forward_training and dnnl_forward_inference.
alg_kind
Softmax algorithm kind: either dnnl_softmax_accurate, or dnnl_softmax_log.
src_desc
Source memory descriptor.
dst_desc
Destination memory descriptor.
softmax_axis
Axis over which softmax is computed.
Returns:
dnnl_success on success and a status describing the error otherwise.
dnnl_status_t DNNL_API dnnl_softmax_v2_backward_desc_init(
    dnnl_softmax_v2_desc_t* softmax_desc,
    dnnl_alg_kind_t alg_kind,
    const dnnl_memory_desc_t* diff_src_desc,
    const dnnl_memory_desc_t* diff_dst_desc,
    const dnnl_memory_desc_t* dst_desc,
    int softmax_axis
    )
Initializes a descriptor for softmax v2 backward propagation primitive.
Parameters:
softmax_desc
Output descriptor for a softmax primitive.
alg_kind
Softmax algorithm kind: either dnnl_softmax_accurate, or dnnl_softmax_log.
diff_src_desc
Diff source memory descriptor.
diff_dst_desc
Diff destination memory descriptor.
dst_desc
Destination memory descriptor.
softmax_axis
Axis over which softmax is computed.
Returns:
dnnl_success on success and a status describing the error otherwise.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.