.. index:: pair: struct; dnnl::batch_normalization_forward::primitive_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc: struct dnnl::batch_normalization_forward::primitive_desc ======================================================== .. toctree:: :hidden: Overview ~~~~~~~~ Primitive descriptor for a batch normalization forward propagation 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:`prop_kind` aprop_kind, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& dst_desc, float epsilon, :ref:`normalization_flags` flags, 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:`dst_desc`() const; :ref:`memory::desc` :ref:`weights_desc`() const; :ref:`memory::desc` :ref:`workspace_desc`() const; :ref:`memory::desc` :ref:`mean_desc`() const; :ref:`memory::desc` :ref:`variance_desc`() const; :ref:`dnnl::prop_kind` :ref:`get_prop_kind`() const; float :ref:`get_epsilon`() const; :ref:`normalization_flags` :ref:`get_flags`() 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_1batch__normalization__forward_1_1primitive__desc: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Primitive descriptor for a batch normalization forward propagation primitive. Construction ------------ .. index:: pair: function; primitive_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a2401b0e5b03e2df1d027201e061ceacb: .. 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_1batch__normalization__forward_1_1primitive__desc_1aa9341c627110dc89cff8f265f6661334: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc( const :ref:`engine`& aengine, :ref:`prop_kind` aprop_kind, const :ref:`memory::desc`& src_desc, const :ref:`memory::desc`& dst_desc, float epsilon, :ref:`normalization_flags` flags, const :ref:`primitive_attr`& attr = :ref:`default_attr`(), bool allow_empty = false ) Constructs a primitive descriptor for a batch normalization forward propagation primitive. .. note:: In-place operation is supported: the dst can refer to the same memory as the src. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - aengine - Engine to use. * - aprop_kind - Propagation kind. Possible values are :ref:`dnnl::prop_kind::forward_training ` and :ref:`dnnl::prop_kind::forward_inference `. * - src_desc - Source memory descriptor. * - dst_desc - Destination memory descriptor. * - epsilon - Batch normalization epsilon parameter. * - flags - Batch normalization flags (:ref:`dnnl::normalization_flags `). * - 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_1batch__normalization__forward_1_1primitive__desc_1ae89505b5ad1b82cca5d8cbae56a1030c: .. ref-code-block:: cpp :class: doxyrest-title-code-block primitive_desc(:ref:`dnnl_primitive_desc_t` pd) Constructs a primitive descriptor for a batch normalization forward 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 batch normalization forward propagation primitive. Methods ------- .. index:: pair: function; src_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a106fc3376b5c0f5e67b0e92633600b9f: .. 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; dst_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1af669f0f68951673f4ceba14eb631b7fa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` dst_desc() const Returns a destination memory descriptor. .. rubric:: Returns: Destination memory descriptor. A zero memory descriptor if the primitive does not have a destination parameter. .. index:: pair: function; weights_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a33cc89eb552f12861e9e622a92986e50: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` weights_desc() const Returns a weights memory descriptor. .. rubric:: Returns: Weights memory descriptor. A zero memory descriptor if the primitive does not have a weights parameter. .. index:: pair: function; workspace_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a863e40b42e49a970b3c564709c3ce64f: .. 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; mean_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a4b5dd117d1f71776d8bff086c41ced41: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` mean_desc() const Returns memory descriptor for mean. .. rubric:: Returns: Memory descriptor for mean. .. index:: pair: function; variance_desc .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1add11ea349ccd74483990b612fc4b8f15: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`memory::desc` variance_desc() const Returns memory descriptor for variance. .. rubric:: Returns: Memory descriptor for variance. .. index:: pair: function; get_prop_kind .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a5bd5ef7c0ac93750839ae518f82a73f4: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`dnnl::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_epsilon .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1aa5d8d9977e60d4626812d6c447947096: .. ref-code-block:: cpp :class: doxyrest-title-code-block float get_epsilon() const Returns an epsilon. .. rubric:: Returns: An epsilon. Zero if the primitive does not have an epsilon parameter. .. index:: pair: function; get_flags .. _doxid-structdnnl_1_1batch__normalization__forward_1_1primitive__desc_1a34e8dda1b063565e85d14875077c512c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`normalization_flags` get_flags() const Returns normalization flags. .. rubric:: Returns: Normalization flags.