Skip to content

Latest commit

 

History

History
261 lines (211 loc) · 11.3 KB

README.md

File metadata and controls

261 lines (211 loc) · 11.3 KB
Raw

Zen Deep Neural Network Library (ZenDNN)

ZenDNN (Zen Deep Neural Network) Library accelerates deep learning inference applications on AMD CPUs. This library, which includes APIs for basic neural network building blocks optimized for AMD CPUs, targets deep learning application and framework developers with the goal of improving inference performance on AMD CPUs across a variety of workloads, including computer vision, natural language processing (NLP), and recommender systems. ZenDNN leverages oneDNN/DNNL v2.6.3's basic infrastructure and APIs. ZenDNN optimizes several APIs and adds new APIs, which are currently integrated into TensorFlow, ONNXRT, and PyTorch.

ZenDNN depends on:

  • AOCL-BLAS is a high-performant implementation of the Basic Linear Algebra Subprograms (BLAS).
  • Composable Kernel for convolutions using an implicit GEMM algorithm
  • FBGEMM (Facebook GEneral Matrix Multiplication) is a low-precision, high-performance matrix-matrix multiplications and convolution library for server-side inference.

AOCL-BLAS is required dependencies for ZenDNN, whereas AMD Composable Kernel and FBGEMM are an optional dependency.

Table of Contents

Scope

The scope of ZenDNN is to support AMD EPYCTM CPUs on the Linux® platform. ZenDNN v5.0 offers optimized primitives, such as Convolution, MatMul, Elementwise, and Pool (Max and Average), Gelu, LayerNorm that improve performance of many convolutional neural networks, recurrent neural networks, transformer-based models, and recommender system models. For the primitives not supported by ZenDNN, execution will fall back to the native path of the framework.

Release Highlights

Following are the highlights of this release:

  • ZenDNN library is integrated with TensorFlow v2.17 (Plugin), ONNXRT v1.19.2, and PyTorch v2.4 (Plugin).
  • Python v3.9-v3.12 has been used to generate the TensorFlow v2.17 (Plugin) wheel files (*.whl).
  • Python v3.8-v3.11 has been used to generate the ONNXRT v1.19.2 wheel files (*.whl).
  • Python v3.8-v3.11 has been used to generate the PyTorch v2.4 (Plugin) wheel files (*.whl).

ZenDNN library is intended to be used in conjunction with the frameworks mentioned above and cannot be used independently.

The latest information on the ZenDNN release and installers is available on AMD.com portal (https://www.amd.com/en/developer/zendnn.html).

Supported OS and Compilers

This release of ZenDNN supports the following Operating Systems (OS) and compilers:

OS

Binaires will be supported on

  • Ubuntu® 20.04, 22.04, 24.04
  • Red Hat® Enterprise Linux® (RHEL) 8.6, 9.2, 9.5
  • Anolis 8.8, 8.9
  • SLES15 SP6, SP3
  • RockyLinux 9.4
  • CentOS 8.4

Note: PyTorch v2.4 (Plugin) wheel files are not supported on Red Hat® Enterprise Linux® (RHEL) 8.6

Build from source will be supported on

  • Ubuntu® 22.04, 24.04
  • Red Hat® Enterprise Linux® (RHEL) 9.2, 9.5
  • Anolis 8.8,8.9
  • SLES15 SP6, SP3
  • RockyLinux 9.4

Compilers

  • GCC 12.2

Theoretically, for wheel files any Linux based OS with GLIBC version later than 2.28 could be supported.

For C++ interface binaries, any Linux based OS with GLIBC version later than 2.28 could be supported.

Prerequisites

The following prerequisites must be met for this release of ZenDNN:

  • AOCL-BLAS v5.0 must be installed.

AOCL-BLAS Library Installation

AOCL-BLAS AOCL-BLAS is a high-performant implementation of the Basic Linear Algebra Subprograms (BLAS). The BLAS was designed to provide the essential kernels of matrix and vector computation and are the most commonly used computationally intensive operations in dense numerical linear algebra. This can be downloaded from AMD.com portal Developer Central (https://www.amd.com/en/developer/aocl/dense.html).

Note: ZenDNN depends only on AOCL-BLAS and has no dependency on any other AOCL library.

General Convention

The following points must be considered while installing AOCL-BLAS:

  • Change to the preferred directory where AOCL-BLAS will be downloaded.
  • This parent folder is referred to as folder <compdir> in the steps below.
  • Assume that the parent folder for user setup follows this convention: /home/<user-id>/my_work.

AOCL-BLAS Library Setup

Complete the following steps to setup the GCC compiled AOCL-BLAS library:

  1. Execute the command cd <compdir>
  2. Download aocl-blis-linux-gcc-5.0.0.tar.gz.
  3. Execute the following commands: 
    tar -xvf aocl-blis-linux-gcc-5.0.0.tar.gz
cd amd-blis

This will set up the environment for AOCL-BLAS path:

export ZENDNN_BLIS_PATH=$(pwd)

For example:

export ZENDNN_BLIS_PATH=/home/<user-id>/my_work/amd-blis

The bashrc file can be edited to setup ZENDNN_BLIS_PATH environment path. For example, in the case of GCC compiled AOCL-BLAS:

export ZENDNN_BLIS_PATH=/home/<user-id>/my_work/amd-blis

Composable Kernel Library Installation

Composable Kernel aims to provide a programming model for writing performance critical kernels for machine learning workloads across multiple architectures including GPUs, CPUs, etc, through general purpose kernel languages, like HIP C++. Composable Kernel can be downloaded from the AMD ROCm Software Platform Repository (https://github.com/ROCmSoftwarePlatform/composable_kernel).

Composable Kernel Library Setup

Composable Kernel (CK) for CPU is currently only on the cpu_avx2 branch of the Composable Kernel repository and is at the experimental stage of development.

Prerequisites

CK is suitable for these compilers:

  1. hipclang: this is mainly used for compiling GPU hip kernels(require rocm environment), but also can be used for CPU. For a first trial use below compiler.
  2. gcc: at least gcc-9 is needed, you may need manually install a gcc-9 if ubuntu default is not gcc-9.

Download code

git clone https://github.com/ROCmSoftwarePlatform/composable_kernel.git
cd composable_kernel
git checkout origin/cpu_avx2 -b cpu_avx2

Compile

From the root directory of Composable Kernel (CK) build CK libraries:

# if use gcc
sh script/cmake-avx2-gcc.sh
cd build
make -j`nproc` example_cpu_conv2d_fwd example_cpu_conv2d_fwd_bias_relu_add

Link from ZenDNN

From the root directory of Composable Kernel (CK), this will set up the environment for including CK headers and linking to the CK libraries.

 export ZENDNN_CK_PATH=$(pwd)

The Makefile in this project contains a variable DEPEND_ON_CK which is set to 0 by default. To enable CK use DEPEND_ON_CK=1 when building the ZenDNN library.

Either modify DEPEND_ON_CK in the Makefile or pass DEPEND_ON_CK as an argument to make by editing scripts/zendnn_build.sh gcc.

The LD_LIBRARY_PATH variable needs to be updated in order to run code that depends on CK.

export LD_LIBRARY_PATH=${ZENDNN_CK_PATH}/build/lib:${LD_LIBRARY_PATH}

Runtime Dependencies

ZenDNN has the following runtime dependencies:

  • GNU C library (glibc.so)
  • GNU Standard C++ library (libstdc++.so)
  • Dynamic linking library (libdl.so)
  • POSIX Thread library (libpthread.so)
  • C Math Library (libm.so)
  • OpenMP (libomp.so)
  • Python v3.9-v3.12 for TensorFlow v2.17 (Plugin)
  • Python v3.8-v3.11 for PyTorch v2.4 (Plugin)
  • Python v3.8-v3.11 for ONNXRT v1.19.2

Since ZenDNN is configured to use OpenMP, a C++ compiler with OpenMP 2.0 or later is required for runtime execution.

Build from Source

Clone ZenDNN git:

git clone https://github.com/amd/ZenDNN.git
cd ZenDNN

GCC compiler

ZENDNN_BLIS_PATH should be defined. example:

export ZENDNN_BLIS_PATH=/home/<user-id>/my_work/amd-blis
make clean
source scripts/zendnn_build.sh gcc lpgemm_v5_0

When new terminal is opened, user need to set up environment variables:

source scripts/zendnn_gcc_env_setup.sh

Please note above scripts must be sourced only from ZenDNN Folder.

Validate the build

After the library is built on Linux host, user can run unit tests using:

source scripts/runApiTest.sh

Corresponding tests are located in the tests/api_tests directory. These unit tests don't produce any information/logs in the terminal. Library logs can be enabled with:

ZENDNN_LOG_OPTS=ALL:2 source scripts/runApiTest.sh

Logs

Logging is disabled in the ZenDNN library by default. It can be enabled using the environment variable ZENDNN_LOG_OPTS before running any tests. Logging behavior can be specified by setting the environment variable ZENDNN_LOG_OPTS to a comma-delimited list of ACTOR:DBGLVL pairs.

The different ACTORS are as follows:

ACTORS Usage
ALGO Logs all algorithms executed
CORE Logs all the core ZenDNN library operations
API Logs all the ZenDNN API calls
TEST Logs used in API tests, functionality tests and regression tests
PROF Logs the performance of operations in millisecond
FWK Logs all the framework (TensorFlow, ONNXRT, and PyTorch) specific calls

For example:

  • To turn on info logging, use ZENDNN_LOG_OPTS=ALL:2
  • To turn off all logging, use ZENDNN_LOG_OPTS=ALL:-1
  • To only log errors, use ZENDNN_LOG_OPTS=ALL:0
  • To only log info for ALGO, use ZENDNN_LOG_OPTS=ALL:-1,ALGO:2
  • To only log info for CORE, use ZENDNN_LOG_OPTS=ALL:-1,CORE:2
  • To only log info for API, use ZENDNN_LOG_OPTS=ALL:-1,API:2
  • To only log info for PROF (profile), use ZENDNN_LOG_OPTS=ALL:-1,PROF:2
  • To only log info for FWK, use ZENDNN_LOG_OPTS=ALL:-1,FWK:2

The Different Debug Levels (DBGLVL) are as follows:

enum LogLevel {
  LOG_LEVEL_DISABLED = -1,
  LOG_LEVEL_ERROR    =  0,
  LOG_LEVEL_WARNING  =  1,
  LOG_LEVEL_INFO     =  2,
  LOG_LEVEL_VERBOSE0 =  3,
  LOG_LEVEL_VERBOSE1 =  4,
  LOG_LEVEL_VERBOSE2 =  5
};

License

Refer to the "LICENSE" file for the full license text and copyright notice.

This distribution includes third party software governed by separate license terms.

This third party software, even if included with the distribution of the Advanced Micro Devices software, may be governed by separate license terms, including without limitation, third party license terms, and open source software license terms. These separate license terms govern your use of the third party programs as set forth in the THIRD-PARTY-PROGRAMS file.

Technical Support

Please email [email protected] for questions, issues, and feedback on ZenDNN.

Please submit your questions, feature requests, and bug reports on the GitHub issues page.