.. index:: pair: struct; dnnl::softmax_forward::desc
.. _doxid-structdnnl_1_1softmax__forward_1_1desc:

struct dnnl::softmax_forward::desc
==================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

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


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

	#include <dnnl.hpp>
	
	struct desc
	{
		// fields
	
		:ref:`dnnl_softmax_desc_t<doxid-structdnnl__softmax__desc__t>` :target:`data<doxid-structdnnl_1_1softmax__forward_1_1desc_1aee0d595713e38f81c7eeb87d38165857>`;

		// construction
	
		:ref:`desc<doxid-structdnnl_1_1softmax__forward_1_1desc_1ab9f8727afb4ea7555ae1cd718a091d9d>`();
		:ref:`desc<doxid-structdnnl_1_1softmax__forward_1_1desc_1ab573772b6fbaab68a2310f8238c4cce5>`(:ref:`prop_kind<doxid-group__dnnl__api__attributes_1gac7db48f6583aa9903e54c2a39d65438f>` aprop_kind, const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& data_desc, int softmax_axis);
	};
.. _details-structdnnl_1_1softmax__forward_1_1desc:

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

Descriptor for a softmax forward propagation primitive.

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

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

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

	desc()

Default constructor. Produces an empty object.

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

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

	desc(:ref:`prop_kind<doxid-group__dnnl__api__attributes_1gac7db48f6583aa9903e54c2a39d65438f>` aprop_kind, const :ref:`memory::desc<doxid-structdnnl_1_1memory_1_1desc>`& data_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>`.

	*
		- data_desc

		- Source and destination memory descriptor.

	*
		- softmax_axis

		- Axis over which softmax is computed.