.. index:: pair: group; Softmax
.. _doxid-group__dnnl__api__softmax:

Softmax
=======

.. toctree::
	:hidden:

	struct_dnnl_softmax_desc_t.rst
	struct_dnnl_softmax_backward.rst
	struct_dnnl_softmax_forward.rst

Overview
~~~~~~~~

A primitive to perform softmax. :ref:`More...<details-group__dnnl__api__softmax>`


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

	
	// structs

	struct :ref:`dnnl_softmax_desc_t<doxid-structdnnl__softmax__desc__t>`;
	struct :ref:`dnnl::softmax_backward<doxid-structdnnl_1_1softmax__backward>`;
	struct :ref:`dnnl::softmax_forward<doxid-structdnnl_1_1softmax__forward>`;

	// global functions

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API :ref:`dnnl_softmax_forward_desc_init<doxid-group__dnnl__api__softmax_1ga6cf7ee9ca39f755a982d82670a7d7bc5>`(
		:ref:`dnnl_softmax_desc_t<doxid-structdnnl__softmax__desc__t>`* softmax_desc,
		:ref:`dnnl_prop_kind_t<doxid-group__dnnl__api__primitives__common_1gae3c1f22ae55645782923fbfd8b07d0c4>` prop_kind,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* data_desc,
		int softmax_axis
		);

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API :ref:`dnnl_softmax_backward_desc_init<doxid-group__dnnl__api__softmax_1ga68baa791cd85c9e3ddd3dbc5889ba0ba>`(
		:ref:`dnnl_softmax_desc_t<doxid-structdnnl__softmax__desc__t>`* softmax_desc,
		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,
		int softmax_axis
		);

.. _details-group__dnnl__api__softmax:

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

A primitive to perform softmax.



.. rubric:: See also:

:ref:`Softmax <doxid-dev_guide_softmax>` in developer guide

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

.. index:: pair: function; dnnl_softmax_forward_desc_init
.. _doxid-group__dnnl__api__softmax_1ga6cf7ee9ca39f755a982d82670a7d7bc5:

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

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API dnnl_softmax_forward_desc_init(
		:ref:`dnnl_softmax_desc_t<doxid-structdnnl__softmax__desc__t>`* softmax_desc,
		:ref:`dnnl_prop_kind_t<doxid-group__dnnl__api__primitives__common_1gae3c1f22ae55645782923fbfd8b07d0c4>` prop_kind,
		const :ref:`dnnl_memory_desc_t<doxid-structdnnl__memory__desc__t>`* data_desc,
		int softmax_axis
		)

Initializes a descriptor for softmax forward propagation primitive.



.. rubric:: Parameters:

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

	*
		- softmax_desc

		- Output descriptor for a softmax 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>`.

	*
		- data_desc

		- Source and destination memory descriptor.

	*
		- softmax_axis

		- Axis over which softmax is computed.



.. rubric:: Returns:

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

.. index:: pair: function; dnnl_softmax_backward_desc_init
.. _doxid-group__dnnl__api__softmax_1ga68baa791cd85c9e3ddd3dbc5889ba0ba:

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

	:ref:`dnnl_status_t<doxid-group__dnnl__api__utils_1gad24f9ded06e34d3ee71e7fc4b408d57a>` DNNL_API dnnl_softmax_backward_desc_init(
		:ref:`dnnl_softmax_desc_t<doxid-structdnnl__softmax__desc__t>`* softmax_desc,
		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,
		int softmax_axis
		)

Initializes a descriptor for softmax backward propagation primitive.



.. rubric:: Parameters:

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

	*
		- softmax_desc

		- Output descriptor for a softmax primitive.

	*
		- diff_data_desc

		- Diff source and diff destination memory descriptors.

	*
		- data_desc

		- Destination memory descriptor.

	*
		- softmax_axis

		- Axis over which softmax is computed.



.. rubric:: Returns:

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