oneAPI Deep Neural Network Library (oneDNN)
Performance library for Deep Learning
2.3.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
Linking to the Library

oneDNN includes several header files providing C and C++ APIs for the functionality and one or several libraries depending on how oneDNN was built.

Header Files

File Description
include/oneapi/dnnl/dnnl.h C header
include/oneapi/dnnl/dnnl.hpp C++ header
include/oneapi/dnnl/dnnl_types.h Auxiliary C header
include/oneapi/dnnl/dnnl_config.h Auxiliary C header
include/oneapi/dnnl/dnnl_version.h C header with version information

Libraries

Linux

File Description
lib/libdnnl.so oneDNN dynamic library
lib/libdnnl.a oneDNN static library (if built with DNNL_LIBRARY_TYPE=STATIC)

macOS

File Description
lib/libdnnl.dylib oneDNN dynamic library
lib/libdnnl.a oneDNN static library (if built with DNNL_LIBRARY_TYPE=STATIC)

Windows

File Description
bin\dnnl.dll oneDNN dynamic library
lib\dnnl.lib oneDNN import or full static library (the latter if built with DNNL_LIBRARY_TYPE=STATIC)

Linking to oneDNN

The examples below assume that oneDNN is installed in the directory defined in the DNNLROOT environment variable.

Linux/macOS

g++ -std=c++11 -I${DNNLROOT}/include -L${DNNLROOT}/lib simple_net.cpp -ldnnl
clang++ -std=c++11 -I${DNNLROOT}/include -L${DNNLROOT}/lib simple_net.cpp -ldnnl
icpc -std=c++11 -I${DNNLROOT}/include -L${DNNLROOT}/lib simple_net.cpp -ldnnl
Note
Applications linked dynamically will resolve the dependencies at runtime. Make sure that the dependencies are available in the standard locations defined by the operating system, in the locations listed in the LD_LIBRARY_PATH (Linux) or DYLD_LIBRARY_PATH (macOS) environment variable or the rpath mechanism.

Support for macOS hardened runtime

oneDNN requires the com.apple.security.cs.allow-jit entitlement when it is integrated with an application that uses the macOS hardened runtime. This requirement comes from the fact that oneDNN generates code on the fly and then executes it.

It can be enabled in Xcode or passed to codesign like this:

codesign -s "Your identity" --options runtime --entitlements Entitlements.plist [other options...] /path/to/libdnnl.dylib

Example Entitlements.plist:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>com.apple.security.cs.allow-jit</key><true/>
</dict>
</plist>

Windows

To link the application from the command line, set up the LIB and INCLUDE environment variables to point to the locations of the oneDNN headers and libraries.

icl /I%DNNLROOT%\include /Qstd=c++11 /qopenmp simple_net.cpp %DNNLROOT%\lib\dnnl.lib
cl /I%DNNLROOT%\include simple_net.cpp %DNNLROOT%\lib\dnnl.lib

Refer to the Microsoft Visual Studio documentation on linking the application using MSVS solutions.

Note
Applications linked dynamically will resolve the dependencies at runtime. Make sure that the dependencies are available in the standard locations defined by the operating system or in the locations listed in the PATH environment variable.