.. index:: pair: group; LRN
.. _doxid-group__dnnl__api__lrn:

LRN
===

.. toctree::
	:hidden:

	struct_dnnl_lrn_desc_t.rst
	struct_dnnl_lrn_backward.rst
	struct_dnnl_lrn_forward.rst

Overview
~~~~~~~~

A primitive to perform local response normalization (LRN) across or within channels. :ref:`More...<details-group__dnnl__api__lrn>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	
	// structs

	struct :ref:`dnnl_lrn_desc_t<doxid-structdnnl__lrn__desc__t>`;
	struct :ref:`dnnl::lrn_backward<doxid-structdnnl_1_1lrn__backward>`;
	struct :ref:`dnnl::lrn_forward<doxid-structdnnl_1_1lrn__forward>`;

	// global functions

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API :ref:`dnnl_lrn_forward_desc_init<doxid-group__dnnl__api__lrn_1gae124b34228f8c5adffc7733bccbf5658>`(
		:ref:`dnnl_lrn_desc_t<doxid-structdnnl__lrn__desc__t>`* lrn_desc,
		:ref:`dnnl_prop_kind_t<doxid-group__dnnl__api__primitives__common_1gae3c1f22ae55645782923fbfd8b07d0c4>` prop_kind,
		:ref:`dnnl_alg_kind_t<doxid-group__dnnl__api__primitives__common_1ga96946c805f6c4922c38c37049ab95d23>` alg_kind,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* data_desc,
		:ref:`dnnl_dim_t<doxid-group__dnnl__api__memory_1ga872631b12a112bf43fba985cba24dd20>` local_size,
		float alpha,
		float beta,
		float k
		);

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API :ref:`dnnl_lrn_backward_desc_init<doxid-group__dnnl__api__lrn_1ga954db731bb52e36319160967b29fa87f>`(
		:ref:`dnnl_lrn_desc_t<doxid-structdnnl__lrn__desc__t>`* lrn_desc,
		:ref:`dnnl_alg_kind_t<doxid-group__dnnl__api__primitives__common_1ga96946c805f6c4922c38c37049ab95d23>` alg_kind,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* diff_data_desc,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* data_desc,
		:ref:`dnnl_dim_t<doxid-group__dnnl__api__memory_1ga872631b12a112bf43fba985cba24dd20>` local_size,
		float alpha,
		float beta,
		float k
		);

.. _details-group__dnnl__api__lrn:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

A primitive to perform local response normalization (LRN) across or within channels.



.. rubric:: See also:

:ref:`Local Response Normalization (LRN) <doxid-dev_guide_lrn>` in developer guide

Global Functions
----------------

.. index:: pair: function; dnnl_lrn_forward_desc_init
.. _doxid-group__dnnl__api__lrn_1gae124b34228f8c5adffc7733bccbf5658:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API dnnl_lrn_forward_desc_init(
		:ref:`dnnl_lrn_desc_t<doxid-structdnnl__lrn__desc__t>`* lrn_desc,
		:ref:`dnnl_prop_kind_t<doxid-group__dnnl__api__primitives__common_1gae3c1f22ae55645782923fbfd8b07d0c4>` prop_kind,
		:ref:`dnnl_alg_kind_t<doxid-group__dnnl__api__primitives__common_1ga96946c805f6c4922c38c37049ab95d23>` alg_kind,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* data_desc,
		:ref:`dnnl_dim_t<doxid-group__dnnl__api__memory_1ga872631b12a112bf43fba985cba24dd20>` local_size,
		float alpha,
		float beta,
		float k
		)

Initializes a descriptor for LRN forward propagation primitive.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- lrn_desc

		- Output descriptor for a LRN primitive.

	*
		- prop_kind

		- Propagation kind. Possible values are :ref:`dnnl_forward_training <doxid-group__dnnl__api__primitives__common_1ggae3c1f22ae55645782923fbfd8b07d0c4a992e03bebfe623ac876b3636333bbce0>` and :ref:`dnnl_forward_inference <doxid-group__dnnl__api__primitives__common_1ggae3c1f22ae55645782923fbfd8b07d0c4a2f77a568a675dec649eb0450c997856d>`.

	*
		- alg_kind

		- LRN algorithm kind: either :ref:`dnnl_lrn_across_channels <doxid-group__dnnl__api__primitives__common_1gga96946c805f6c4922c38c37049ab95d23a540b116253bf1290b9536929198d18fd>` or :ref:`dnnl_lrn_within_channel <doxid-group__dnnl__api__primitives__common_1gga96946c805f6c4922c38c37049ab95d23a922fdd348b6a3e6bbe589025691d7171>`.

	*
		- data_desc

		- Source and destination memory descriptor.

	*
		- local_size

		- Regularization local size.

	*
		- alpha

		- The alpha regularization parameter.

	*
		- beta

		- The beta regularization parameter.

	*
		- k

		- The k regularization parameter.



.. rubric:: Returns:

:ref:`dnnl_success <doxid-group__dnnl__api__utils_1ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c>` on success and a status describing the error otherwise.

.. index:: pair: function; dnnl_lrn_backward_desc_init
.. _doxid-group__dnnl__api__lrn_1ga954db731bb52e36319160967b29fa87f:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API dnnl_lrn_backward_desc_init(
		:ref:`dnnl_lrn_desc_t<doxid-structdnnl__lrn__desc__t>`* lrn_desc,
		:ref:`dnnl_alg_kind_t<doxid-group__dnnl__api__primitives__common_1ga96946c805f6c4922c38c37049ab95d23>` alg_kind,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* diff_data_desc,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* data_desc,
		:ref:`dnnl_dim_t<doxid-group__dnnl__api__memory_1ga872631b12a112bf43fba985cba24dd20>` local_size,
		float alpha,
		float beta,
		float k
		)

Initializes a descriptor for LRN backward propagation primitive.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- lrn_desc

		- Output descriptor for a LRN primitive.

	*
		- alg_kind

		- LRN algorithm kind: either :ref:`dnnl_lrn_across_channels <doxid-group__dnnl__api__primitives__common_1gga96946c805f6c4922c38c37049ab95d23a540b116253bf1290b9536929198d18fd>` or :ref:`dnnl_lrn_within_channel <doxid-group__dnnl__api__primitives__common_1gga96946c805f6c4922c38c37049ab95d23a922fdd348b6a3e6bbe589025691d7171>`.

	*
		- diff_data_desc

		- Diff source and diff destination memory descriptor.

	*
		- data_desc

		- Source memory descriptor.

	*
		- local_size

		- Regularization local size.

	*
		- alpha

		- The alpha regularization parameter.

	*
		- beta

		- The beta regularization parameter.

	*
		- k

		- The k regularization parameter.



.. rubric:: Returns:

:ref:`dnnl_success <doxid-group__dnnl__api__utils_1ggad24f9ded06e34d3ee71e7fc4b408d57aaa31395e9dccc103cf166cf7b38fc5b9c>` on success and a status describing the error otherwise.