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.
Shuffle
Overview
A primitive to shuffle tensor data along an axis. More…
// structs
struct dnnl::shuffle_backward;
struct dnnl::shuffle_forward;
// global functions
dnnl_status_t DNNL_API dnnl_shuffle_forward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
dnnl_prop_kind_t prop_kind,
const_dnnl_memory_desc_t src_desc,
const_dnnl_memory_desc_t dst_desc,
int axis,
dnnl_dim_t group_size,
const_dnnl_primitive_attr_t attr
);
dnnl_status_t DNNL_API dnnl_shuffle_backward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
const_dnnl_memory_desc_t diff_src_desc,
const_dnnl_memory_desc_t diff_dst_desc,
int axis,
dnnl_dim_t group_size,
const_dnnl_primitive_desc_t hint_fwd_pd,
const_dnnl_primitive_attr_t attr
);Detailed Documentation
A primitive to shuffle tensor data along an axis.
See also:
Shuffle in developer guide
Global Functions
dnnl_status_t DNNL_API dnnl_shuffle_forward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
dnnl_prop_kind_t prop_kind,
const_dnnl_memory_desc_t src_desc,
const_dnnl_memory_desc_t dst_desc,
int axis,
dnnl_dim_t group_size,
const_dnnl_primitive_attr_t attr
)Creates a primitive descriptor for a shuffle 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. |
src_desc |
Source memory descriptor. |
dst_desc |
Destination memory descriptor. |
axis |
The axis along which the data is shuffled. |
group_size |
Shuffle group size. |
attr |
Primitive attributes (can be NULL). |
Returns:
dnnl_success on success and a status describing the error otherwise.
dnnl_status_t DNNL_API dnnl_shuffle_backward_primitive_desc_create(
dnnl_primitive_desc_t* primitive_desc,
dnnl_engine_t engine,
const_dnnl_memory_desc_t diff_src_desc,
const_dnnl_memory_desc_t diff_dst_desc,
int axis,
dnnl_dim_t group_size,
const_dnnl_primitive_desc_t hint_fwd_pd,
const_dnnl_primitive_attr_t attr
)Creates a primitive descriptor for a shuffle backward propagation primitive.
Parameters:
primitive_desc |
Output primitive descriptor. |
engine |
Engine to use. |
diff_src_desc |
Diff source memory descriptor. |
diff_dst_desc |
Diff destination memory descriptor. |
axis |
The axis along which the data is shuffled. |
group_size |
Shuffle group size. |
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.