oneAPI Deep Neural Network Library (oneDNN)
Performance library for Deep Learning
1.96.0
Inner Product

A primitive to compute an inner product. More...

Classes

struct  dnnl::inner_product_forward
 Inner product forward propagation primitive. More...
 
struct  dnnl::inner_product_backward_data
 Inner product backward propagation primitive. More...
 
struct  dnnl::inner_product_backward_weights
 Inner product weights gradient primitive. More...
 
struct  dnnl_inner_product_desc_t
 A descriptor of an inner product operation. More...
 

Functions

dnnl_status_t DNNL_API dnnl_inner_product_forward_desc_init (dnnl_inner_product_desc_t *ip_desc, dnnl_prop_kind_t prop_kind, const dnnl_memory_desc_t *src_desc, const dnnl_memory_desc_t *weights_desc, const dnnl_memory_desc_t *bias_desc, const dnnl_memory_desc_t *dst_desc)
 Initializes descriptor for inner product forward propagation. More...
 
dnnl_status_t DNNL_API dnnl_inner_product_backward_data_desc_init (dnnl_inner_product_desc_t *ip_desc, const dnnl_memory_desc_t *diff_src_desc, const dnnl_memory_desc_t *weights_desc, const dnnl_memory_desc_t *diff_dst_desc)
 Initializes descriptor for inner product backward propagation. More...
 
dnnl_status_t DNNL_API dnnl_inner_product_backward_weights_desc_init (dnnl_inner_product_desc_t *ip_desc, const dnnl_memory_desc_t *src_desc, const dnnl_memory_desc_t *diff_weights_desc, const dnnl_memory_desc_t *diff_bias_desc, const dnnl_memory_desc_t *diff_dst_desc)
 Initializes descriptor for inner product weights gradient primitive. More...
 

Detailed Description

A primitive to compute an inner product.

See also
Inner Product in developer guide

Function Documentation

◆ dnnl_inner_product_forward_desc_init()

dnnl_status_t DNNL_API dnnl_inner_product_forward_desc_init ( dnnl_inner_product_desc_t ip_desc,
dnnl_prop_kind_t  prop_kind,
const dnnl_memory_desc_t src_desc,
const dnnl_memory_desc_t weights_desc,
const dnnl_memory_desc_t bias_desc,
const dnnl_memory_desc_t dst_desc 
)

Initializes descriptor for inner product forward propagation.

Note
Memory descriptors can be initialized with dnnl_format_tag_any or with format_kind set to dnnl_format_kind_any.
Parameters
ip_descOutput descriptor for inner product primitive.
prop_kindPropagation kind. Possible values are dnnl_forward_training and dnnl_forward_inference.
src_descSource memory descriptor.
weights_descWeights memory descriptor.
bias_descBias memory descriptor. Passing NULL, a zero memory descriptor, or a memory descriptor with format_kind set to dnnl_format_kind_undef disables the bias term.
dst_descDestination memory descriptor.
Returns
dnnl_success on success and a status describing the error otherwise.

◆ dnnl_inner_product_backward_data_desc_init()

dnnl_status_t DNNL_API dnnl_inner_product_backward_data_desc_init ( dnnl_inner_product_desc_t ip_desc,
const dnnl_memory_desc_t diff_src_desc,
const dnnl_memory_desc_t weights_desc,
const dnnl_memory_desc_t diff_dst_desc 
)

Initializes descriptor for inner product backward propagation.

Note
Memory descriptors can be initialized with dnnl_format_tag_any or with format_kind set to dnnl_format_kind_any.
Parameters
ip_descOutput descriptor for inner product primitive.
diff_src_descDiff source memory descriptor.
weights_descWeights memory descriptor.
diff_dst_descDiff destination memory descriptor.
Returns
dnnl_success on success and a status describing the error otherwise.

◆ dnnl_inner_product_backward_weights_desc_init()

dnnl_status_t DNNL_API dnnl_inner_product_backward_weights_desc_init ( dnnl_inner_product_desc_t ip_desc,
const dnnl_memory_desc_t src_desc,
const dnnl_memory_desc_t diff_weights_desc,
const dnnl_memory_desc_t diff_bias_desc,
const dnnl_memory_desc_t diff_dst_desc 
)

Initializes descriptor for inner product weights gradient primitive.

Note
Memory descriptors can be initialized with dnnl_format_tag_any or with format_kind set to dnnl_format_kind_any.
Parameters
ip_descOutput descriptor for inner product primitive.
src_descSource memory descriptor.
diff_weights_descDiff weights memory descriptor.
diff_bias_descDiff bias memory descriptor. Passing NULL, a zero memory descriptor, or a memory descriptor with format_kind set to dnnl_format_kind_undef disables the bias term.
diff_dst_descDiff destination memory descriptor.
Returns
dnnl_success on success and a status describing the error otherwise.