Intel® oneAPI Deep Neural Network Developer Guide and Reference
A newer version of this document is available. Customers should click here to go to the newest version.
Softmax
Overview
A primitive to perform softmax. More…
// structs
struct dnnl::softmax_backward;
struct dnnl::softmax_forward;
// global functions
dnnl_status_t DNNL_API dnnl_softmax_forward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
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,
const_dnnl_primitive_attr_t attr
);
dnnl_status_t DNNL_API dnnl_softmax_backward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
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,
const_dnnl_primitive_desc_t hint_fwd_pd,
const_dnnl_primitive_attr_t attr
);Detailed Documentation
A primitive to perform softmax.
See also:
Softmax in developer guide
Global Functions
dnnl_status_t DNNL_API dnnl_softmax_forward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
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,
const_dnnl_primitive_attr_t attr
)Creates a primitive descriptor for a softmax forward propagation primitive.
Parameters:
primitive_desc |
Output primitive descriptor. |
engine |
Engine to use. |
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. |
attr |
Primitive attributes (can be NULL). |
Returns:
dnnl_success on success and a status describing the error otherwise.
dnnl_status_t DNNL_API dnnl_softmax_backward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
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,
const_dnnl_primitive_desc_t hint_fwd_pd,
const_dnnl_primitive_attr_t attr
)Creates a primitive descriptor for a softmax backward propagation primitive.
Parameters:
primitive_desc |
Output primitive descriptor. |
engine |
Engine to use. |
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. |
hint_fwd_pd |
Primitive descriptor for a respective forward propagation primitive. |
attr |
Primitive attributes (can be NULL). |
Returns:
dnnl_success on success and a status describing the error otherwise.