Intel(R) Math Kernel Library for Deep Neural Networks (Intel(R) MKL-DNN)  0.13
Performance library for Deep Learning
Classes | Macros | Typedefs | Enumerations
mkldnn_types.h File Reference

Go to the source code of this file.

Classes

struct  mkldnn_blocking_desc_t
 Generic description of blocked data layout for most memory formats. More...
 
struct  mkldnn_memory_desc_t
 Memory descriptor. More...
 
struct  mkldnn_convolution_desc_t
 A descriptor of a convolution operation. More...
 
struct  mkldnn_eltwise_desc_t
 A descriptor of a element-wise operation. More...
 
struct  mkldnn_softmax_desc_t
 A descriptor of a Softmax operation. More...
 
struct  mkldnn_pooling_desc_t
 A descriptor of a pooling operation. More...
 
struct  mkldnn_lrn_desc_t
 A descriptor of a Local Response Normalization (LRN) operation. More...
 
struct  mkldnn_batch_normalization_desc_t
 A descriptor of a Batch Normalization operation. More...
 
struct  mkldnn_inner_product_desc_t
 A descriptor of an inner product operation. More...
 
struct  mkldnn_convolution_relu_desc_t
 A descriptor of a convolution followed by relu operation. More...
 
struct  mkldnn_primitive_at_t
 A wrapper structure to specify a particular output of a primitive. More...
 

Macros

#define TENSOR_MAX_DIMS   12
 Maximum number of dimensions a tensor can have. More...
 

Typedefs

typedef int mkldnn_dims_t[TENSOR_MAX_DIMS]
 A type to describe tensor dimensions. More...
 
typedef ptrdiff_t mkldnn_strides_t[TENSOR_MAX_DIMS]
 A type to describe strides within a tensor. More...
 
typedef void * mkldnn_op_desc_t
 A pointer to any of the operation descriptors. More...
 
typedef const void * const_mkldnn_op_desc_t
 A pointer to any of the operation descriptors (constant variant). More...
 
typedef mkldnn_eltwise_desc_t mkldnn_relu_desc_t
 
typedef struct mkldnn_enginemkldnn_engine_t
 An engine handle. More...
 
typedef struct mkldnn_primitive_desc_iteratormkldnn_primitive_desc_iterator_t
 A primitive descriptor iterator handle. More...
 
typedef const struct mkldnn_primitive_desc_iteratorconst_mkldnn_primitive_desc_iterator_t
 A constant primitive descriptor iterator handle. More...
 
typedef struct mkldnn_primitive_descmkldnn_primitive_desc_t
 A primitive descriptor handle. More...
 
typedef const struct mkldnn_primitive_descconst_mkldnn_primitive_desc_t
 A constant primitive descriptor handle. More...
 
typedef struct mkldnn_primitive_attrmkldnn_primitive_attr_t
 A primitive descriptor attributes handle that controls primitive behavior. More...
 
typedef const struct mkldnn_primitive_attrconst_mkldnn_primitive_attr_t
 A constant primitive descriptor attributes handle. More...
 
typedef struct mkldnn_post_opsmkldnn_post_ops_t
 A post operation chain handle. More...
 
typedef const struct mkldnn_post_opsconst_mkldnn_post_ops_t
 A constant post operation chain handle. More...
 
typedef struct mkldnn_primitivemkldnn_primitive_t
 A primitive handle. More...
 
typedef const struct mkldnn_primitiveconst_mkldnn_primitive_t
 A constant primitive handle. More...
 
typedef struct mkldnn_streammkldnn_stream_t
 An execution stream handle. More...
 
typedef const struct mkldnn_streamconst_mkldnn_stream_t
 A constant execution stream handle. More...
 

Enumerations

enum  mkldnn_status_t {
  mkldnn_success = 0, mkldnn_out_of_memory = 1, mkldnn_try_again = 2, mkldnn_invalid_arguments = 3,
  mkldnn_not_ready = 4, mkldnn_unimplemented = 5, mkldnn_iterator_ends = 6, mkldnn_runtime_error = 7,
  mkldnn_not_required = 8
}
 Status values returned by Intel(R) MKL-DNN functions. More...
 
enum  mkldnn_data_type_t {
  mkldnn_data_type_undef = 0, mkldnn_f32 = 1, mkldnn_s32 = 2, mkldnn_s16 = 4,
  mkldnn_s8 = 5, mkldnn_u8 = 6
}
 Data type specification. More...
 
enum  mkldnn_round_mode_t { mkldnn_round_nearest = 1, mkldnn_round_down = 2 }
 Rounding mode. More...
 
enum  mkldnn_memory_format_t {
  mkldnn_format_undef = 0, mkldnn_any, mkldnn_blocked, mkldnn_x,
  mkldnn_nc, mkldnn_nchw, mkldnn_nhwc, mkldnn_chwn,
  mkldnn_nChw8c, mkldnn_nChw16c, mkldnn_oi, mkldnn_io,
  mkldnn_oihw, mkldnn_ihwo, mkldnn_hwio, mkldnn_OIhw8i8o,
  mkldnn_OIhw16i16o, mkldnn_OIhw4i16o4i, mkldnn_OIhw8i16o2i, mkldnn_OIhw8o16i2o,
  mkldnn_OIhw8o8i, mkldnn_OIhw16o16i, mkldnn_IOhw16o16i, mkldnn_Oihw8o,
  mkldnn_Oihw16o, mkldnn_Ohwi8o, mkldnn_Ohwi16o, mkldnn_OhIw16o4i,
  mkldnn_goihw, mkldnn_hwigo, mkldnn_gOIhw8i8o, mkldnn_gOIhw16i16o,
  mkldnn_gOIhw4i16o4i, mkldnn_gOIhw8i16o2i, mkldnn_gOIhw8o16i2o, mkldnn_gOIhw8o8i,
  mkldnn_gOIhw16o16i, mkldnn_gIOhw16o16i, mkldnn_gOihw8o, mkldnn_gOihw16o,
  mkldnn_gOhwi8o, mkldnn_gOhwi16o, mkldnn_Goihw8g, mkldnn_gOhIw16o4i,
  mkldnn_oIhw8i = mkldnn_nChw8c, mkldnn_oIhw16i = mkldnn_nChw16c
}
 Memory format specification. More...
 
enum  mkldnn_padding_kind_t { mkldnn_padding_zero }
 Kinds of padding. More...
 
enum  mkldnn_prop_kind_t {
  mkldnn_prop_kind_undef = 0, mkldnn_forward_training = 64, mkldnn_forward_inference = 96, mkldnn_forward_scoring = mkldnn_forward_inference,
  mkldnn_forward = mkldnn_forward_training, mkldnn_backward = 128, mkldnn_backward_data = 160, mkldnn_backward_weights = 192,
  mkldnn_backward_bias = 193
}
 Kinds of propagation. More...
 
enum  mkldnn_primitive_kind_t {
  mkldnn_undefined_primitive, mkldnn_memory, mkldnn_view, mkldnn_reorder,
  mkldnn_concat, mkldnn_concat_inplace, mkldnn_sum, mkldnn_convolution,
  mkldnn_eltwise, mkldnn_relu = mkldnn_eltwise, mkldnn_softmax, mkldnn_pooling,
  mkldnn_lrn, mkldnn_batch_normalization, mkldnn_inner_product, mkldnn_convolution_relu
}
 Kinds of primitives. More...
 
enum  mkldnn_alg_kind_t {
  mkldnn_convolution_direct = 1, mkldnn_convolution_winograd = 2, mkldnn_eltwise_relu = 8, mkldnn_eltwise_tanh = 9,
  mkldnn_eltwise_elu = 10, mkldnn_eltwise_square = 11, mkldnn_eltwise_abs = 12, mkldnn_eltwise_sqrt = 13,
  mkldnn_eltwise_linear = 14, mkldnn_eltwise_bounded_relu = 15, mkldnn_eltwise_soft_relu = 16, mkldnn_eltwise_logistic = 17,
  mkldnn_pooling_max = 34, mkldnn_pooling_avg_include_padding = 40, mkldnn_pooling_avg_exclude_padding = 41, mkldnn_pooling_avg = mkldnn_pooling_avg_exclude_padding,
  mkldnn_lrn_across_channels = 65, mkldnn_lrn_within_channel = 66
}
 Kinds of algorithms. More...
 
enum  mkldnn_batch_normalization_flag_t { mkldnn_use_global_stats = 0x1U, mkldnn_use_scaleshift = 0x2U, mkldnn_omit_stats = mkldnn_use_global_stats, mkldnn_fuse_bn_relu = 0x4U }
 Flags for batch-normalization primititve. More...
 
enum  mkldnn_engine_kind_t { mkldnn_any_engine, mkldnn_cpu }
 Kinds of engines. More...
 
enum  mkldnn_query_t {
  mkldnn_query_undef = 0, mkldnn_query_engine, mkldnn_query_primitive_kind, mkldnn_query_num_of_inputs_s32,
  mkldnn_query_num_of_outputs_s32, mkldnn_query_time_estimate_f64, mkldnn_query_memory_consumption_s64, mkldnn_query_impl_info_str,
  mkldnn_query_some_d = 64, mkldnn_query_memory_d, mkldnn_query_convolution_d, mkldnn_query_eltwise_d,
  mkldnn_query_relu_d = mkldnn_query_eltwise_d, mkldnn_query_softmax_d, mkldnn_query_pooling_d, mkldnn_query_lrn_d,
  mkldnn_query_batch_normalization_d, mkldnn_query_inner_product_d, mkldnn_query_convolution_relu_d, mkldnn_query_some_pd = 128,
  mkldnn_query_input_pd, mkldnn_query_output_pd, mkldnn_query_src_pd, mkldnn_query_diff_src_pd,
  mkldnn_query_weights_pd, mkldnn_query_diff_weights_pd, mkldnn_query_dst_pd, mkldnn_query_diff_dst_pd,
  mkldnn_query_workspace_pd
}
 Primitive descriptor query specification. More...
 
enum  mkldnn_stream_kind_t { mkldnn_any_stream, mkldnn_eager, mkldnn_lazy }
 Kinds of streams. More...