Intel(R) Math Kernel Library for Deep Neural Networks (Intel(R) MKL-DNN)  0.13
Performance library for Deep Learning
mkldnn.h
Go to the documentation of this file.
1 /*******************************************************************************
2 * Copyright 2016-2018 Intel Corporation
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *******************************************************************************/
16 
17 #ifndef MKLDNN_H
18 #define MKLDNN_H
19 
20 #ifndef DOXYGEN_SHOULD_SKIP_THIS
21 
22 /* All symbols shall be internal unless marked as MKLDNN_API */
23 #if defined _WIN32 || defined __CYGWIN__
24 # define MKLDNN_HELPER_DLL_IMPORT __declspec(dllimport)
25 # define MKLDNN_HELPER_DLL_EXPORT __declspec(dllexport)
26 #else
27 # if __GNUC__ >= 4
28 # define MKLDNN_HELPER_DLL_IMPORT __attribute__ ((visibility ("default")))
29 # define MKLDNN_HELPER_DLL_EXPORT __attribute__ ((visibility ("default")))
30 # else
31 # define MKLDNN_HELPER_DLL_IMPORT
32 # define MKLDNN_HELPER_DLL_EXPORT
33 # endif
34 #endif
35 
36 #ifdef MKLDNN_DLL
37 # ifdef MKLDNN_DLL_EXPORTS
38 # define MKLDNN_API MKLDNN_HELPER_DLL_EXPORT
39 # else
40 # define MKLDNN_API MKLDNN_HELPER_DLL_IMPORT
41 # endif
42 #else
43 # define MKLDNN_API
44 #endif
45 
46 #if defined (__GNUC__)
47 # define MKLDNN_DEPRECATED __attribute__((deprecated))
48 #elif defined(_MSC_VER)
49 # define MKLDNN_DEPRECATED __declspec(deprecated)
50 #else
51 # define MKLDNN_DEPRECATED
52 #endif
53 
54 #include "mkldnn_types.h"
55 #endif /* DOXYGEN_SHOULD_SKIP_THIS */
56 
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
77  const_mkldnn_primitive_desc_t hint_forward_primitive_desc);
78 
87  mkldnn_engine_t engine,
88  const_mkldnn_primitive_desc_t hint_forward_primitive_desc);
89 
94 
102 
106 
112  mkldnn_primitive_desc_t *primitive_desc,
113  const_mkldnn_op_desc_t op_desc, mkldnn_engine_t engine,
114  const_mkldnn_primitive_desc_t hint_forward_primitive_desc);
115 
121  mkldnn_primitive_desc_t *primitive_desc,
123  mkldnn_engine_t engine,
124  const_mkldnn_primitive_desc_t hint_forward_primitive_desc);
125 
128  mkldnn_primitive_desc_t *primitive_desc,
129  const_mkldnn_primitive_desc_t existing_primitive_desc);
130 
140  const_mkldnn_primitive_desc_t primitive_desc,
142 
145  mkldnn_primitive_desc_t primitive_desc);
146 
151  const_mkldnn_primitive_desc_t primitive_desc, mkldnn_query_t what,
152  int index, void *result);
153 
158  const_mkldnn_primitive_desc_t primitive_desc);
159 
164  const_mkldnn_primitive_desc_t primitive_desc, mkldnn_query_t what,
165  int index);
166 
170 int MKLDNN_API mkldnn_primitive_desc_query_s32(
171  const_mkldnn_primitive_desc_t primitive_desc, mkldnn_query_t what,
172  int index);
173 
177  mkldnn_primitive_t *primitive,
178  const_mkldnn_primitive_desc_t primitive_desc,
179  const mkldnn_primitive_at_t *inputs,
180  const_mkldnn_primitive_t *outputs);
181 
189  const_mkldnn_primitive_t primitive,
190  const_mkldnn_primitive_desc_t *primitive_desc);
191 
194  const_mkldnn_primitive_t primitive, size_t index,
195  mkldnn_primitive_at_t *input);
196 
199  const_mkldnn_primitive_t primitive, size_t index,
200  const_mkldnn_primitive_t *output);
201 
204  mkldnn_primitive_t primitive);
205 
212  const_mkldnn_primitive_t primitive, size_t output_index);
213 
228 
232  const_mkldnn_primitive_attr_t existing_attr);
233 
237 
242 
250 
264  const_mkldnn_primitive_attr_t attr, int *count, int *mask,
265  const float **scales);
266 
306  mkldnn_primitive_attr_t attr, int count, int mask,
307  const float *scales);
308 
319 
331 
338 
341 
343 int MKLDNN_API mkldnn_post_ops_len(const_mkldnn_post_ops_t post_ops);
344 
348  const_mkldnn_post_ops_t post_ops, int index);
349 
371  mkldnn_post_ops_t post_ops, float scale);
372 
381  const_mkldnn_post_ops_t post_ops, int index, float *scale);
382 
395  mkldnn_post_ops_t post_ops, float scale, mkldnn_alg_kind_t alg,
396  float alpha, float beta);
397 
402  const_mkldnn_post_ops_t post_ops, int index, float *scale,
403  mkldnn_alg_kind_t *alg, float *alpha, float *beta);
404 
417  mkldnn_memory_desc_t *memory_desc, int ndims, const mkldnn_dims_t dims,
418  mkldnn_data_type_t data_type, mkldnn_memory_format_t format);
419 
424  mkldnn_primitive_desc_t *memory_primitive_desc,
425  const mkldnn_memory_desc_t *memory_desc, mkldnn_engine_t engine);
426 
431  mkldnn_primitive_desc_t *view_primitive_desc,
432  const_mkldnn_primitive_desc_t memory_primitive_desc,
433  const mkldnn_dims_t dims, const mkldnn_dims_t offsets);
434 
445 
448 /* XXX: view? */
449 size_t MKLDNN_API mkldnn_memory_primitive_desc_get_size(
450  const_mkldnn_primitive_desc_t memory_primitive_desc);
451 
454 /* XXX: view? */
456  const_mkldnn_primitive_t memory, void **handle);
457 
460  mkldnn_primitive_t memory, void *handle);
461 
471  mkldnn_primitive_desc_t *reorder_primitive_desc,
474 
478  mkldnn_primitive_desc_t *reorder_primitive_desc,
482 
495  mkldnn_primitive_desc_t *concat_primitive_desc,
496  const mkldnn_memory_desc_t *output_desc, int n, int concat_dimension,
497  const_mkldnn_primitive_desc_t *input_pds);
498 
499 #if 0
500 
510 mkldnn_status_t MKLDNN_API mkldnn_concat_inplace_by_input_primitive_desc_create(
511  mkldnn_primitive_desc_t *concat_primitive_desc,
512  int n, int concat_dimension, const_mkldnn_primitive_desc_t *inputs);
513 
522 mkldnn_status_t MKLDNN_API mkldnn_concat_inplace_by_output_primitive_desc_create(
523  mkldnn_primitive_desc_t *concat_primitive_desc,
524  const mkldnn_primitive_desc_t output, int n, int concat_dimension,
525  int *sizes);
526 #endif
527 
540  mkldnn_primitive_desc_t *sum_primitive_desc,
541  const mkldnn_memory_desc_t *output_desc, int n, const float *scales,
542  const_mkldnn_primitive_desc_t *input_pds);
543 
579  mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc,
580  const mkldnn_memory_desc_t *weights_desc,
581  const mkldnn_memory_desc_t *bias_desc,
582  const mkldnn_memory_desc_t *dst_desc, const mkldnn_dims_t strides,
583  const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r,
585 
600  mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc,
601  const mkldnn_memory_desc_t *weights_desc,
602  const mkldnn_memory_desc_t *bias_desc,
603  const mkldnn_memory_desc_t *dst_desc, const mkldnn_dims_t strides,
604  const mkldnn_dims_t dilates, const mkldnn_dims_t padding_l,
606 
614  mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind,
615  const mkldnn_memory_desc_t *diff_src_desc,
616  const mkldnn_memory_desc_t *weights_desc,
617  const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides,
618  const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r,
620 
628  mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind,
629  const mkldnn_memory_desc_t *diff_src_desc,
630  const mkldnn_memory_desc_t *weights_desc,
631  const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides,
632  const mkldnn_dims_t dilates, const mkldnn_dims_t padding_l,
634 
642  mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind,
643  const mkldnn_memory_desc_t *src_desc,
644  const mkldnn_memory_desc_t *diff_weights_desc,
645  const mkldnn_memory_desc_t *diff_bias_desc,
646  const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides,
647  const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r,
649 
656 mkldnn_status_t MKLDNN_API
658  mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind,
659  const mkldnn_memory_desc_t *src_desc,
660  const mkldnn_memory_desc_t *diff_weights_desc,
661  const mkldnn_memory_desc_t *diff_bias_desc,
662  const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides,
663  const mkldnn_dims_t dilates, const mkldnn_dims_t padding_l,
665 
680  mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *data_desc,
681  float alpha, float beta);
682 
688  mkldnn_eltwise_desc_t *eltwise_desc, mkldnn_alg_kind_t alg_kind,
689  const mkldnn_memory_desc_t *diff_data_desc,
690  const mkldnn_memory_desc_t *data_desc, float alpha, float beta);
691 
707 MKLDNN_DEPRECATED
710  const mkldnn_memory_desc_t *data_desc, float negative_slope);
711 
717 MKLDNN_DEPRECATED
719  mkldnn_relu_desc_t *relu_desc,
720  const mkldnn_memory_desc_t *diff_data_desc,
721  const mkldnn_memory_desc_t *data_desc, float negative_slope);
722 
742  const mkldnn_memory_desc_t *data_desc, int softmax_axis);
743 
775  mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc,
776  const mkldnn_memory_desc_t *dst_desc, const mkldnn_dims_t strides,
777  const mkldnn_dims_t kernel, const mkldnn_dims_t padding_l,
779 
787  mkldnn_pooling_desc_t *pool_desc, mkldnn_alg_kind_t alg_kind,
788  const mkldnn_memory_desc_t *diff_src_desc,
789  const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides,
790  const mkldnn_dims_t kernel, const mkldnn_dims_t padding_l,
792 
820  mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *data_desc,
821  int local_size, float alpha, float beta, float k);
822 
827  mkldnn_lrn_desc_t *lrn_desc, mkldnn_alg_kind_t alg_kind,
828  const mkldnn_memory_desc_t *diff_data_desc,
829  const mkldnn_memory_desc_t *data_desc, int local_size, float alpha,
830  float beta, float k);
831 
858  float epsilon, unsigned flags);
859 
870  const mkldnn_memory_desc_t *diff_data_desc,
871  const mkldnn_memory_desc_t *data_desc,
872  float epsilon, unsigned flags);
873 
897  const mkldnn_memory_desc_t *src_desc,
898  const mkldnn_memory_desc_t *weights_desc,
899  const mkldnn_memory_desc_t *bias_desc,
900  const mkldnn_memory_desc_t *dst_desc);
901 
910  const mkldnn_memory_desc_t *diff_src_desc,
911  const mkldnn_memory_desc_t *weights_desc,
912  const mkldnn_memory_desc_t *diff_dst_desc);
913 
922  const mkldnn_memory_desc_t *src_desc,
923  const mkldnn_memory_desc_t *diff_weights_desc,
924  const mkldnn_memory_desc_t *diff_bias_desc,
925  const mkldnn_memory_desc_t *diff_dst_desc);
926 
937  mkldnn_convolution_relu_desc_t *conv_relu_desc,
938  const mkldnn_convolution_desc_t *conv_desc, float negative_slope);
939 
948 size_t MKLDNN_API mkldnn_engine_get_count(mkldnn_engine_kind_t kind);
949 
952  mkldnn_engine_kind_t kind, size_t index);
953 
956  mkldnn_engine_kind_t *kind);
957 
960 
968  mkldnn_stream_kind_t stream_kind);
969 
974  size_t n, mkldnn_primitive_t primitives[],
975  mkldnn_primitive_t *error_primitive);
976 
981  int block, mkldnn_primitive_t *error_primitive);
982 
986  mkldnn_primitive_t *error_primitive);
987 
990 
1004 mkldnn_status_t MKLDNN_API mkldnn_verbose_set(int level);
1005 
1010 #ifdef __cplusplus
1011 }
1012 #endif
1013 
1014 #endif
A descriptor of a Local Response Normalization (LRN) operation.
Definition: mkldnn_types.h:612
mkldnn_status_t MKLDNN_API mkldnn_convolution_backward_weights_desc_init(mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *diff_weights_desc, const mkldnn_memory_desc_t *diff_bias_desc, const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a convolution descriptor conv_desc for backward propagation with respect to weights using...
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_destroy(mkldnn_primitive_attr_t attr)
Deletes an attr.
mkldnn_status_t MKLDNN_API mkldnn_sum_primitive_desc_create(mkldnn_primitive_desc_t *sum_primitive_desc, const mkldnn_memory_desc_t *output_desc, int n, const float *scales, const_mkldnn_primitive_desc_t *input_pds)
Creates out-of-place sum_primitive_desc for sum of n inputs multiplied by scale with resulting output...
mkldnn_status_t MKLDNN_API mkldnn_stream_destroy(mkldnn_stream_t stream)
Destroys an execution stream.
mkldnn_status_t
Status values returned by Intel(R) MKL-DNN functions.
Definition: mkldnn_types.h:39
A descriptor of a convolution operation.
Definition: mkldnn_types.h:480
mkldnn_status_t MKLDNN_API mkldnn_memory_primitive_desc_create(mkldnn_primitive_desc_t *memory_primitive_desc, const mkldnn_memory_desc_t *memory_desc, mkldnn_engine_t engine)
Creates a memory_primitive_desc memory primitive descriptor using memory_desc and engine...
mkldnn_status_t MKLDNN_API mkldnn_post_ops_create(mkldnn_post_ops_t *post_ops)
Creates an empty sequence of post operations post_ops.
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_destroy(mkldnn_primitive_desc_t primitive_desc)
Deletes a primitive_desc.
mkldnn_status_t MKLDNN_API mkldnn_concat_primitive_desc_create(mkldnn_primitive_desc_t *concat_primitive_desc, const mkldnn_memory_desc_t *output_desc, int n, int concat_dimension, const_mkldnn_primitive_desc_t *input_pds)
Creates out-of-place concat_primitive_desc for concatenation of n inputs by concat_dimension with res...
padding_kind
Definition: mkldnn.hpp:226
An opaque structure to describe an engine.
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_get_attr(const_mkldnn_primitive_desc_t primitive_desc, const_mkldnn_primitive_attr_t *attr)
Returns a constant reference to the attribute of a primitive_desc.
mkldnn_status_t MKLDNN_API mkldnn_memory_desc_init(mkldnn_memory_desc_t *memory_desc, int ndims, const mkldnn_dims_t dims, mkldnn_data_type_t data_type, mkldnn_memory_format_t format)
Initializes a memory_desc memory descriptor using ndims, dims, data_type, and data format...
mkldnn_status_t MKLDNN_API mkldnn_dilated_convolution_backward_weights_desc_init(mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *diff_weights_desc, const mkldnn_memory_desc_t *diff_bias_desc, const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t dilates, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a convolution descriptor conv_desc for backward propagation with respect to weights using...
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_clone(mkldnn_primitive_attr_t *attr, const_mkldnn_primitive_attr_t existing_attr)
Makes a copy of an existing_attr.
A descriptor of a Softmax operation.
Definition: mkldnn_types.h:564
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_clone(mkldnn_primitive_desc_t *primitive_desc, const_mkldnn_primitive_desc_t existing_primitive_desc)
Makes a copy of a primitive_desc.
mkldnn_status_t MKLDNN_API mkldnn_memory_get_data_handle(const_mkldnn_primitive_t memory, void **handle)
For a memory primitive, returns the data handle.
mkldnn_status_t MKLDNN_API mkldnn_convolution_backward_data_desc_init(mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *diff_src_desc, const mkldnn_memory_desc_t *weights_desc, const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a convolution descriptor conv_desc for backward propagation with respect to data using al...
A descriptor of an inner product operation.
Definition: mkldnn_types.h:670
mkldnn_status_t MKLDNN_API mkldnn_post_ops_destroy(mkldnn_post_ops_t post_ops)
Deletes a post_ops sequence.
An opaque structure for a chain of post operations.
An opaque structure to describe a primitive descriptor .
mkldnn_status_t MKLDNN_API mkldnn_memory_set_data_handle(mkldnn_primitive_t memory, void *handle)
For a memory primitive, sets the data handle.
mkldnn_status_t MKLDNN_API mkldnn_batch_normalization_forward_desc_init(mkldnn_batch_normalization_desc_t *bnrm_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_memory_desc_t *data_desc, float epsilon, unsigned flags)
Initializes a batch normalization descriptor bnrm_desc for forward propagation using prop_kind...
mkldnn_status_t MKLDNN_API mkldnn_post_ops_append_eltwise(mkldnn_post_ops_t post_ops, float scale, mkldnn_alg_kind_t alg, float alpha, float beta)
Appends eltwise post operation to the post_ops with given parameters kind, alpha and beta (...
mkldnn_primitive_at_t MKLDNN_API mkldnn_primitive_at(const_mkldnn_primitive_t primitive, size_t output_index)
Creates an mkldnn_primitive_at_t structure from a primitive and output_index.
mkldnn_status_t MKLDNN_API mkldnn_softmax_forward_desc_init(mkldnn_softmax_desc_t *softmax_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_memory_desc_t *data_desc, int softmax_axis)
Initializes a softmax_desc for forward propagation using prop_kind (possible value are mkldnn_forward...
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_iterator_next(mkldnn_primitive_desc_iterator_t iterator)
Iterates over primitive descriptors.
mkldnn_status_t MKLDNN_API mkldnn_pooling_backward_desc_init(mkldnn_pooling_desc_t *pool_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *diff_src_desc, const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t kernel, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a pooling descriptor pool_desc for backward propagation using alg_kind, memory descriptors, and pooling parameters in spatial domain: strides, kernel sizes, padding_l, padding_r, and padding_kind.
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_create(mkldnn_primitive_attr_t *attr)
Creates an empty (default) attr attribute.
A descriptor of a convolution followed by relu operation.
Definition: mkldnn_types.h:699
mkldnn_status_t MKLDNN_API mkldnn_stream_submit(mkldnn_stream_t stream, size_t n, mkldnn_primitive_t primitives[], mkldnn_primitive_t *error_primitive)
Submits primitives to an execution stream.
A descriptor of a element-wise operation.
Definition: mkldnn_types.h:522
mkldnn_status_t MKLDNN_API mkldnn_stream_wait(mkldnn_stream_t stream, int block, mkldnn_primitive_t *error_primitive)
Waits for all primitives in the execution stream to finish.
size_t MKLDNN_API mkldnn_engine_get_count(mkldnn_engine_kind_t kind)
Returns the number of engines of a particular kind.
mkldnn_primitive_kind_t MKLDNN_API mkldnn_post_ops_get_kind(const_mkldnn_post_ops_t post_ops, int index)
Returns the type of post operation with index index in given post_ops.
Memory descriptor.
Definition: mkldnn_types.h:456
mkldnn_status_t MKLDNN_API mkldnn_inner_product_backward_data_desc_init(mkldnn_inner_product_desc_t *ip_desc, const mkldnn_memory_desc_t *diff_src_desc, const mkldnn_memory_desc_t *weights_desc, const mkldnn_memory_desc_t *diff_dst_desc)
Initializes an inner product descriptor ip_desc for backward propagation with respect to data using m...
const mkldnn_memory_desc_t MKLDNN_API * mkldnn_primitive_desc_query_memory_d(const_mkldnn_primitive_desc_t primitive_desc)
Queries primitive descriptor for memory descriptor.
prop_kind
Definition: mkldnn.hpp:234
mkldnn_status_t MKLDNN_API mkldnn_engine_create(mkldnn_engine_t *engine, mkldnn_engine_kind_t kind, size_t index)
Creates an engine of particular kind and index.
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_get_int_output_round_mode(const_mkldnn_primitive_attr_t attr, mkldnn_round_mode_t *round_mode)
Returns integer output rounding mode round_mode for a given attr, previously set by mkldnn_primitive_...
mkldnn_round_mode_t
Rounding mode.
Definition: mkldnn_types.h:78
mkldnn_status_t MKLDNN_API mkldnn_convolution_forward_desc_init(mkldnn_convolution_desc_t *conv_desc, mkldnn_prop_kind_t prop_kind, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *weights_desc, const mkldnn_memory_desc_t *bias_desc, const mkldnn_memory_desc_t *dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a convolution descriptor conv_desc for forward propagation using prop_kind (possible valu...
mkldnn_status_t MKLDNN_API mkldnn_view_primitive_desc_create(mkldnn_primitive_desc_t *view_primitive_desc, const_mkldnn_primitive_desc_t memory_primitive_desc, const mkldnn_dims_t dims, const mkldnn_dims_t offsets)
Creates a view_primitive_desc for a given memory_primitive_desc, with dims sizes and offset offsets...
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_get_output_scales(const_mkldnn_primitive_attr_t attr, int *count, int *mask, const float **scales)
Returns count, correspondence scale mask, and pointer to a constant floating point array of output sc...
round_mode
Definition: mkldnn.hpp:217
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_set_post_ops(mkldnn_primitive_attr_t attr, const_mkldnn_post_ops_t post_ops)
Sets configured post_ops to an attribute attr for future use (when primitive descriptor is being crea...
mkldnn_memory_format_t
Memory format specification.
Definition: mkldnn_types.h:107
mkldnn_status_t MKLDNN_API mkldnn_eltwise_forward_desc_init(mkldnn_eltwise_desc_t *eltwise_desc, mkldnn_prop_kind_t prop_kind, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *data_desc, float alpha, float beta)
Initializes a eltwise_desc for forward propagation using prop_kind (possible values are mkldnn_forwar...
int MKLDNN_API mkldnn_memory_primitive_desc_equal(const_mkldnn_primitive_desc_t lhs, const_mkldnn_primitive_desc_t rhs)
Compares two descriptors of memory primitives.
mkldnn_status_t MKLDNN_API mkldnn_verbose_set(int level)
Sets verbosity level (print information to stdout).
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_query(const_mkldnn_primitive_desc_t primitive_desc, mkldnn_query_t what, int index, void *result)
Queries primitive descriptor.
An opaque structure to describe an execution stream.
mkldnn_status_t MKLDNN_API mkldnn_eltwise_backward_desc_init(mkldnn_eltwise_desc_t *eltwise_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *diff_data_desc, const mkldnn_memory_desc_t *data_desc, float alpha, float beta)
Initializes a eltwise_desc for backward propagation using alg_kind algorithm memory descriptors diff_...
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_iterator_destroy(mkldnn_primitive_desc_iterator_t iterator)
Deletes a primitive descriptor iterator.
mkldnn_status_t MKLDNN_API mkldnn_post_ops_append_sum(mkldnn_post_ops_t post_ops, float scale)
Appends accumulation (sum) post operation to the post_ops.
mkldnn_status_t MKLDNN_API mkldnn_primitive_get_output(const_mkldnn_primitive_t primitive, size_t index, const_mkldnn_primitive_t *output)
For a primitive, returns output at the index position.
mkldnn_prop_kind_t
Kinds of propagation.
Definition: mkldnn_types.h:263
mkldnn_stream_kind_t
Kinds of streams.
Definition: mkldnn_types.h:914
mkldnn_status_t MKLDNN_API mkldnn_primitive_get_input_at(const_mkldnn_primitive_t primitive, size_t index, mkldnn_primitive_at_t *input)
For a primitive, returns input at the index position.
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_set_int_output_round_mode(mkldnn_primitive_attr_t attr, mkldnn_round_mode_t round_mode)
Sets output rounding mode round_mode for integer operations for a given attr.
A wrapper structure to specify a particular output of a primitive.
Definition: mkldnn_types.h:828
An opaque structure for primitive descriptor attributes.
mkldnn_status_t MKLDNN_API mkldnn_pooling_forward_desc_init(mkldnn_pooling_desc_t *pool_desc, mkldnn_prop_kind_t prop_kind, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t kernel, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a pooling descriptor pool_desc for forward propagation using prop_kind (possible values a...
mkldnn_status_t MKLDNN_API mkldnn_stream_create(mkldnn_stream_t *stream, mkldnn_stream_kind_t stream_kind)
Creates an execution stream of stream_kind.
MKLDNN_DEPRECATED mkldnn_status_t MKLDNN_API mkldnn_relu_backward_desc_init(mkldnn_relu_desc_t *relu_desc, const mkldnn_memory_desc_t *diff_data_desc, const mkldnn_memory_desc_t *data_desc, float negative_slope)
Initializes a relu_desc for backward propagation using negative_slope and memory descriptors diff_dat...
MKLDNN_DEPRECATED mkldnn_status_t MKLDNN_API mkldnn_relu_forward_desc_init(mkldnn_relu_desc_t *relu_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_memory_desc_t *data_desc, float negative_slope)
Initializes a relu_desc for forward propagation using prop_kind (possible values are mkldnn_forward_t...
mkldnn_status_t MKLDNN_API mkldnn_batch_normalization_backward_desc_init(mkldnn_batch_normalization_desc_t *bnrm_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_memory_desc_t *diff_data_desc, const mkldnn_memory_desc_t *data_desc, float epsilon, unsigned flags)
Initializes a batch normalization descriptor bnrm_desc for backward propagation with respect to data ...
mkldnn_status_t MKLDNN_API mkldnn_primitive_get_primitive_desc(const_mkldnn_primitive_t primitive, const_mkldnn_primitive_desc_t *primitive_desc)
Retrieves a reference to the primitive_desc descriptor of given primitive.
mkldnn_status_t MKLDNN_API mkldnn_post_ops_get_params_eltwise(const_mkldnn_post_ops_t post_ops, int index, float *scale, mkldnn_alg_kind_t *alg, float *alpha, float *beta)
Gets the eltwise parameters of the post operation with index index in the sequence of post_ops...
mkldnn_status_t MKLDNN_API mkldnn_post_ops_get_params_sum(const_mkldnn_post_ops_t post_ops, int index, float *scale)
Gets the parameters of the accumulation (sum) post operation with index index in the sequence of post...
mkldnn_query_t
Primitive descriptor query specification.
Definition: mkldnn_types.h:866
A descriptor of a Batch Normalization operation.
Definition: mkldnn_types.h:639
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_create(mkldnn_primitive_desc_t *primitive_desc, const_mkldnn_op_desc_t op_desc, mkldnn_engine_t engine, const_mkldnn_primitive_desc_t hint_forward_primitive_desc)
Creates a primitive_desc using op_desc, engine, and optionally a hint primitive descriptor from forwa...
mkldnn_status_t MKLDNN_API mkldnn_reorder_primitive_desc_create_v2(mkldnn_primitive_desc_t *reorder_primitive_desc, const_mkldnn_primitive_desc_t input, const_mkldnn_primitive_desc_t output, const_mkldnn_primitive_attr_t attr)
Initializes a reorder_primitive_desc using an attr attribute and descriptors of input and output memo...
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_iterator_create(mkldnn_primitive_desc_iterator_t *iterator, const_mkldnn_op_desc_t op_desc, mkldnn_engine_t engine, const_mkldnn_primitive_desc_t hint_forward_primitive_desc)
Creates a primitive descriptor iterator for given op_desc, engine, and optionally a hint primitive de...
mkldnn_status_t MKLDNN_API mkldnn_stream_rerun(mkldnn_stream_t stream, mkldnn_primitive_t *error_primitive)
Reruns all the primitives within the stream.
A descriptor of a pooling operation.
Definition: mkldnn_types.h:578
mkldnn_primitive_desc_t MKLDNN_API mkldnn_primitive_desc_iterator_fetch(const_mkldnn_primitive_desc_iterator_t iterator)
Fetches current primitive descriptor.
int MKLDNN_API mkldnn_primitive_desc_query_s32(const_mkldnn_primitive_desc_t primitive_desc, mkldnn_query_t what, int index)
Queries primitive descriptor for signed 32bit int.
mkldnn_status_t MKLDNN_API mkldnn_reorder_primitive_desc_create(mkldnn_primitive_desc_t *reorder_primitive_desc, const_mkldnn_primitive_desc_t input, const_mkldnn_primitive_desc_t output)
Initializes a reorder_primitive_desc using descriptors of input and output memory primitives...
mkldnn_primitive_kind_t
Kinds of primitives.
Definition: mkldnn_types.h:290
size_t MKLDNN_API mkldnn_memory_primitive_desc_get_size(const_mkldnn_primitive_desc_t memory_primitive_desc)
Returns the size (in bytes) that is required for given memory_primitive_desc.
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_get_post_ops(const_mkldnn_primitive_attr_t attr, const_mkldnn_post_ops_t *post_ops)
Returns post_ops for given attr.
mkldnn_status_t MKLDNN_API mkldnn_primitive_create(mkldnn_primitive_t *primitive, const_mkldnn_primitive_desc_t primitive_desc, const mkldnn_primitive_at_t *inputs, const_mkldnn_primitive_t *outputs)
Creates a primitive using a primitive_desc descriptor and arrays of inputs and outputs.
mkldnn_status_t MKLDNN_API mkldnn_dilated_convolution_forward_desc_init(mkldnn_convolution_desc_t *conv_desc, mkldnn_prop_kind_t prop_kind, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *weights_desc, const mkldnn_memory_desc_t *bias_desc, const mkldnn_memory_desc_t *dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t dilates, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a dilated convolution descriptor conv_desc for forward propagation using prop_kind (possi...
mkldnn_status_t MKLDNN_API mkldnn_engine_get_kind(mkldnn_engine_t engine, mkldnn_engine_kind_t *kind)
Returns the kind of an engine.
mkldnn_status_t MKLDNN_API mkldnn_engine_destroy(mkldnn_engine_t engine)
Destroys an engine.
mkldnn_status_t MKLDNN_API mkldnn_dilated_convolution_backward_data_desc_init(mkldnn_convolution_desc_t *conv_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *diff_src_desc, const mkldnn_memory_desc_t *weights_desc, const mkldnn_memory_desc_t *diff_dst_desc, const mkldnn_dims_t strides, const mkldnn_dims_t dilates, const mkldnn_dims_t padding_l, const mkldnn_dims_t padding_r, mkldnn_padding_kind_t padding_kind)
Initializes a dilated convolution descriptor conv_desc for backward propagation with respect to data ...
mkldnn_status_t MKLDNN_API mkldnn_lrn_backward_desc_init(mkldnn_lrn_desc_t *lrn_desc, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *diff_data_desc, const mkldnn_memory_desc_t *data_desc, int local_size, float alpha, float beta, float k)
Initializes an lrn_desc for backward propagation using alg_kind, memory descriptors data_desc...
mkldnn_padding_kind_t
Kinds of padding.
Definition: mkldnn_types.h:257
const_mkldnn_primitive_desc_t MKLDNN_API mkldnn_primitive_desc_query_pd(const_mkldnn_primitive_desc_t primitive_desc, mkldnn_query_t what, int index)
Queries primitive descriptor for primitive descriptor.
An opaque structure to describe a primitive.
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_create_v2(mkldnn_primitive_desc_t *primitive_desc, const_mkldnn_op_desc_t op_desc, const_mkldnn_primitive_attr_t attr, mkldnn_engine_t engine, const_mkldnn_primitive_desc_t hint_forward_primitive_desc)
Creates a primitive_desc using op_desc, attr, engine, and optionally a hint primitive descriptor from...
mkldnn_data_type_t
Data type specification.
Definition: mkldnn_types.h:62
mkldnn_status_t MKLDNN_API mkldnn_lrn_forward_desc_init(mkldnn_lrn_desc_t *lrn_desc, mkldnn_prop_kind_t prop_kind, mkldnn_alg_kind_t alg_kind, const mkldnn_memory_desc_t *data_desc, int local_size, float alpha, float beta, float k)
Initializes an lrn_desc for forward propagation using prop_kind (possible values are mkldnn_forward_t...
mkldnn_engine_kind_t
Kinds of engines.
Definition: mkldnn_types.h:716
const void * const_mkldnn_op_desc_t
A pointer to any of the operation descriptors (constant variant).
Definition: mkldnn_types.h:450
mkldnn_status_t MKLDNN_API mkldnn_primitive_desc_iterator_create_v2(mkldnn_primitive_desc_iterator_t *iterator, const_mkldnn_op_desc_t op_desc, const_mkldnn_primitive_attr_t attr, mkldnn_engine_t engine, const_mkldnn_primitive_desc_t hint_forward_primitive_desc)
Creates a primitive descriptor iterator for given op_desc, attr, engine, and optionally a hint primit...
mkldnn_status_t MKLDNN_API mkldnn_convolution_relu_desc_init(mkldnn_convolution_relu_desc_t *conv_relu_desc, const mkldnn_convolution_desc_t *conv_desc, float negative_slope)
Initializes a merged convolution-relu descriptor conv_relu_desc for forward propagation (supported in...
int MKLDNN_API mkldnn_post_ops_len(const_mkldnn_post_ops_t post_ops)
Returns the length of post operations for given post_ops.
mkldnn_alg_kind_t
Kinds of algorithms.
Definition: mkldnn_types.h:326
int mkldnn_dims_t[TENSOR_MAX_DIMS]
A type to describe tensor dimensions.
Definition: mkldnn_types.h:423
mkldnn_status_t MKLDNN_API mkldnn_primitive_destroy(mkldnn_primitive_t primitive)
Deletes a primitive.
mkldnn_status_t MKLDNN_API mkldnn_primitive_attr_set_output_scales(mkldnn_primitive_attr_t attr, int count, int mask, const float *scales)
Sets output scales for primitive operations.
mkldnn_status_t MKLDNN_API mkldnn_inner_product_backward_weights_desc_init(mkldnn_inner_product_desc_t *ip_desc, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *diff_weights_desc, const mkldnn_memory_desc_t *diff_bias_desc, const mkldnn_memory_desc_t *diff_dst_desc)
Initializes an inner product descriptor ip_desc for backward propagation with respect to weights usin...
An opaque structure to describe a primitive descriptor iterator .
mkldnn_status_t MKLDNN_API mkldnn_inner_product_forward_desc_init(mkldnn_inner_product_desc_t *ip_desc, mkldnn_prop_kind_t prop_kind, const mkldnn_memory_desc_t *src_desc, const mkldnn_memory_desc_t *weights_desc, const mkldnn_memory_desc_t *bias_desc, const mkldnn_memory_desc_t *dst_desc)
Initializes an inner product descriptor ip_desc for forward propagation using prop_kind (possible val...