Appendix

Compile Dependency Table

Dependency package name Version Description Installation command
CMake 3.4
GCC 4.8 / 5.4 recommends using devtools2 for CentOS
Clang (MacOS Only) 9.0 and above Usually use the clang version of MacOS 10.11 and above
Python(64 bit) 2.7.x. or 3.5+.x depends on libpython2.7.so or libpython3.5+.so apt install python-dev or yum install python-devel if installing python3, please go to Python official website
SWIG at least 2.0 apt install swig or yum install swig
wget any apt install wget or yum install wget
openblas any optional
pip at least 9.0.1 apt install python-pip or yum install Python-pip
numpy >=1.12.0 pip install numpy
protobuf >=3.1.0 pip install protobuf
wheel any pip install wheel
patchELF any apt install patchelf or read github patchELF official documentation
go >=1.8 optional
setuptools >= 28.0.0
unrar brew install unrar (For MacOS), apt-get install unrar (For Ubuntu)



Compile Option Table

BLAS

PaddlePaddle supports two BLAS libraries, MKL and OpenBlAS. MKL is used by default. If you use MKL and the machine contains the AVX2 instruction set, you will also download the MKL-DNN math library, for details please refer to here.

If you close MKL, OpenBLAS will be used as the BLAS library.

CUDA/cuDNN

PaddlePaddle automatically finds the CUDA and cuDNN libraries installed in the system for compilation and execution at compile time/runtime. Use the parameter -DCUDA_ARCH_NAME=Auto to specify to enable automatic detection of the SM architecture and speed up compilation.

PaddlePaddle can be compiled and run using any version after cuDNN v5.1, but try to keep the same version of cuDNN in the compiling and running processes. We recommend using the latest version of cuDNN.

Configure Compile Options

PaddePaddle implements references to various BLAS/CUDA/cuDNN libraries by specifying paths at compile time. When cmake compiles, it first searches the system paths ( /usr/liby and /usr/local/lib ) for these libraries, and also reads the relevant path variables for searching. Can be set by using the -D command, for example:

Cmake .. -DWITH_GPU=ON -DWITH_TESTING=OFF -DCUDNN_ROOT=/opt/cudnnv5

Note: The settings introduced here for these compilation options are only valid for the first cmake. If you want to reset it later, it is recommended to clean up the entire build directory ( rm -rf ) and then specify it.



Installation Package List

Option Description Default
WITH_GPU Whether to support GPU ON
WITH_DSO whether to load CUDA dynamic libraries dynamically at runtime, instead of statically loading CUDA dynamic libraries. ON
WITH_AVX whether to compile PaddlePaddle binaries file containing the AVX instruction set ON
WITH_PYTHON Whether the PYTHON interpreter is embedded ON
WITH_TESTING Whether to turn on unit test OFF
WITH_MKL Whether to use the MKL math library, if not,using OpenBLAS ON
WITH_SYSTEM_BLAS Whether to use the system's BLAS OFF
WITH_DISTRIBUTE Whether to Compile with distributed version OFF
WITH_BRPC_RDMA Whether to use BRPC RDMA as RPC protocol OFF
ON_INFER Whether to turn on prediction optimization OFF
CUDA_ARCH_NAME Compile only for current CUDA schema or not All:Compile all supported CUDA architectures optional: Auto automatically recognizes the schema compilation of the current environment
TENSORRT_ROOT Specify TensorRT path The default value under windows is '/', The default value under windows is '/usr/'
Version Number Release Discription
paddlepaddle==[version code] such as paddlepaddle==1.8.4 Only support the corresponding version of the CPU PaddlePaddle, please refer to Pypi for the specific version.
paddlepaddle-gpu==[version code], such as paddlepaddle-gpu==1.8.4 The default installation supports the PaddlePaddle installation package corresponding to [version number] of CUDA 10.0 and cuDNN 7
paddlepaddle-gpu==[version code].postXX, such as paddlepaddle-gpu==1.8.4.post97 Installation package supporting the corresponding PaddlePaddle version of CUDA 9.0 and cuDNN 7

You can find various distributions of PaddlePaddle-gpu in the Release History.

‘postxx’ corresponds to CUDA and cuDNN versions, and the number before ‘postxx’ represents the version of Paddle

Please note that: in the commands, paddlepaddle-gpu will install the installation package of PaddlePaddle that supports CUDA 10.0 and cuDNN 7 by default under Windows environment.



Multi-version whl package list - Release

Release Instruction cp27-cp27mu cp27-cp27m cp35-cp35m cp36-cp36m cp37-cp37m
cpu-mkl paddlepaddle-1.8.4-cp27-cp27mu-linux_x86_64.whl paddlepaddle-1.8.4-cp27-cp27m-linux_x86_64.whl paddlepaddle-1.8.4-cp35-cp35m-linux_x86_64.whl paddlepaddle-1.8.4-cp36-cp36m-linux_x86_64.whl paddlepaddle-1.8.4-cp37-cp37m-linux_x86_64.whl
cpu-openblas paddlepaddle-1.8.4-cp27-cp27mu-linux_x86_64.whl paddlepaddle-1.8.4-cp27-cp27m-linux_x86_64.whl paddlepaddle-1.8.4-cp35-cp35m-linux_x86_64.whl paddlepaddle-1.8.4-cp36-cp36m-linux_x86_64.whl paddlepaddle-1.8.4-cp37-cp37m-linux_x86_64.whl
cuda9-cudnn7-openblas paddlepaddle_gpu-1.8.4-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp35-cp35m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp36-cp36m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp37-cp37m-linux_x86_64.whl
cuda9-cudnn7-mkl paddlepaddle_gpu-1.8.4-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp35-cp35m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp36-cp36m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp37-cp37m-linux_x86_64.whl
cuda10_cudnn7-mkl paddlepaddle_gpu-1.8.4-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp35-cp35m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp36-cp36m-linux_x86_64.whl paddlepaddle_gpu-1.8.4-cp37-cp37m-linux_x86_64.whl
win_cpu_mkl - paddlepaddle-1.8.4-cp27-cp27m-win_amd64.whl paddlepaddle-1.8.4-cp35-cp35m-win_amd64.whl paddlepaddle-1.8.4-cp36-cp36m-win_amd64.whl paddlepaddle-1.8.4-cp37-cp37m-win_amd64.whl
win_cuda9_cudnn7_mkl - paddlepaddle_gpu-1.8.4-cp27-cp27m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp35-cp35m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp36-cp36m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp37-cp37m-win_amd64.whl
win_cuda10_cudnn7_mkl - paddlepaddle_gpu-1.8.4-cp27-cp27m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp35-cp35m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp36-cp36m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp37-cp37m-win_amd64.whl
win_cpu_openblas - paddlepaddle-1.8.4-cp27-cp27m-win_amd64.whl paddlepaddle-1.8.4-cp35-cp35m-win_amd64.whl paddlepaddle-1.8.4-cp36-cp36m-win_amd64.whl paddlepaddle-1.8.4-cp37-cp37m-win_amd64.whl
win_cuda9_cudnn7_openblas - paddlepaddle_gpu-1.8.4-cp27-cp27m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp35-cp35m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp36-cp36m-win_amd64.whl paddlepaddle_gpu-1.8.4-cp37-cp37m-win_amd64.whl
mac_cpu - paddlepaddle-1.8.4-cp27-cp27m-macosx_10_6_intel.whl paddlepaddle-1.8.4-cp35-cp35m-macosx_10_6_intel.whl paddlepaddle-1.8.4-cp36-cp36m-macosx_10_6_intel.whl paddlepaddle-1.8.4-cp37-cp37m-macosx_10_6_intel.whl

Table instruction

  • Vertical axis

cpu-mkl: Support CPU training and prediction, use Intel MKL math library

cpu-openblas: Support CPU training and prediction, use openblas math library

cuda9-cudnn7-openblas: Support GPU training and prediction, use openblas math library

cuda9_cudnn7-mkl: Support GPU training and prediction, use Intel MKL math library

cuda10_cudnn7-mkl: Support GPU training and prediction, use Intel MKL math library

  • Transverse axis

Generally, it is similar to “cp27-cp27mu”, in which:

27:python tag, refers to python2. Similarly, there are “35”, “36”, “37”, etc

mu:refers to unicode version python, if it is m, refers to non Unicode version Python

  • Installation package naming rules

Each installation package has a unique name. They are named according to the official rules of Python. The form is as follows:

{distribution}-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl

The build tag can be missing, and other parts cannot be missing

distribution: wheel name

version: Version, for example 0.14.0 (must be in numeric format)

python tag: similar to ‘py27’, ‘py2’, ‘py3’, used to indicate the corresponding Python version

abi tag: similar to ‘cp33m’, ‘abi3’, ‘none’

platform tag: similar to ‘linux_x86_64’, ‘any’



Execute the PaddlePaddle training program in Docker

Suppose you have written a PaddlePaddle program in the current directory (such as /home/work): train.py ( refer to PaddlePaddleBook to write), you can start the training with the following command:

cd /home/work
docker run -it -v $PWD:/work hub.baidubce.com/paddlepaddle/paddle /work/train.py

In the above commands, the -it parameter indicates that the container has been run interactively; -v $PWD:/work specifies that the current path (the absolute path where the PWD variable in Linux will expand to the current path) is mounted to the :/work directory inside the container: Hub.baidubce.com/paddlepaddle/paddle specifies the container to be used; finally /work/train.py is the command executed inside the container, ie. the training program.

Of course, you can also enter into the Docker container and execute or debug your code interactively:

docker run -it -v $PWD:/work hub.baidubce.com/paddlepaddle/paddle /bin/bash
cd /work
python train.py

**Note: In order to reduce the size, vim is not installed in PaddlePaddle Docker image by default. You can edit the code in the container after executing ** apt-get install -y vim (which installs vim for you) in the container.



Start PaddlePaddle Book tutorial with Docker

Use Docker to quickly launch a local Jupyter Notebook containing the PaddlePaddle official Book tutorial, which can be viewed on the web. PaddlePaddle Book is an interactive Jupyter Notebook for users and developers. If you want to learn more about deep learning, PaddlePaddle Book is definitely your best choice. You can read tutorials or create and share interactive documents with code, formulas, charts, and text.

We provide a Docker image that can run the PaddlePaddle Book directly, running directly:

docker run -p 8888:8888 hub.baidubce.com/paddlepaddle/book

Domestic users can use the following image source to speed up access:

docker run -p 8888:8888 hub.baidubce.com/paddlepaddle/book

Then enter the following URL in your browser:

http://localhost:8888/

It’s that simple and bon voyage! For further questions, please refer to the FAQ.



Perform GPU training using Docker

In order to ensure that the GPU driver works properly in the image, we recommend using nvidia-docker to run the image. Don’t forget to install the latest GPU drivers on your physical machine in advance.

Nvidia-docker run -it -v $PWD:/work hub.baidubce.com/paddlepaddle/paddle:latest-gpu /bin/bash

Note: If you don’t have nvidia-docker installed, you can try the following to mount the CUDA library and Linux devices into the Docker container:

export CUDA_SO="$(\ls /usr/lib64/libcuda* | xargs -I{} echo '-v {}:{}') \
$(\ls /usr/lib64/libnvidia* | xargs -I{} echo '-v {}:{}')"
export DEVICES=$(\ls /dev/nvidia* | xargs -I{} echo '--device {}:{}')
docker run ${CUDA_SO} \
  ${DEVICES} -it hub.baidubce.com/paddlepaddle/paddle:latest-gpu