.. index:: pair: struct; dnnl::softmax_v2_forward::desc
.. _doxid-structdnnl_1_1softmax__v2__forward_1_1desc:

struct dnnl::softmax_v2_forward::desc
=====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Descriptor for a softmax forward propagation primitive. :ref:`More...<details-structdnnl_1_1softmax__v2__forward_1_1desc>`


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

	#include <dnnl.hpp>
	
	struct desc
	{
		// fields
	
		:ref:`dnnl_softmax_v2_desc_t<doxid-structdnnl__softmax__v2__desc__t>` :target:`data<doxid-structdnnl_1_1softmax__v2__forward_1_1desc_1ae9bf981577c5ec1f45ae24685db00c45>`;

		// construction
	
		:ref:`desc<doxid-structdnnl_1_1softmax__v2__forward_1_1desc_1a3392feac2284301408f9b34d30d6d29c>`();
	
		:ref:`desc<doxid-structdnnl_1_1softmax__v2__forward_1_1desc_1ae3c91ee70923fc43c6b83ce557bfa033>`(
			:ref:`prop_kind<doxid-group__dnnl__api__attributes_1gac7db48f6583aa9903e54c2a39d65438f>` aprop_kind,
			:ref:`algorithm<doxid-group__dnnl__api__attributes_1ga00377dd4982333e42e8ae1d09a309640>` aalgorithm,
			const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& src_desc,
			const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& dst_desc,
			int softmax_axis
			);
	};
.. _details-structdnnl_1_1softmax__v2__forward_1_1desc:

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

Descriptor for a softmax forward propagation primitive.

Construction
------------

.. index:: pair: function; desc
.. _doxid-structdnnl_1_1softmax__v2__forward_1_1desc_1a3392feac2284301408f9b34d30d6d29c:

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

	desc()

Default constructor. Produces an empty object.

.. index:: pair: function; desc
.. _doxid-structdnnl_1_1softmax__v2__forward_1_1desc_1ae3c91ee70923fc43c6b83ce557bfa033:

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

	desc(
		:ref:`prop_kind<doxid-group__dnnl__api__attributes_1gac7db48f6583aa9903e54c2a39d65438f>` aprop_kind,
		:ref:`algorithm<doxid-group__dnnl__api__attributes_1ga00377dd4982333e42e8ae1d09a309640>` aalgorithm,
		const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& src_desc,
		const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& dst_desc,
		int softmax_axis
		)

Constructs a descriptor for a softmax forward propagation primitive.



.. rubric:: Parameters:

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

	*
		- aprop_kind

		- Propagation kind. Possible values are :ref:`dnnl::prop_kind::forward_training <doxid-group__dnnl__api__attributes_1ggac7db48f6583aa9903e54c2a39d65438fa24775787fab8f13aa4809e1ce8f82aeb>`, and :ref:`dnnl::prop_kind::forward_inference <doxid-group__dnnl__api__attributes_1ggac7db48f6583aa9903e54c2a39d65438fa3b9fad4f80d45368f856b5403198ac4c>`.

	*
		- aalgorithm

		- Softmax algorithm kind: either :ref:`dnnl::algorithm::softmax_accurate <doxid-group__dnnl__api__attributes_1gga00377dd4982333e42e8ae1d09a309640a6aba07e95369523dbbb9cab366480dd4>`, or :ref:`dnnl::algorithm::softmax_log <doxid-group__dnnl__api__attributes_1gga00377dd4982333e42e8ae1d09a309640a0888321c22541f5d7094cf44bc261ec9>`.

	*
		- src_desc

		- Source memory descriptor.

	*
		- dst_desc

		- Destination memory descriptor.

	*
		- softmax_axis

		- Axis over which softmax is computed.