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.

Inputs:

• src (dnnl_query_src_md, 0)
• weights (dnnl_query_weights_md, 0)
• bias (dnnl_query_weights_md, 1), if created with bias

Outputs:

• dst (dnnl_query_dst_md, 0)

Parameters

ip_desc	Output descriptor for inner product primitive.
prop_kind	Propagation kind. Possible values are dnnl_forward_training and dnnl_forward_inference.
src_desc	Source memory descriptor.
weights_desc	Weights memory descriptor.
bias_desc	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.
dst_desc	Destination 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.

Inputs:

• diff_dst (dnnl_query_diff_dst_md, 0)
• weights (dnnl_query_weights_md, 0)

Outputs:

• diff_src (dnnl_query_diff_src_md, 0)

Parameters

ip_desc	Output descriptor for inner product primitive.
diff_src_desc	Diff source memory descriptor.
weights_desc	Weights memory descriptor.
diff_dst_desc	Diff 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.

Inputs:

• src (dnnl_query_src_md, 0)
• diff_dst (dnnl_query_diff_dst_md, 0)

Outputs:

• diff_weights (dnnl_query_diff_weights_md, 0)
• diff_bias (dnnl_query_diff_weights_md, 1), if created with bias

Parameters

ip_desc	Output descriptor for inner product primitive.
src_desc	Source memory descriptor.
diff_weights_desc	Diff weights memory descriptor.
diff_bias_desc	Diff 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_desc	Diff destination memory descriptor.

Returns

dnnl_success on success and a status describing the error otherwise.