.. index:: pair: struct; dnnl::vanilla_rnn_backward::primitive_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc: struct dnnl::vanilla_rnn_backward::primitive_desc ================================================= .. toctree:: :hidden: Overview ~~~~~~~~ Primitive descriptor for an RNN backward propagation primitive. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include struct primitive_desc: public :ref:`dnnl::rnn_primitive_desc_base` { // construction :ref:`primitive_desc`(); :ref:`primitive_desc`( const :ref:`desc`& adesc, const :ref:`engine`& aengine, const :ref:`vanilla_rnn_forward::primitive_desc`& hint_fwd_pd, bool allow_empty = false ); :ref:`primitive_desc`( const :ref:`desc`& adesc, const primitive_attr& attr, const :ref:`engine`& aengine, const :ref:`vanilla_rnn_forward::primitive_desc`& hint_fwd_pd, bool allow_empty = false ); :ref:`primitive_desc`(:ref:`dnnl_primitive_desc_t` pd); // methods :ref:`memory::desc` :ref:`src_layer_desc`() const; :ref:`memory::desc` :ref:`src_iter_desc`() const; :ref:`memory::desc` :ref:`weights_layer_desc`() const; :ref:`memory::desc` :ref:`weights_iter_desc`() const; :ref:`memory::desc` :ref:`bias_desc`() const; :ref:`memory::desc` :ref:`dst_layer_desc`() const; :ref:`memory::desc` :ref:`dst_iter_desc`() const; :ref:`memory::desc` :ref:`workspace_desc`() const; :ref:`memory::desc` :ref:`diff_src_layer_desc`() const; :ref:`memory::desc` :ref:`diff_src_iter_desc`() const; :ref:`memory::desc` :ref:`diff_weights_layer_desc`() const; :ref:`memory::desc` :ref:`diff_weights_iter_desc`() const; :ref:`memory::desc` :ref:`diff_bias_desc`() const; :ref:`memory::desc` :ref:`diff_dst_layer_desc`() const; :ref:`memory::desc` :ref:`diff_dst_iter_desc`() const; }; Inherited Members ----------------- .. ref-code-block:: cpp :class: doxyrest-overview-inherited-code-block public: // methods :ref:`handle`& :ref:`operator =` (const :ref:`handle`&); :ref:`handle`& :ref:`operator =` (:ref:`handle`&&); void :ref:`reset`(T t, bool weak = false); T :ref:`get`(bool allow_empty = false) const; :ref:`operator T` () const; :ref:`operator bool` () const; bool :ref:`operator ==` (const :ref:`handle`& other) const; bool :ref:`operator !=` (const :ref:`handle`& other) const; :ref:`engine` :ref:`get_engine`() const; const char* :ref:`impl_info_str`() const; :ref:`memory::dim` :ref:`query_s64`(:ref:`query` what) const; :ref:`memory::desc` :ref:`query_md`(:ref:`query` what, int idx = 0) const; :ref:`memory::desc` :ref:`src_desc`(int idx) const; :ref:`memory::desc` :ref:`dst_desc`(int idx) const; :ref:`memory::desc` :ref:`weights_desc`(int idx) const; :ref:`memory::desc` :ref:`diff_src_desc`(int idx) const; :ref:`memory::desc` :ref:`diff_dst_desc`(int idx) const; :ref:`memory::desc` :ref:`diff_weights_desc`(int idx) const; :ref:`memory::desc` :ref:`src_desc`() const; :ref:`memory::desc` :ref:`dst_desc`() const; :ref:`memory::desc` :ref:`weights_desc`() const; :ref:`memory::desc` :ref:`diff_src_desc`() const; :ref:`memory::desc` :ref:`diff_dst_desc`() const; :ref:`memory::desc` :ref:`diff_weights_desc`() const; :ref:`memory::desc` :ref:`workspace_desc`() const; :ref:`memory::desc` :ref:`scratchpad_desc`() const; :ref:`engine` :ref:`scratchpad_engine`() const; primitive_attr :ref:`get_primitive_attr`() const; :ref:`dnnl::primitive::kind` :ref:`get_kind`() const; bool :ref:`next_impl`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`memory::desc` :ref:`src_layer_desc`() const; :ref:`memory::desc` :ref:`src_iter_desc`() const; :ref:`memory::desc` :ref:`src_iter_c_desc`() const; :ref:`memory::desc` :ref:`weights_layer_desc`() const; :ref:`memory::desc` :ref:`weights_iter_desc`() const; :ref:`memory::desc` :ref:`weights_peephole_desc`() const; :ref:`memory::desc` :ref:`weights_projection_desc`() const; :ref:`memory::desc` :ref:`bias_desc`() const; :ref:`memory::desc` :ref:`dst_layer_desc`() const; :ref:`memory::desc` :ref:`dst_iter_desc`() const; :ref:`memory::desc` :ref:`dst_iter_c_desc`() const; :ref:`memory::desc` :ref:`diff_src_layer_desc`() const; :ref:`memory::desc` :ref:`diff_src_iter_desc`() const; :ref:`memory::desc` :ref:`diff_src_iter_c_desc`() const; :ref:`memory::desc` :ref:`diff_weights_layer_desc`() const; :ref:`memory::desc` :ref:`diff_weights_iter_desc`() const; :ref:`memory::desc` :ref:`diff_weights_peephole_desc`() const; :ref:`memory::desc` :ref:`diff_weights_projection_desc`() const; :ref:`memory::desc` :ref:`diff_bias_desc`() const; :ref:`memory::desc` :ref:`diff_dst_layer_desc`() const; :ref:`memory::desc` :ref:`diff_dst_iter_desc`() const; :ref:`memory::desc` :ref:`diff_dst_iter_c_desc`() const; :ref:`primitive_desc`(); :ref:`primitive_desc`(); .. _details-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Primitive descriptor for an RNN backward propagation primitive. Construction ------------ .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a8d7e9e966d54a04d4ac8e2d47df637e4: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc() Default constructor. Produces an empty object. .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a9007de7e25036cc802f51b3c869a861d: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`desc`& adesc, const :ref:`engine`& aengine, const :ref:`vanilla_rnn_forward::primitive_desc`& hint_fwd_pd, bool allow_empty = false ) Constructs a primitive descriptor for a vanilla RNN backward propagation primitive. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - adesc - Descriptor for a vanilla RNN backward propagation primitive. * - aengine - Engine to use. * - hint_fwd_pd - Primitive descriptor for a vanilla RNN forward propagation primitive. It is used as a hint for deciding which memory format to use. * - allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false. .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a04a81749b9b086ac1ee2e71b4efa9115: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`desc`& adesc, const primitive_attr& attr, const :ref:`engine`& aengine, const :ref:`vanilla_rnn_forward::primitive_desc`& hint_fwd_pd, bool allow_empty = false ) Constructs a primitive descriptor for a vanilla RNN backward propagation primitive. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - adesc - Descriptor for a vanilla RNN backward propagation primitive. * - attr - Primitive attributes to use. * - aengine - Engine to use. * - hint_fwd_pd - Primitive descriptor for a vanilla RNN forward propagation primitive. It is used as a hint for deciding which memory format to use. * - allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false. .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1aba50f3b1d77a244edf14368e9d07d423: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc(:ref:`dnnl_primitive_desc_t` pd) Constructs a primitive descriptor for a vanilla RNN backward propagation primitive from a C API primitive descriptor that must have a matching kind. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pd - C API primitive descriptor for a vanilla RNN backward propagation primitive. Methods ------- .. index:: pair: function; src_layer_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1ae0bb0e4bdc6f1dc70b8726fecfffbf9d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` src_layer_desc() const Returns source layer memory descriptor. .. rubric:: Returns: Source layer memory descriptor. .. index:: pair: function; src_iter_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a09bc34015fb85dd6169fe77f604e3e5b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` src_iter_desc() const Returns source iteration memory descriptor. .. rubric:: Returns: Source iteration memory descriptor. A zero memory descriptor if the primitive does not have a source iteration parameter. .. index:: pair: function; weights_layer_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1abd9a4f50fc48d3d260d294641fb5804c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` weights_layer_desc() const Returns weights layer memory descriptor. .. rubric:: Returns: Weights layer memory descriptor. .. index:: pair: function; weights_iter_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1ab15c6816074c04dbf71c6809fca50265: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` weights_iter_desc() const Returns weights iteration memory descriptor. .. rubric:: Returns: Weights iteration memory descriptor. .. index:: pair: function; bias_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1abf9730fa0073ddf0a556cef045262a85: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` bias_desc() const Returns bias memory descriptor. .. rubric:: Returns: Bias memory descriptor. A zero memory descriptor if the primitive does not have a bias parameter. .. index:: pair: function; dst_layer_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a255ec605c277c287b5413a511b1ef752: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` dst_layer_desc() const Returns destination layer memory descriptor. .. rubric:: Returns: Destination layer memory descriptor. .. index:: pair: function; dst_iter_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1acc12febaf26a3145bf8fafd42a57a8d4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` dst_iter_desc() const Returns destination iteration memory descriptor. .. rubric:: Returns: Destination iteration memory descriptor. A zero memory descriptor if the primitive does not have a destination iteration parameter. .. index:: pair: function; workspace_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1af9aba6bf0176ac7004ec511d56914b43: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` workspace_desc() const Returns the workspace memory descriptor. .. rubric:: Returns: Workspace memory descriptor. A zero memory descriptor if the primitive does not require workspace parameter. .. index:: pair: function; diff_src_layer_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1ae02fa94c5e2aec9f2a4e7276870d7b65: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_src_layer_desc() const Returns diff source layer memory descriptor. .. rubric:: Returns: Diff source layer memory descriptor. .. index:: pair: function; diff_src_iter_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a40702982621016d0bb3d2082e76acfca: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_src_iter_desc() const Returns diff source iteration memory descriptor. .. rubric:: Returns: Diff source iteration memory descriptor. A zero memory descriptor if the primitive does not have a diff source iteration parameter. .. index:: pair: function; diff_weights_layer_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1af6db8304c9e8a762c3f900823c0c8d5a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_weights_layer_desc() const Returns diff weights layer memory descriptor. .. rubric:: Returns: Diff weights layer memory descriptor. .. index:: pair: function; diff_weights_iter_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a49a68b6e78ef99ad4c45564ee5a68697: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_weights_iter_desc() const Returns diff weights iteration memory descriptor. .. rubric:: Returns: Diff weights iteration memory descriptor. .. index:: pair: function; diff_bias_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a9e5b2141e4df496dc36f2c85dd81c49f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_bias_desc() const Returns diff bias memory descriptor. .. rubric:: Returns: Diff bias memory descriptor. A zero memory descriptor if the primitive does not have a diff bias parameter. .. index:: pair: function; diff_dst_layer_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1a1d032311ae45201e9c7ccb8751f48cc5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_dst_layer_desc() const Returns diff destination layer memory descriptor. .. rubric:: Returns: Diff destination layer memory descriptor. .. index:: pair: function; diff_dst_iter_desc .. _doxid-structdnnl_1_1vanilla__rnn__backward_1_1primitive__desc_1acd165a44f6fc41b4bcfe31916b4b6482: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_dst_iter_desc() const Returns diff destination iteration memory descriptor. .. rubric:: Returns: Diff destination iteration memory descriptor. A zero memory descriptor if the primitive does not have a diff destination iteration parameter.