Dnnl_api_layer_normalization

Collaboration diagram for Dnnl_api_layer_normalization:

Classes
struct	dnnl_layer_normalization_desc_t
	A descriptor of a Layer Normalization operation. More...

Functions
dnnl_status_t DNNL_API	dnnl_layer_normalization_forward_desc_init (dnnl_layer_normalization_desc_t *lnrm_desc, dnnl_prop_kind_t prop_kind, const dnnl_memory_desc_t *data_desc, const dnnl_memory_desc_t *stat_desc, float epsilon, unsigned flags)
dnnl_status_t DNNL_API	dnnl_layer_normalization_backward_desc_init (dnnl_layer_normalization_desc_t *lnrm_desc, dnnl_prop_kind_t prop_kind, const dnnl_memory_desc_t *diff_data_desc, const dnnl_memory_desc_t *data_desc, const dnnl_memory_desc_t *stat_desc, float epsilon, unsigned flags)

Detailed Description

Function Documentation

dnnl_layer_normalization_backward_desc_init()

dnnl_status_t DNNL_API dnnl_layer_normalization_backward_desc_init	(	dnnl_layer_normalization_desc_t *	lnrm_desc,
		dnnl_prop_kind_t	prop_kind,
		const dnnl_memory_desc_t *	diff_data_desc,
		const dnnl_memory_desc_t *	data_desc,
		const dnnl_memory_desc_t *	stat_desc,
		float	epsilon,
		unsigned	flags
	)

Initializes a descriptor for a layer normalization backward propagation primitive.

Note

In-place operation is supported: the diff_dst can refer to the same memory as the diff_src.

Parameters

lnrm_desc	Output descriptor for layer normalization primitive.
prop_kind	Propagation kind. Possible values are dnnl_backward_data and dnnl_backward (diffs for all parameters are computed in this case).
diff_data_desc	Diff source and diff destination memory descriptor.
data_desc	Source memory descriptor.
stat_desc	Memory descriptor for mean and variance. If this parameter is NULL, a zero memory descriptor, or a memory descriptor with format_kind set to dnnl_format_kind_undef, then the memory descriptor for stats is derived from data_desc by removing the last dimension.
epsilon	Layer normalization epsilon parameter.
flags	Layer normalization flags (dnnl_normalization_flags_t).

Returns

dnnl_success on success and a status describing the error otherwise.

dnnl_layer_normalization_forward_desc_init()

dnnl_status_t DNNL_API dnnl_layer_normalization_forward_desc_init	(	dnnl_layer_normalization_desc_t *	lnrm_desc,
		dnnl_prop_kind_t	prop_kind,
		const dnnl_memory_desc_t *	data_desc,
		const dnnl_memory_desc_t *	stat_desc,
		float	epsilon,
		unsigned	flags
	)

Initializes a descriptor for layer normalization forward propagation primitive.

Note

In-place operation is supported: the dst can refer to the same memory as the src.

Parameters

lnrm_desc	Output descriptor for layer normalization primitive.
prop_kind	Propagation kind. Possible values are dnnl_forward_training and dnnl_forward_inference.
data_desc	Source and destination memory descriptor.
stat_desc	Memory descriptor for mean and variance. If this parameter is NULL, a zero memory descriptor, or a memory descriptor with format_kind set to dnnl_format_kind_undef, then the memory descriptor for stats is derived from data_desc by removing the last dimension.
epsilon	Layer normalization epsilon parameter.
flags	Layer normalization flags (dnnl_normalization_flags_t).

Returns

dnnl_success on success and a status describing the error otherwise.