oneAPI Deep Neural Network Library (oneDNN)
Performance library for Deep Learning
1.96.0
dnnl::gru_forward::desc Struct Reference

Descriptor for a GRU forward propagation primitive. More...

#include <dnnl.hpp>

Collaboration diagram for dnnl::gru_forward::desc:

Public Member Functions

 desc (prop_kind aprop_kind, rnn_direction direction, const memory::desc &src_layer_desc, const memory::desc &src_iter_desc, const memory::desc &weights_layer_desc, const memory::desc &weights_iter_desc, const memory::desc &bias_desc, const memory::desc &dst_layer_desc, const memory::desc &dst_iter_desc, rnn_flags flags=rnn_flags::undef)
 Constructs a descriptor for a GRU forward propagation primitive. More...
 

Detailed Description

Descriptor for a GRU forward propagation primitive.

Constructor & Destructor Documentation

◆ desc()

dnnl::gru_forward::desc::desc ( prop_kind  aprop_kind,
rnn_direction  direction,
const memory::desc src_layer_desc,
const memory::desc src_iter_desc,
const memory::desc weights_layer_desc,
const memory::desc weights_iter_desc,
const memory::desc bias_desc,
const memory::desc dst_layer_desc,
const memory::desc dst_iter_desc,
rnn_flags  flags = rnn_flags::undef 
)
inline

Constructs a descriptor for a GRU forward propagation primitive.

The following arguments may point to a zero memory descriptor:

  • src_iter_desc,
  • bias_desc,
  • dst_iter_desc.

This would then indicate that the GRU forward propagation primitive should not use them and should default to zero values instead.

Note
All memory descriptors except src_iter_desc may be initialized with an dnnl::memory::format_tag::any value of format_tag.
Parameters
aprop_kindPropagation kind. Possible values are dnnl::prop_kind::forward_training, and dnnl::prop_kind::forward_inference.
directionRNN direction. See dnnl::rnn_direction for more info.
src_layer_descMemory descriptor for the input vector.
src_iter_descMemory descriptor for the input recurrent hidden state vector.
weights_layer_descMemory descriptor for the weights applied to the layer input.
weights_iter_descMemory descriptor for the weights applied to the recurrent input.
bias_descBias memory descriptor.
dst_layer_descMemory descriptor for the output vector.
dst_iter_descMemory descriptor for the output recurrent hidden state vector.
flagsUnused.

The documentation for this struct was generated from the following file: