Collaboration diagram for RNN:

Functions
mkldnn_status_t MKLDNN_API	mkldnn_primitive_attr_set_rnn_data_qparams (mkldnn_primitive_attr_t attr, const float scale, const float shift)

mkldnn_status_t MKLDNN_API	mkldnn_primitive_attr_set_rnn_weights_qparams (mkldnn_primitive_attr_t attr, mkldnn_dim_t count, int mask, const float *weights_scales)

mkldnn_status_t MKLDNN_API	mkldnn_vanilla_rnn_forward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_alg_kind_t activation, const mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, unsigned flags, float alpha, float beta)

mkldnn_status_t MKLDNN_API	mkldnn_vanilla_rnn_backward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_alg_kind_t activation, const mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, const mkldnn_memory_desc_t diff_src_layer_desc, const mkldnn_memory_desc_t diff_src_iter_desc, const mkldnn_memory_desc_t diff_weights_layer_desc, const mkldnn_memory_desc_t diff_weights_iter_desc, const mkldnn_memory_desc_t diff_bias_desc, const mkldnn_memory_desc_t diff_dst_layer_desc, const mkldnn_memory_desc_t *diff_dst_iter_desc, unsigned flags, float alpha, float beta)

mkldnn_status_t MKLDNN_API	mkldnn_lstm_forward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t src_iter_c_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, const mkldnn_memory_desc_t dst_iter_c_desc, unsigned flags)

mkldnn_status_t MKLDNN_API	mkldnn_lstm_backward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t src_iter_c_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, const mkldnn_memory_desc_t dst_iter_c_desc, const mkldnn_memory_desc_t diff_src_layer_desc, const mkldnn_memory_desc_t diff_src_iter_desc, const mkldnn_memory_desc_t diff_src_iter_c_desc, const mkldnn_memory_desc_t diff_weights_layer_desc, const mkldnn_memory_desc_t diff_weights_iter_desc, const mkldnn_memory_desc_t diff_bias_desc, const mkldnn_memory_desc_t diff_dst_layer_desc, const mkldnn_memory_desc_t diff_dst_iter_desc, const mkldnn_memory_desc_t *diff_dst_iter_c_desc, unsigned flags)

mkldnn_status_t MKLDNN_API	mkldnn_gru_forward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, unsigned flags)

mkldnn_status_t MKLDNN_API	mkldnn_gru_backward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, const mkldnn_memory_desc_t diff_src_layer_desc, const mkldnn_memory_desc_t diff_src_iter_desc, const mkldnn_memory_desc_t diff_weights_layer_desc, const mkldnn_memory_desc_t diff_weights_iter_desc, const mkldnn_memory_desc_t diff_bias_desc, const mkldnn_memory_desc_t diff_dst_layer_desc, const mkldnn_memory_desc_t *diff_dst_iter_desc, unsigned flags)

mkldnn_status_t MKLDNN_API	mkldnn_lbr_gru_forward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, unsigned flags)

mkldnn_status_t MKLDNN_API	mkldnn_lbr_gru_backward_desc_init (mkldnn_rnn_desc_t rnn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_rnn_direction_t direction, const mkldnn_memory_desc_t src_layer_desc, const mkldnn_memory_desc_t src_iter_desc, const mkldnn_memory_desc_t weights_layer_desc, const mkldnn_memory_desc_t weights_iter_desc, const mkldnn_memory_desc_t bias_desc, const mkldnn_memory_desc_t dst_layer_desc, const mkldnn_memory_desc_t dst_iter_desc, const mkldnn_memory_desc_t diff_src_layer_desc, const mkldnn_memory_desc_t diff_src_iter_desc, const mkldnn_memory_desc_t diff_weights_layer_desc, const mkldnn_memory_desc_t diff_weights_iter_desc, const mkldnn_memory_desc_t diff_bias_desc, const mkldnn_memory_desc_t diff_dst_layer_desc, const mkldnn_memory_desc_t *diff_dst_iter_desc, unsigned flags)

Detailed Description

A primitive to compute the common recurrent layer.

See also: dev_guide_rnn in developer guide; cpp_api_rnn in cpp_api

Function Documentation

mkldnn_status_t MKLDNN_API mkldnn_gru_backward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		const mkldnn_memory_desc_t *	diff_src_layer_desc,
		const mkldnn_memory_desc_t *	diff_src_iter_desc,
		const mkldnn_memory_desc_t *	diff_weights_layer_desc,
		const mkldnn_memory_desc_t *	diff_weights_iter_desc,
		const mkldnn_memory_desc_t *	diff_bias_desc,
		const mkldnn_memory_desc_t *	diff_dst_layer_desc,
		const mkldnn_memory_desc_t *	diff_dst_iter_desc,
		unsigned	flags
	)

Initializes a GRU descriptor rnn_desc for backward propagation using prop_kind, direction, and memory descriptors.

Note: All memory descriptors are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

src_iter_desc (simultaneously with diff_src_iter_desc), bias_desc (simultaneously with diff_bias_desc), and dst_iter_desc (simultaneously with diff_src_iter_desc) are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Parameters:

flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used
dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
diff_dst_layer (mkldnn_query_diff_dst_md, 0)
diff_dst_iter (mkldnn_query_diff_dst_md, 1), if used
workspace (mkldnn_query_workspace_md, 0)

Outputs:

diff_src_layer (mkldnn_query_diff_src_md, 0)
diff_src_iter (mkldnn_query_diff_src_md, 1), if used
diff_weights_layer (mkldnn_query_diff_weights_md, 0)
diff_weights_iter (mkldnn_query_diff_weights_md, 1)
diff_bias (mkldnn_query_diff_weights_md, 2), if used

mkldnn_status_t MKLDNN_API mkldnn_gru_forward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		unsigned	flags
	)

Initializes a GRU descriptor rnn_desc for forward propagation using prop_kind, direction, and memory descriptors.

Note: If prop_kind equals mkldnn_forward_training, you must query a workspace memory descriptor before creating the primitive.

src_iter_desc, bias_desc, and dst_iter_desc are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Note: All memory descriptors except src_iter_desc are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

Parameters:

flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used

Outputs:

dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
workspace (mkldnn_query_workspace_md, 0), if prop_kind equals mkldnn_forward_training

mkldnn_status_t MKLDNN_API mkldnn_lbr_gru_backward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		const mkldnn_memory_desc_t *	diff_src_layer_desc,
		const mkldnn_memory_desc_t *	diff_src_iter_desc,
		const mkldnn_memory_desc_t *	diff_weights_layer_desc,
		const mkldnn_memory_desc_t *	diff_weights_iter_desc,
		const mkldnn_memory_desc_t *	diff_bias_desc,
		const mkldnn_memory_desc_t *	diff_dst_layer_desc,
		const mkldnn_memory_desc_t *	diff_dst_iter_desc,
		unsigned	flags
	)

Initializes an LBR GRU descriptor rnn_desc for backward propagation using prop_kind, direction, and memory descriptors.

Note: All memory descriptors are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

src_iter_desc (simultaneously with diff_src_iter_desc), bias_desc (simultaneously with diff_bias_desc), and dst_iter_desc (simultaneously with diff_src_iter_desc) are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Parameters:

flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used
dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
diff_dst_layer (mkldnn_query_diff_dst_md, 0)
diff_dst_iter (mkldnn_query_diff_dst_md, 1), if used
workspace (mkldnn_query_workspace_md, 0)

Outputs:

diff_src_layer (mkldnn_query_diff_src_md, 0)
diff_src_iter (mkldnn_query_diff_src_md, 1), if used
diff_weights_layer (mkldnn_query_diff_weights_md, 0)
diff_weights_iter (mkldnn_query_diff_weights_md, 1)
diff_bias (mkldnn_query_diff_weights_md, 2), if used

mkldnn_status_t MKLDNN_API mkldnn_lbr_gru_forward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		unsigned	flags
	)

Initializes an LBR GRU descriptor rnn_desc for forward propagation using prop_kind, direction, and memory descriptors.

Note: If prop_kind equals mkldnn_forward_training, you must query a workspace memory descriptor before creating the primitive.

src_iter_desc, bias_desc, and dst_iter_desc are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Note: All memory descriptors except src_iter_desc are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

Parameters:

flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used

Outputs:

dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
workspace (mkldnn_query_workspace_md, 0), if prop_kind equals mkldnn_forward_training

mkldnn_status_t MKLDNN_API mkldnn_lstm_backward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	src_iter_c_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		const mkldnn_memory_desc_t *	dst_iter_c_desc,
		const mkldnn_memory_desc_t *	diff_src_layer_desc,
		const mkldnn_memory_desc_t *	diff_src_iter_desc,
		const mkldnn_memory_desc_t *	diff_src_iter_c_desc,
		const mkldnn_memory_desc_t *	diff_weights_layer_desc,
		const mkldnn_memory_desc_t *	diff_weights_iter_desc,
		const mkldnn_memory_desc_t *	diff_bias_desc,
		const mkldnn_memory_desc_t *	diff_dst_layer_desc,
		const mkldnn_memory_desc_t *	diff_dst_iter_desc,
		const mkldnn_memory_desc_t *	diff_dst_iter_c_desc,
		unsigned	flags
	)

Initializes an LSTM descriptor rnn_desc for backward propagation using prop_kind, direction, and memory descriptors.

Note: All memory descriptors are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

src_iter_desc (simultaneously with diff_src_iter_desc), bias_desc (simultaneously with diff_bias_desc), and dst_iter_desc (simultaneously with diff_src_iter_desc) are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Parameters:

flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
src_iter_c (mkldnn_query_src_md, 2), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used
dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
dst_iter_c (mkldnn_query_dst_md, 2), if used
diff_dst_layer (mkldnn_query_diff_dst_md, 0)
diff_dst_iter (mkldnn_query_diff_dst_md, 1), if used
diff_dst_iter_c (mkldnn_query_diff_dst_md, 2), if used
workspace (mkldnn_query_workspace_md, 0)

Outputs:

diff_src_layer (mkldnn_query_diff_src_md, 0)
diff_src_iter (mkldnn_query_diff_src_md, 1), if used
diff_src_iter_c (mkldnn_query_diff_src_md, 2), if used
diff_weights_layer (mkldnn_query_diff_weights_md, 0)
diff_weights_iter (mkldnn_query_diff_weights_md, 1)
diff_bias (mkldnn_query_diff_weights_md, 2), if used

mkldnn_status_t MKLDNN_API mkldnn_lstm_forward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	src_iter_c_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		const mkldnn_memory_desc_t *	dst_iter_c_desc,
		unsigned	flags
	)

Initializes an LSTM descriptor rnn_desc for forward propagation using prop_kind, direction, and memory descriptors.

Note: If prop_kind equals mkldnn_forward_training, you must query a workspace memory descriptor before creating the primitive.

src_iter_desc, bias_desc, and dst_iter_desc are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Note: All memory descriptors except src_iter_desc are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

Parameters:

flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
src_iter_c (mkldnn_query_src_md, 2), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used

Outputs:

dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
dst_iter_c (mkldnn_query_dst_md, 2), if used
workspace (mkldnn_query_workspace_md, 0), if prop_kind equals mkldnn_forward_training

mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_set_rnn_data_qparams	(	mkldnn_primitive_attr_t	attr,
		const float	scale,
		const float	shift
	)

Sets quantization scale and shift for RNN data tensors. For performance reasons, low precision configuration of RNN primitive expects input activations to have unsigned int8 data type. Scale and shift used to quantize floating point data to unsigned integer must be passed to RNN primitive using attributes. Example usage:

 // rnn parameters
 int l = 2, t = 2, mb = 32, sic = 32, slc = 32, dic = 32, dlc = 32;
 // activations quantization parameters
 float scale = ..., shift = ..;
 
 mkldnn_primitive_attr_t rnn_attr;
 // create default attributes
 mkldnn_primitive_attr_create(&rnn_attr);
 
 // set scale and shift for int8 quantization of activation
 mkldnn_primitive_attr_set_rnn_data_qparams(rnn_attr, scale, shift);
 
 // create & configure rnn op_desc
 mkldnn_rnn_desc_t rnn_d;
 mkldnn_primitive_desc_t rnn_pd;
 mkldnn_primitive_desc_create(&rnn_pd, &rnn_d, attr, engine, NULL);

Note: Quantization scale and shift are common for src_layer, src_iter, dst_iter and dst_layer.

mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_set_rnn_weights_qparams	(	mkldnn_primitive_attr_t	attr,
		mkldnn_dim_t	count,
		int	mask,
		const float *	weights_scales
	)

Sets quantization scales weights_scales for RNN weights tensors. Low precision configuration of RNN primitive expects input weights to have signed int8 data type. Scales used to quantize floating point data to signed integer must be passed to RNN primitive using attributes. The mask argument defines correspondence between output tensor dimensions and the weights_scales array. Set i-th bit of mask to 1 to use dedicated scaling factor for each slice of the output tensor over i-th dimension. Set mask to 0 to use common scaling factor for the whole output tensor. Example usage:

 // rnn parameters
 int l = 2, t = 2, mb = 32, sic = 32, slc = 32, dic = 32, dlc = 32;
 // unique output scales per output channel
 float weights_scales[dic * n_gates] = { ... };
 // mask that specifies last two dimensions of ldigo format
 int mask = 0x3;
 
 mkldnn_primitive_attr_t attr;
 // create default attributes
 mkldnn_primitive_attr_create(&attr);
 
 // set output channel-wise weights scales
 mkldnn_primitive_attr_set_rnn_weights_qparams(attr, dic * n_gates, mask,
         weights_scales);
 
 // create & configure rnn op_desc
 mkldnn_rnn_desc_t rnn_d;
 mkldnn_primitive_desc_t rnn_pd;
 mkldnn_primitive_desc_create(&rnn_pd, &rnn_d, attr, engine, NULL);

Note: The dimension order is always native and does not depend on the actual layout used. For example, 5 dimensional weights always have (l, d, i, g, o) logical dimension ordering.; Quantization sales are common for weights_layer and weights_iteration; There is no way to check that count corresponds to mask until an actual primitive descriptor is created, so it is user's responsibility to set proper values. The following formula must be held:

$count = \prod\limits_{d \in mask} output.dims[d]$

mkldnn_status_t MKLDNN_API mkldnn_vanilla_rnn_backward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		const mkldnn_alg_kind_t	activation,
		const mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		const mkldnn_memory_desc_t *	diff_src_layer_desc,
		const mkldnn_memory_desc_t *	diff_src_iter_desc,
		const mkldnn_memory_desc_t *	diff_weights_layer_desc,
		const mkldnn_memory_desc_t *	diff_weights_iter_desc,
		const mkldnn_memory_desc_t *	diff_bias_desc,
		const mkldnn_memory_desc_t *	diff_dst_layer_desc,
		const mkldnn_memory_desc_t *	diff_dst_iter_desc,
		unsigned	flags,
		float	alpha,
		float	beta
	)

Initializes an RNN descriptor rnn_desc for backward propagation using prop_kind, activation, direction, and memory descriptors.

Note: All memory descriptors are allowed to be initialized with mkldnn_format_kind_any value of format_kind.

src_iter_desc (simultaneously with diff_src_iter_desc), bias_desc (simultaneously with diff_bias_desc), and dst_iter_desc (simultaneously with diff_src_iter_desc) are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Parameters:

activation (mkldnn_eltwise_relu, mkldnn_eltwise_tanh or mkldnn_eltwise_logistic)
alpha (negative slope if activation is mkldnn_eltwise_relu)
beta (unused for now)
flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used
dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
diff_dst_layer (mkldnn_query_diff_dst_md, 0)
diff_dst_iter (mkldnn_query_diff_dst_md, 1), if used
workspace (mkldnn_query_workspace_md, 0)

Outputs:

diff_src_layer (mkldnn_query_diff_src_md, 0)
diff_src_iter (mkldnn_query_diff_src_md, 1), if used
diff_weights_layer (mkldnn_query_diff_weights_md, 0)
diff_weights_iter (mkldnn_query_diff_weights_md, 1)
diff_bias (mkldnn_query_diff_weights_md, 2), if used

mkldnn_status_t MKLDNN_API mkldnn_vanilla_rnn_forward_desc_init	(	mkldnn_rnn_desc_t *	rnn_desc,
		mkldnn_prop_kind_t	prop_kind,
		const mkldnn_alg_kind_t	activation,
		const mkldnn_rnn_direction_t	direction,
		const mkldnn_memory_desc_t *	src_layer_desc,
		const mkldnn_memory_desc_t *	src_iter_desc,
		const mkldnn_memory_desc_t *	weights_layer_desc,
		const mkldnn_memory_desc_t *	weights_iter_desc,
		const mkldnn_memory_desc_t *	bias_desc,
		const mkldnn_memory_desc_t *	dst_layer_desc,
		const mkldnn_memory_desc_t *	dst_iter_desc,
		unsigned	flags,
		float	alpha,
		float	beta
	)

Initializes an RNN descriptor rnn_desc for forward propagation using prop_kind, activation, direction, and memory descriptors.

Note: If prop_kind equals mkldnn_forward_training, you must query a workspace memory descriptor before creating the primitive.

src_iter_desc, bias_desc, and dst_iter_desc are allowed to either be NULL or point to a zero memory descriptor, which would indicate that the RNN primitive should not use them and will default to zero values.

Note: All memory descriptorsare allowed to be initialized with mkldnn_format_kind_any value of format_kind.

Parameters:

activation (mkldnn_eltwise_relu, mkldnn_eltwise_tanh or mkldnn_eltwise_logistic)
alpha (negative slope if activation is mkldnn_eltwise_relu)
beta (unused for now)
flags (unused for now)

Inputs:

src_layer (mkldnn_query_src_md, 0)
src_iter (mkldnn_query_src_md, 1), if used
weights_layer (mkldnn_query_weights_md, 0)
weights_iter (mkldnn_query_weights_md, 1)
bias (mkldnn_query_weights_md, 2), if used

Outputs:

dst_layer (mkldnn_query_dst_md, 0)
dst_iter (mkldnn_query_dst_md, 1), if used
workspace (mkldnn_query_workspace_md, 0), if prop_kind equals mkldnn_forward_training

Functions

Detailed Description

Function Documentation