.. index:: pair: struct; dnnl::deconvolution_backward_weights::primitive_desc .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc: struct dnnl::deconvolution_backward_weights::primitive_desc =========================================================== .. toctree:: :hidden: Overview ~~~~~~~~ Primitive descriptor for a deconvolution weights gradient primitive. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block #include struct primitive_desc: public :ref:`dnnl::primitive_desc` { // construction :ref:`primitive_desc`(); :ref:`primitive_desc`( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_bias_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ); :ref:`primitive_desc`( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ); :ref:`primitive_desc`( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_bias_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& dilates, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ); :ref:`primitive_desc`( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& dilates, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ); :ref:`primitive_desc`(:ref:`dnnl_primitive_desc_t` pd); // methods :ref:`memory::desc` :ref:`src_desc`() const; :ref:`memory::desc` :ref:`diff_weights_desc`() const; :ref:`memory::desc` :ref:`diff_dst_desc`() const; :ref:`memory::desc` :ref:`diff_bias_desc`() const; :ref:`algorithm` :ref:`get_algorithm`() const; :ref:`prop_kind` :ref:`get_prop_kind`() const; :ref:`memory::dims` :ref:`get_strides`() const; :ref:`memory::dims` :ref:`get_dilations`() const; :ref:`memory::dims` :ref:`get_padding_l`() const; :ref:`memory::dims` :ref:`get_padding_r`() 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::dims` :ref:`get_strides`() const; :ref:`memory::dims` :ref:`get_dilations`() const; :ref:`memory::dims` :ref:`get_padding_l`() const; :ref:`memory::dims` :ref:`get_padding_r`() const; float :ref:`get_epsilon`() const; template T :ref:`get_flags`() const; :ref:`dnnl::algorithm` :ref:`get_algorithm`() const; float :ref:`get_alpha`() const; float :ref:`get_beta`() const; int :ref:`get_axis`() const; :ref:`memory::dim` :ref:`get_local_size`() const; float :ref:`get_k`() const; float :ref:`get_p`() const; std::vector :ref:`get_factors`() const; :ref:`dnnl::algorithm` :ref:`get_cell_kind`() const; :ref:`dnnl::rnn_direction` :ref:`get_direction`() const; :ref:`dnnl::algorithm` :ref:`get_activation_kind`() const; :ref:`memory::dims` :ref:`get_kernel`() const; :ref:`memory::dim` :ref:`get_group_size`() const; :ref:`dnnl::prop_kind` :ref:`get_prop_kind`() 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; :ref:`primitive_attr` :ref:`get_primitive_attr`() const; :ref:`dnnl::primitive::kind` :ref:`get_kind`() const; std::vector :ref:`get_cache_blob_id`() const; bool :ref:`next_impl`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); :ref:`primitive_desc_base`(); .. _details-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Primitive descriptor for a deconvolution weights gradient primitive. Construction ------------ .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1ae2e076c744bfcf571eddfdead80680b8: .. 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_1deconvolution__backward__weights_1_1primitive__desc_1ac55ff3ac2e062130ff3ccfbe476d771c: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_bias_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ) Constructs a primitive descriptor for a deconvolution weights gradient primitive with bias. .. note:: All the memory descriptors may be initialized with the :ref:`dnnl::memory::format_tag::any ` value of ``format_tag``. Arrays ``strides``, ``padding_l``, and ``padding_r`` contain values for spatial dimensions only and hence must have the same number of elements as there are spatial dimensions. The order of values is the same as in the tensor: depth (for 3D tensors), height (for 3D and 2D tensors), and width. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - aengine - Engine to use. * - aalgorithm - Deconvolution algorithm. Possible values are :ref:`dnnl::algorithm::deconvolution_direct `, and :ref:`dnnl::algorithm::deconvolution_winograd `. * - src_desc - Source memory descriptor. * - diff_weights_desc - Diff weights memory descriptor. * - diff_bias_desc - Diff bias memory descriptor. Passing zero memory descriptor disables the bias term. * - diff_dst_desc - Diff destination memory descriptor. * - strides - Strides for each spatial dimension. * - padding_l - Vector of padding values for low indices for each spatial dimension ``([[front,] top,] left)``. * - padding_r - Vector of padding values for high indices for each spatial dimension ``([[back,] bottom,] right)``. * - hint_fwd_pd - Primitive descriptor for a deconvolution forward propagation primitive. It is used as a hint for deciding which memory format to use. * - attr - Primitive attributes to use. Attributes are optional and default to empty attributes. * - 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_1deconvolution__backward__weights_1_1primitive__desc_1a34bfd6a2f8db114157a094dc69bc79df: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ) Constructs a primitive descriptor for a deconvolution weights gradient primitive without bias. .. note:: All the memory descriptors may be initialized with the :ref:`dnnl::memory::format_tag::any ` value of ``format_tag``. Arrays ``strides``, ``padding_l``, and ``padding_r`` contain values for spatial dimensions only and hence must have the same number of elements as there are spatial dimensions. The order of values is the same as in the tensor: depth (for 3D tensors), height (for 3D and 2D tensors), and width. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - aengine - Engine to use. * - aalgorithm - Deconvolution algorithm. Possible values are :ref:`dnnl::algorithm::deconvolution_direct `, and :ref:`dnnl::algorithm::deconvolution_winograd `. * - src_desc - Source memory descriptor. * - diff_weights_desc - Diff weights memory descriptor. * - diff_dst_desc - Diff destination memory descriptor. * - strides - Strides for each spatial dimension. * - padding_l - Vector of padding values for low indices for each spatial dimension ``([[front,] top,] left)``. * - padding_r - Vector of padding values for high indices for each spatial dimension ``([[back,] bottom,] right)``. * - hint_fwd_pd - Primitive descriptor for a deconvolution forward propagation primitive. It is used as a hint for deciding which memory format to use. * - attr - Primitive attributes to use. Attributes are optional and default to empty attributes. * - 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_1deconvolution__backward__weights_1_1primitive__desc_1a46f9a32553ff0a360d03a5515ec00a86: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_bias_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& dilates, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ) Constructs a primitive descriptor for a deconvolution weights gradient primitive with bias. .. note:: All the memory descriptors may be initialized with the :ref:`dnnl::memory::format_tag::any ` value of ``format_tag``. Arrays ``strides``, ``dilates``, ``padding_l``, and ``padding_r`` contain values for spatial dimensions only and hence must have the same number of elements as there are spatial dimensions. The order of values is the same as in the tensor: depth (for 3D tensors), height (for 3D and 2D tensors), and width. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - aengine - Engine to use. * - aalgorithm - Deconvolution algorithm. Possible values are :ref:`dnnl::algorithm::deconvolution_direct `, and :ref:`dnnl::algorithm::deconvolution_winograd `. * - src_desc - Source memory descriptor. * - diff_weights_desc - Diff weights memory descriptor. * - diff_bias_desc - Diff bias memory descriptor. Passing zero memory descriptor disables the bias term. * - diff_dst_desc - Diff destination memory descriptor. * - strides - Strides for each spatial dimension. * - dilates - Dilations for each spatial dimension. A zero value means no dilation in the corresponding dimension. * - padding_l - Vector of padding values for low indices for each spatial dimension ``([[front,] top,] left)``. * - padding_r - Vector of padding values for high indices for each spatial dimension ``([[back,] bottom,] right)``. * - hint_fwd_pd - Primitive descriptor for a deconvolution forward propagation primitive. It is used as a hint for deciding which memory format to use. * - attr - Primitive attributes to use. Attributes are optional and default to empty attributes. * - 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_1deconvolution__backward__weights_1_1primitive__desc_1a70855904b49b4e44987294f8c298430f: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`engine`& aengine, :ref:`algorithm` aalgorithm, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& diff_weights_desc, const :ref:`memory::desc`& diff_dst_desc, const :ref:`memory::dims`& strides, const :ref:`memory::dims`& dilates, const :ref:`memory::dims`& padding_l, const :ref:`memory::dims`& padding_r, const :ref:`deconvolution_forward::primitive_desc`& hint_fwd_pd, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ) Constructs a primitive descriptor for a deconvolution weights gradient primitive without bias. .. note:: All the memory descriptors may be initialized with the :ref:`dnnl::memory::format_tag::any ` value of ``format_tag``. Arrays ``strides``, ``dilates``, ``padding_l``, and ``padding_r`` contain values for spatial dimensions only and hence must have the same number of elements as there are spatial dimensions. The order of values is the same as in the tensor: depth (for 3D tensors), height (for 3D and 2D tensors), and width. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - aengine - Engine to use. * - aalgorithm - Deconvolution algorithm. Possible values are :ref:`dnnl::algorithm::deconvolution_direct `, and :ref:`dnnl::algorithm::deconvolution_winograd `. * - src_desc - Source memory descriptor. * - diff_weights_desc - Diff weights memory descriptor. * - diff_dst_desc - Diff destination memory descriptor. * - strides - Strides for each spatial dimension. * - dilates - Dilations for each spatial dimension. A zero value means no dilation in the corresponding dimension. * - padding_l - Vector of padding values for low indices for each spatial dimension ``([[front,] top,] left)``. * - padding_r - Vector of padding values for high indices for each spatial dimension ``([[back,] bottom,] right)``. * - hint_fwd_pd - Primitive descriptor for a deconvolution forward propagation primitive. It is used as a hint for deciding which memory format to use. * - attr - Primitive attributes to use. Attributes are optional and default to empty attributes. * - 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_1deconvolution__backward__weights_1_1primitive__desc_1a668d19c88fddcbb7177b4d03fab91221: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc(:ref:`dnnl_primitive_desc_t` pd) Constructs a primitive descriptor for a deconvolution weights gradient 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 deconvolution weights gradient primitive. Methods ------- .. index:: pair: function; src_desc .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1a13f1b17ca1e1f075a651aec178debf1d: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` src_desc() const Returns a source memory descriptor. .. rubric:: Returns: Source memory descriptor. A zero memory descriptor if the primitive does not have a source parameter. .. index:: pair: function; diff_weights_desc .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1ab3c99b817600f5f19c8afcdd2d7fd33f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_weights_desc() const Returns a diff weights memory descriptor. .. rubric:: Returns: Diff weights memory descriptor. A zero memory descriptor if the primitive does not have a diff weights parameter. .. index:: pair: function; diff_dst_desc .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1a5810b82227869be298ff32cd56cd3903: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_dst_desc() const Returns a diff destination memory descriptor. .. rubric:: Returns: Diff destination memory descriptor. A zero memory descriptor if the primitive does not have a diff destination parameter. .. index:: pair: function; diff_bias_desc .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1ac9ff86e573a1ba31c270265ae84a623b: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` diff_bias_desc() const Returns the diff bias memory descriptor. .. rubric:: Returns: The diff bias memory descriptor. A zero memory descriptor of the primitive does not have a diff bias parameter. .. index:: pair: function; get_algorithm .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1a06430d5d01ad9257479b3f3aec6152f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`algorithm` get_algorithm() const Returns an algorithm kind. .. rubric:: Returns: An algorithm kind. :ref:`dnnl::algorithm::undef ` if the primitive does not have an algorithm parameter. .. index:: pair: function; get_prop_kind .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1a2cda30dd9eb495b499e1f401b1adcd20: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`prop_kind` get_prop_kind() const Returns a propagation kind. .. rubric:: Returns: A propagation kind. :ref:`dnnl::prop_kind::undef ` if the primitive does not have a propagation parameter. .. index:: pair: function; get_strides .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1aa2b4646f8a7cd51345a2fce33b7c13cf: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::dims` get_strides() const Returns strides. .. rubric:: Returns: Strides. An empty :ref:`dnnl::memory::dims ` if the primitive does not have a strides parameter. .. index:: pair: function; get_dilations .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1a621bcf8c95063e3ed761c886b669c5f9: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::dims` get_dilations() const Returns dilations. .. rubric:: Returns: Dilations. An empty :ref:`dnnl::memory::dims ` if the primitive does not have a dilations parameter. .. index:: pair: function; get_padding_l .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1ac143633ebaf1438fe8f42fddf9b1aa33: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::dims` get_padding_l() const Returns a left padding. .. rubric:: Returns: A left padding. An empty :ref:`dnnl::memory::dims ` if the primitive does not have a left padding parameter. .. index:: pair: function; get_padding_r .. _doxid-structdnnl_1_1deconvolution__backward__weights_1_1primitive__desc_1a33dcaaf236023bd0e56f4bcc015117d5: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::dims` get_padding_r() const Returns a right padding. .. rubric:: Returns: A right padding. An empty :ref:`dnnl::memory::dims ` if the primitive does not have a right padding parameter.