.. index:: pair: enum; dnnl_format_kind_t
.. _doxid-group__dnnl__api__memory_1gaa75cad747fa467d9dc527d943ba3367d:

enum dnnl_format_kind_t
=======================

Overview
~~~~~~~~

Memory format kind. :ref:`More...<details-group__dnnl__api__memory_1gaa75cad747fa467d9dc527d943ba3367d>`

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

	#include <dnnl_types.h>

	enum dnnl_format_kind_t
	{
	    :ref:`dnnl_format_kind_undef<doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367dac86d377bba856ea7aa9679ecf65c8364>`      = 0,
	    :ref:`dnnl_format_kind_any<doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367da77ae35388e04dc3e98d90675a7110c83>`,
	    :ref:`dnnl_blocked<doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367da30498f5adbc7d8017979a2201725ff16>`,
	    :ref:`dnnl_format_kind_wino<doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367da63f2a3abc24051939054b8a93f413f7a>`,
	    :ref:`dnnl_format_kind_rnn_packed<doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367dae5b6de34bb827e55ebae58904dd2953b>`,
	};

.. _details-group__dnnl__api__memory_1gaa75cad747fa467d9dc527d943ba3367d:

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

Memory format kind.

Enum Values
-----------

.. index:: pair: enumvalue; dnnl_format_kind_undef
.. _doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367dac86d377bba856ea7aa9679ecf65c8364:

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

	dnnl_format_kind_undef

Undefined memory format kind, used for empty memory descriptors.

.. index:: pair: enumvalue; dnnl_format_kind_any
.. _doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367da77ae35388e04dc3e98d90675a7110c83:

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

	dnnl_format_kind_any

Unspecified format kind.

The primitive selects a format automatically.

.. index:: pair: enumvalue; dnnl_blocked
.. _doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367da30498f5adbc7d8017979a2201725ff16:

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

	dnnl_blocked

A tensor in a generic format described by the stride and blocking values in each dimension.

See :ref:`dnnl_blocking_desc_t <doxid-structdnnl__blocking__desc__t>` for more information.

.. index:: pair: enumvalue; dnnl_format_kind_wino
.. _doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367da63f2a3abc24051939054b8a93f413f7a:

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

	dnnl_format_kind_wino

Weights format used in 8bit Winograd convolution.

.. index:: pair: enumvalue; dnnl_format_kind_rnn_packed
.. _doxid-group__dnnl__api__memory_1ggaa75cad747fa467d9dc527d943ba3367dae5b6de34bb827e55ebae58904dd2953b:

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

	dnnl_format_kind_rnn_packed

Packed weights format used in RNN.