oneAPI Deep Neural Network Library (oneDNN)
Performance library for Deep Learning
2.2.2
dnnl Namespace Reference

oneDNN namespace More...

Namespaces

 ocl_interop
 OpenCL interoperability namespace.
 
 sycl_interop
 SYCL interoperability namespace.
 
 threadpool_interop
 Threadpool interoperability namespace.
 

Classes

struct  error
 oneDNN exception class. More...
 
struct  handle_traits
 A class that provides the destructor for a oneDNN C API handle. More...
 
struct  handle
 oneDNN C API handle wrapper class. More...
 
struct  primitive
 Base class for all computational primitives. More...
 
struct  engine
 An execution engine. More...
 
struct  stream
 An execution stream. More...
 
struct  memory
 Memory object. More...
 
struct  post_ops
 Post-ops. More...
 
struct  primitive_attr
 Primitive attributes. More...
 
struct  primitive_desc_base
 Base class for all primitive descriptors. More...
 
struct  reorder
 Reorder primitive. More...
 
struct  concat
 Tensor concatenation (concat) primitive. More...
 
struct  sum
 Out-of-place summation (sum) primitive. More...
 
struct  primitive_desc
 A base class for descriptors of all primitives that have an operation descriptor and that support iteration over multiple implementations. More...
 
struct  convolution_forward
 Convolution forward propagation primitive. More...
 
struct  convolution_backward_data
 Convolution backward propagation primitive. More...
 
struct  convolution_backward_weights
 Convolution weights gradient primitive. More...
 
struct  deconvolution_forward
 Deconvolution forward propagation primitive. More...
 
struct  deconvolution_backward_data
 Deconvolution backward propagation primitive. More...
 
struct  deconvolution_backward_weights
 Deconvolution weights gradient primitive. More...
 
struct  lrn_forward
 Local response normalization (LRN) forward propagation primitive. More...
 
struct  lrn_backward
 Local response normalization (LRN) backward propagation primitive. More...
 
struct  pooling_forward
 Pooling forward propagation primitive. More...
 
struct  pooling_backward
 Pooling backward propagation primitive. More...
 
struct  eltwise_forward
 Elementwise unary operation forward propagation primitive. More...
 
struct  eltwise_backward
 Elementwise unary operation backward propagation primitive. More...
 
struct  softmax_forward
 Softmax forward propagation primitive. More...
 
struct  softmax_backward
 Softmax backward propagation primitive. More...
 
struct  logsoftmax_forward
 Logsoftmax forward propagation primitive. More...
 
struct  logsoftmax_backward
 Logsoftmax backward propagation primitive. More...
 
struct  batch_normalization_forward
 Batch normalization forward propagation primitive. More...
 
struct  batch_normalization_backward
 Batch normalization backward propagation primitive. More...
 
struct  layer_normalization_forward
 Layer normalization forward propagation primitive. More...
 
struct  layer_normalization_backward
 Layer normalization backward propagation primitive. More...
 
struct  inner_product_forward
 Inner product forward propagation primitive. More...
 
struct  inner_product_backward_data
 Inner product backward propagation primitive. More...
 
struct  inner_product_backward_weights
 Inner product weights gradient primitive. More...
 
struct  rnn_primitive_desc_base
 Base class for primitive descriptors for RNN primitives. More...
 
struct  vanilla_rnn_forward
 Vanilla RNN forward propagation primitive. More...
 
struct  vanilla_rnn_backward
 Vanilla RNN backward propagation primitive. More...
 
struct  lstm_forward
 LSTM forward propagation primitive. More...
 
struct  lstm_backward
 LSTM backward propagation primitive. More...
 
struct  gru_forward
 GRU forward propagation primitive. More...
 
struct  gru_backward
 GRU backward propagation primitive. More...
 
struct  lbr_gru_forward
 LBR GRU forward propagation primitive. More...
 
struct  lbr_gru_backward
 LBR GRU backward propagation primitive. More...
 
struct  shuffle_forward
 Shuffle forward propagation primitive. More...
 
struct  shuffle_backward
 Shuffle backward propagation primitive. More...
 
struct  binary
 Elementwise binary operator primitive. More...
 
struct  matmul
 Matrix multiplication (matmul) primitive. More...
 
struct  resampling_forward
 Resampling forward propagation. More...
 
struct  resampling_backward
 Resampling backward propagation primitive. More...
 
struct  pooling_v2_forward
 Pooling v2 (dilated pooling) forward propagation primitive. More...
 
struct  pooling_v2_backward
 Pooling v2 (dilated pooling) backward propagation primitive. More...
 
struct  prelu_forward
 PReLU forward propagation primitive. More...
 
struct  prelu_backward
 PReLU backward propagation primitive. More...
 
struct  reduction
 Reduction. More...
 

Typedefs

using version_t = dnnl_version_t
 Structure containing version information as per Semantic Versioning More...
 

Enumerations

enum class  scratchpad_mode
 Scratchpad mode. More...
 
enum class  prop_kind
 Propagation kind. More...
 
enum class  algorithm
 Kinds of algorithms. More...
 
enum class  normalization_flags : unsigned
 Flags for normalization primitives. More...
 
enum class  rnn_flags : unsigned
 RNN cell flags. More...
 
enum class  rnn_direction
 A direction of RNN primitive execution. More...
 
enum class  query
 Primitive descriptor query specification. More...
 
enum class  status
 Status values returned by the library functions. More...
 
enum class  cpu_isa
 CPU instruction set flags. More...
 
enum class  cpu_isa_hints
 CPU ISA hints flags. More...
 

Functions

dnnl_primitive_kind_t convert_to_c (primitive::kind akind)
 Converts primitive kind enum value from C++ API to C API type. More...
 
dnnl_scratchpad_mode_t convert_to_c (scratchpad_mode mode)
 Converts a scratchpad mode enum value from C++ API to C API type. More...
 
dnnl_prop_kind_t convert_to_c (prop_kind akind)
 Converts propagation kind enum value from C++ API to C API type. More...
 
dnnl_alg_kind_t convert_to_c (algorithm aalgorithm)
 Converts algorithm kind enum value from C++ API to C API type. More...
 
dnnl_normalization_flags_t convert_to_c (normalization_flags flags)
 Converts normalization flags enum value from C++ API to C API type. More...
 
dnnl_rnn_flags_t convert_to_c (rnn_flags flags)
 Converts RNN cell flags enum value from C++ API to C API type. More...
 
dnnl_rnn_direction_t convert_to_c (rnn_direction dir)
 Converts RNN direction enum value from C++ API to C API type. More...
 
dnnl_query_t convert_to_c (query aquery)
 Converts query enum value from C++ API to C API type. More...
 
dnnl_engine_kind_t convert_to_c (engine::kind akind)
 Converts engine kind enum value from C++ API to C API type. More...
 
status set_verbose (int level)
 Configures verbose output to stdout. More...
 
const version_tversion ()
 Returns library version information. More...
 
status set_jit_dump (int enable)
 Configures dumping of JIT-generated code. More...
 
status set_jit_profiling_flags (unsigned flags)
 Sets library profiling flags. More...
 
status set_jit_profiling_jitdumpdir (const std::string &dir)
 Sets JIT dump output path. More...
 
status set_max_cpu_isa (cpu_isa isa)
 Sets the maximal ISA the library can dispatch to on the CPU. More...
 
cpu_isa get_effective_cpu_isa ()
 Gets the maximal ISA the library can dispatch to on the CPU. More...
 
status set_cpu_isa_hints (cpu_isa_hints isa_hints)
 Sets the hints flag for the CPU ISA. More...
 
cpu_isa_hints get_cpu_isa_hints ()
 Gets the ISA specific hints that library can follow. More...
 
int get_primitive_cache_capacity ()
 Returns the number of primitives that can be held in the primitive cache at the same time.
 
void set_primitive_cache_capacity (int capacity)
 Sets a number of primitives that can be held in the primitive cache at a time. More...
 
status sgemm (char transa, char transb, dnnl_dim_t M, dnnl_dim_t N, dnnl_dim_t K, float alpha, const float *A, dnnl_dim_t lda, const float *B, dnnl_dim_t ldb, float beta, float *C, dnnl_dim_t ldc)
 Performs single-precision matrix-matrix multiply. More...
 
status gemm_u8s8s32 (char transa, char transb, char offsetc, dnnl_dim_t M, dnnl_dim_t N, dnnl_dim_t K, float alpha, const uint8_t *A, dnnl_dim_t lda, uint8_t ao, const int8_t *B, dnnl_dim_t ldb, int8_t bo, float beta, int32_t *C, dnnl_dim_t ldc, const int32_t *co)
 Performs integer matrix-matrix multiply on 8-bit unsigned matrix A, 8-bit signed matrix B, and 32-bit signed resulting matrix C. More...
 
status gemm_s8s8s32 (char transa, char transb, char offsetc, dnnl_dim_t M, dnnl_dim_t N, dnnl_dim_t K, float alpha, const int8_t *A, dnnl_dim_t lda, int8_t ao, const int8_t *B, dnnl_dim_t ldb, int8_t bo, float beta, int32_t *C, dnnl_dim_t ldc, const int32_t *co)
 Performs integer matrix-matrix multiply on 8-bit signed matrix A, 8-bit signed matrix B, and 32-bit signed resulting matrix C. More...
 

Detailed Description

oneDNN namespace