mkldnn.hpp File Reference

C++ API. More...

#include "mkldnn_config.h"

Go to the source code of this file.

Classes
struct	mkldnn::error
	Intel(R) MKL-DNN exception class. More...
class	mkldnn::handle_traits< T >
	A class that provides the destructor for an Intel(R) MKL-DNN C handle. More...
class	mkldnn::handle< T, traits >
	A class for wrapping an Intel(R) MKL-DNN handle. More...
class	mkldnn::primitive
	Base class for all computational primitives. More...
struct	mkldnn::post_ops
	Post operations. More...
struct	mkldnn::primitive_attr
	Primitive attributes. More...
struct	mkldnn::engine
	An execution engine. More...
struct	mkldnn::stream
	An execution stream. More...
struct	mkldnn::memory
	Memory that describes the data. More...
struct	mkldnn::memory::desc
	A memory descriptor. More...
struct	mkldnn::reorder
	Initializes a reorder primitive using the description of the source (src_engine and src_md) and destination (dst_engine and dst_md) memory, and an attr attribute. More...
struct	mkldnn::concat
	Implements primitive descriptor and primitive for concat. More...
struct	mkldnn::sum
	Creates an out-of-place sum primitive descriptor for sum of n inputs multiplied by the scale with resulting output_desc memory descriptor. More...
struct	mkldnn::primitive_desc
	A base class for all primitive descriptors. More...
struct	mkldnn::convolution_forward
	Convolution forward propagation. More...
struct	mkldnn::convolution_forward::desc
	Descriptor for convolution forward propagation. More...
struct	mkldnn::convolution_forward::primitive_desc
	Primitive descriptor for convolution forward propagation. More...
struct	mkldnn::convolution_backward_data
	Convolution backward propagation. More...
struct	mkldnn::convolution_backward_data::desc
	Descriptor for convolution backward propagation. More...
struct	mkldnn::convolution_backward_data::primitive_desc
	Primitive descriptor for convolution backward propagation. More...
struct	mkldnn::convolution_backward_weights
	Convolution weight update. More...
struct	mkldnn::convolution_backward_weights::desc
	Descriptor for convolution weight update. More...
struct	mkldnn::convolution_backward_weights::primitive_desc
	Primitive descriptor for convolution weight update. More...
struct	mkldnn::deconvolution_forward
	Deconvolution forward propagation. More...
struct	mkldnn::deconvolution_forward::desc
	Descriptor for convolution forward propagation. More...
struct	mkldnn::deconvolution_forward::primitive_desc
	Primitive descriptor for deconvolution forward propagation. More...
struct	mkldnn::deconvolution_backward_data
	Deconvolution backward propagation. More...
struct	mkldnn::deconvolution_backward_data::desc
	Descriptor for deconvolution backward propagation. More...
struct	mkldnn::deconvolution_backward_data::primitive_desc
	Primitive descriptor for deconvolution backward propagation. More...
struct	mkldnn::deconvolution_backward_weights
	Deconvolution weight update. More...
struct	mkldnn::deconvolution_backward_weights::desc
	Descriptor for deconvolution weight update. More...
struct	mkldnn::deconvolution_backward_weights::primitive_desc
	Primitive descriptor for deconvolution weight update. More...
struct	mkldnn::lrn_forward
	Local response normalization for forward propagation. More...
struct	mkldnn::lrn_forward::desc
	Descriptor for local response normalization forward propagation. More...
struct	mkldnn::lrn_forward::primitive_desc
	Primitive descriptor for local response normalization forward propagation. More...
struct	mkldnn::lrn_backward
	Local response normalization for backward propagation. More...
struct	mkldnn::lrn_backward::desc
	Descriptor for local response normalization backward propagation. More...
struct	mkldnn::lrn_backward::primitive_desc
	Primitive descriptor for local response normalization backward propagation. More...
struct	mkldnn::pooling_forward
	Pooling for forward propagation. More...
struct	mkldnn::pooling_forward::desc
	Descriptor for pooling forward propagation. More...
struct	mkldnn::pooling_forward::primitive_desc
	Primitive descriptor for pooling forward propagation. More...
struct	mkldnn::pooling_backward::desc
	Descriptor for pooling backward propagation. More...
struct	mkldnn::pooling_backward::primitive_desc
	Primitive descriptor for pooling backward propagation. More...
struct	mkldnn::eltwise_forward
	Element-wise operations for forward propagation. More...
struct	mkldnn::eltwise_forward::desc
	Initializes an eltwise descriptor for forward propagation using prop_kind (possible values are mkldnn::forward_training and mkldnn::forward_inference), aalgorithm algorithm, memory descriptor data_desc, alpha, and beta parameters. More...
struct	mkldnn::eltwise_forward::primitive_desc
	Primitive descriptor for eltwise forward propagation. More...
struct	mkldnn::eltwise_backward
	Element-wise operations for backward propagation. More...
struct	mkldnn::eltwise_backward::desc
	Initializes an eltwise descriptor for backward propagation using aalgorithm algorithm memory descriptors diff_data_desc and data_desc, and the alpha and beta parameters. More...
struct	mkldnn::eltwise_backward::primitive_desc
	Primitive descriptor for eltwise backward propagation. More...
struct	mkldnn::softmax_forward
	Softmax for forward propagation. More...
struct	mkldnn::softmax_forward::desc
	Descriptor for softmax forward propagation. More...
struct	mkldnn::softmax_forward::primitive_desc
	Primitive descriptor for softmax forward propagation. More...
struct	mkldnn::softmax_backward
	Softmax for backward propagation. More...
struct	mkldnn::softmax_backward::desc
	Descriptor for softmax backward propagation. More...
struct	mkldnn::softmax_backward::primitive_desc
	Primitive descriptor for softmax backward propagation. More...
struct	mkldnn::batch_normalization_forward
	Batch normalization for forward propagation. More...
struct	mkldnn::batch_normalization_forward::desc
	Descriptor for batch normalization forward propagation. More...
struct	mkldnn::batch_normalization_forward::primitive_desc
	Primitive descriptor for batch normalization forward propagation. More...
struct	mkldnn::batch_normalization_backward
	Batch normalization backward propagation. More...
struct	mkldnn::batch_normalization_backward::desc
	Descriptor for batch normalization backward propagation. More...
struct	mkldnn::batch_normalization_backward::primitive_desc
	Primitive descriptor for batch normalization backward propagation. More...
struct	mkldnn::inner_product_forward
	Inner product for forward propagation. More...
struct	mkldnn::inner_product_forward::desc
	Initializes an inner product descriptor for forward propagation using prop_kind (possible values are mkldnn::prop_kind::forward_training and mkldnn::prop_kind::forward_inference) and memory descriptors. More...
struct	mkldnn::inner_product_forward::primitive_desc
	Primitive descriptor for inner product forward propagation. More...
struct	mkldnn::inner_product_backward_data
	Inner product for backward propagation with respect to data. More...
struct	mkldnn::inner_product_backward_data::desc
	Initializes an inner product descriptor for backward propagation with respect to data using memory descriptors. More...
struct	mkldnn::inner_product_backward_data::primitive_desc
	Primitive descriptor for inner product backward propagation with respect to data. More...
struct	mkldnn::inner_product_backward_weights
	Inner product for backward propagation with respect to weights. More...
struct	mkldnn::inner_product_backward_weights::desc
	Initializes an inner product descriptor for backward propagation with respect to weights using memory descriptors. More...
struct	mkldnn::inner_product_backward_weights::primitive_desc
	Primitive descriptor for inner product backward propagation with respect to weights. More...
struct	mkldnn::vanilla_rnn_forward
	Vanilla RNN for forward propagation. More...
struct	mkldnn::vanilla_rnn_forward::desc
	Descriptor for RNN forward propagation. More...
struct	mkldnn::vanilla_rnn_forward::primitive_desc
	Primitive descriptor for RNN forward propagation. More...
struct	mkldnn::vanilla_rnn_backward
	Vanilla RNN for backward propagation. More...
struct	mkldnn::vanilla_rnn_backward::desc
	RNN descriptor for backward propagation. More...
struct	mkldnn::vanilla_rnn_backward::primitive_desc
	Primitive descriptor for RNN backward propagation. More...
struct	mkldnn::lstm_forward
	LSTM for forward propagation. More...
struct	mkldnn::lstm_forward::desc
	Descriptor for LSTM forward propagation. More...
struct	mkldnn::lstm_forward::primitive_desc
	Primitive descriptor for LSTM forward propagation. More...
struct	mkldnn::lstm_backward
	LSTM for backward propagation. More...
struct	mkldnn::lstm_backward::desc
	LSTM descriptor for backward propagation. More...
struct	mkldnn::lstm_backward::primitive_desc
	Primitive descriptor for LSTM backward propagation. More...
struct	mkldnn::gru_forward
	GRU for forward propagation. More...
struct	mkldnn::gru_forward::desc
	Descriptor for GRU forward propagation. More...
struct	mkldnn::gru_forward::primitive_desc
	Primitive descriptor for GRU forward propagation. More...
struct	mkldnn::gru_backward
	GRU for backward propagation. More...
struct	mkldnn::gru_backward::desc
	GRU descriptor for backward propagation. More...
struct	mkldnn::gru_backward::primitive_desc
	Primitive descriptor for GRU backward propagation. More...
struct	mkldnn::lbr_gru_forward
	LBR_GRU for forward propagation. More...
struct	mkldnn::lbr_gru_forward::desc
	Descriptor for LBR GRU forward propagation. More...
struct	mkldnn::lbr_gru_forward::primitive_desc
	Primitive descriptor for LBR_GRU forward propagation. More...
struct	mkldnn::lbr_gru_backward
	LBR_GRU for backward propagation. More...
struct	mkldnn::lbr_gru_backward::desc
	LBR_GRU descriptor for backward propagation. More...
struct	mkldnn::lbr_gru_backward::primitive_desc
	Primitive descriptor for LBR_GRU backward propagation. More...
struct	mkldnn::shuffle_forward
	Shuffle for forward propagation. More...
struct	mkldnn::shuffle_forward::desc
	Descriptor for shuffle forward propagation. More...
struct	mkldnn::shuffle_forward::primitive_desc
	Primitive descriptor for shuffle forward propagation. More...
struct	mkldnn::shuffle_backward
	Shuffle for backward propagation. More...

Enumerations
enum	mkldnn::scratchpad_mode { mkldnn::scratchpad_mode::library = mkldnn_scratchpad_mode_library, mkldnn::scratchpad_mode::user = mkldnn_scratchpad_mode_user }
	Scratchpad mode. More...
enum	mkldnn::prop_kind {   mkldnn::prop_kind::forward_training = mkldnn_forward_training, mkldnn::prop_kind::forward_inference = mkldnn_forward_inference, mkldnn::prop_kind::forward_scoring = mkldnn_forward_scoring, mkldnn::prop_kind::forward = mkldnn_forward,   mkldnn::prop_kind::backward = mkldnn_backward, mkldnn::prop_kind::backward_data = mkldnn_backward_data, mkldnn::prop_kind::backward_weights = mkldnn_backward_weights, mkldnn::prop_kind::backward_bias = mkldnn_backward_bias }
	Propagation kind. More...
enum	mkldnn::algorithm { ,   mkldnn::algorithm::convolution_auto = mkldnn_convolution_auto, mkldnn::algorithm::convolution_direct = mkldnn_convolution_direct, mkldnn::algorithm::convolution_winograd = mkldnn_convolution_winograd, mkldnn::algorithm::deconvolution_direct = mkldnn_deconvolution_direct,   mkldnn::algorithm::deconvolution_winograd = mkldnn_deconvolution_winograd, mkldnn::algorithm::eltwise_relu = mkldnn_eltwise_relu, mkldnn::algorithm::eltwise_tanh = mkldnn_eltwise_tanh, mkldnn::algorithm::eltwise_elu = mkldnn_eltwise_elu,   mkldnn::algorithm::eltwise_square = mkldnn_eltwise_square, mkldnn::algorithm::eltwise_abs = mkldnn_eltwise_abs, mkldnn::algorithm::eltwise_sqrt = mkldnn_eltwise_sqrt, mkldnn::algorithm::eltwise_linear = mkldnn_eltwise_linear,   mkldnn::algorithm::eltwise_bounded_relu = mkldnn_eltwise_bounded_relu, mkldnn::algorithm::eltwise_soft_relu = mkldnn_eltwise_soft_relu, mkldnn::algorithm::eltwise_logistic = mkldnn_eltwise_logistic, mkldnn::algorithm::eltwise_exp = mkldnn_eltwise_exp,   mkldnn::algorithm::eltwise_gelu = mkldnn_eltwise_gelu, mkldnn::algorithm::lrn_across_channels = mkldnn_lrn_across_channels, mkldnn::algorithm::lrn_within_channel = mkldnn_lrn_within_channel, mkldnn::algorithm::pooling_max = mkldnn_pooling_max,   mkldnn::algorithm::pooling_avg = mkldnn_pooling_avg, mkldnn::algorithm::pooling_avg_include_padding = mkldnn_pooling_avg_include_padding, mkldnn::algorithm::pooling_avg_exclude_padding = mkldnn_pooling_avg_exclude_padding, mkldnn::algorithm::vanilla_rnn = mkldnn_vanilla_rnn,   mkldnn::algorithm::vanilla_lstm = mkldnn_vanilla_lstm, mkldnn::algorithm::vanilla_gru = mkldnn_vanilla_gru, mkldnn::algorithm::lbr_gru = mkldnn_lbr_gru }
	Kinds of algorithms. More...
enum	mkldnn::normalization_flags : unsigned { mkldnn::normalization_flags::use_global_stats = mkldnn_use_global_stats, mkldnn::normalization_flags::use_scale_shift = mkldnn_use_scaleshift, mkldnn::normalization_flags::fuse_norm_relu = mkldnn_fuse_norm_relu }
	Flags for batch normalization primitive. More...
enum	mkldnn::query {   mkldnn::query::undef = mkldnn_query_undef, mkldnn::query::engine = mkldnn_query_engine, mkldnn::query::primitive_kind = mkldnn_query_primitive_kind, mkldnn::query::num_of_inputs_s32 = mkldnn_query_num_of_inputs_s32,   mkldnn::query::num_of_outputs_s32 = mkldnn_query_num_of_outputs_s32, mkldnn::query::time_estimate_f64 = mkldnn_query_time_estimate_f64, mkldnn::query::memory_consumption_s64 = mkldnn_query_memory_consumption_s64, mkldnn::query::scratchpad_engine = mkldnn_query_scratchpad_engine,   mkldnn::query::impl_info_str = mkldnn_query_impl_info_str, mkldnn::query::op_d = mkldnn_query_op_d, mkldnn::query::convolution_d = mkldnn_query_convolution_d, mkldnn::query::deconvolution_d = mkldnn_query_deconvolution_d,   mkldnn::query::shuffle_d = mkldnn_query_shuffle_d, mkldnn::query::eltwise_d = mkldnn_query_eltwise_d, mkldnn::query::softmax_d = mkldnn_query_softmax_d, mkldnn::query::pooling_d = mkldnn_query_pooling_d,   mkldnn::query::lrn_d = mkldnn_query_lrn_d, mkldnn::query::batch_normalization_d = mkldnn_query_batch_normalization_d, mkldnn::query::inner_product_d = mkldnn_query_inner_product_d, mkldnn::query::rnn_d = mkldnn_query_rnn_d,   mkldnn::query::src_md = mkldnn_query_src_md, mkldnn::query::diff_src_md = mkldnn_query_diff_src_md, mkldnn::query::weights_md = mkldnn_query_weights_md, mkldnn::query::diff_weights_md = mkldnn_query_diff_weights_md,   mkldnn::query::dst_md = mkldnn_query_dst_md, mkldnn::query::diff_dst_md = mkldnn_query_diff_dst_md, mkldnn::query::workspace_md = mkldnn_query_workspace_md, mkldnn::query::scratchpad_md = mkldnn_query_scratchpad_md }
	Primitive descriptor query specification. More...

Detailed Description

C++ API.