Compile on MacOS from Source Code

Environment preparation

  • MacOS version 10.x/11.x (64 bit) (not support GPU version)

  • Python version 3.6/3.7/3.8/3.9 (64 bit)

  • pip or pip3 version 20.2.2 or above (64 bit)

Choose CPU/GPU

  • Currently, only PaddlePaddle for CPU is supported.

Installation steps

There are two compilation methods in MacOS system:

Compile with Docker

Docker is an open source application container engine. Using docker, you can not only isolate the installation and use of paddlepaddle from the system environment, but also share GPU, network and other resources with the host

Compiling PaddlePaddle with Docker,you need:

  • On the local host Install Docker

  • Log in to Docker with Docker ID to avoid Authenticate Failed error

Please follow the steps below to install:

1. Enter the terminal of the Mac

2. Please select the path where you want to store PaddlePaddle, and then use the following command to clone PaddlePaddle’s source code from github to a folder named Paddle in the local current directory:

git clone https://github.com/PaddlePaddle/Paddle.git

3. Go to the Paddle directory:

cd Paddle

4. Pull PaddlePaddle image

For domestic users, when downloading docker is slow due to network problems, you can use the mirror provided by Baidu:

  • CPU version of PaddlePaddle:

docker pull registry.baidubce.com/paddlepaddle/paddle:latest-dev

If your machine is not in mainland China, you can pull the image directly from DockerHub:

  • CPU version of PaddlePaddle:

docker pull paddlepaddle/paddle:latest-dev

You can see DockerHub to get the image that matches your machine.

5. Create and enter a Docker container that meets the compilation environment:

docker run --name paddle-test -v $PWD:/paddle --network=host -it registry.baidubce.com/paddlepaddle/paddle:latest-dev /bin/bash
  • --name paddle-test: name the Docker container you created as paddle-test,

  • -v $PWD:/paddle: mount the current directory to the /paddle directory in the Docker container (the PWD variable in Linux will expand to the current path’s Absolute path),

  • -it: keeps interacting with the host;

  • registry.baidubce.com/paddlepaddle/paddle:latest-dev: creates a Docker container with a mirror named registry.baidubce.com/paddlepaddle/paddle:latest-dev, /bin /bash starts the /bin/bash command after entering the container.

6. After entering Docker, go to the paddle directory:

cd paddle

7. Switch to a more stable version to compile:

git checkout [name of the branch]

For example:

git checkout release/2.2

Note: python3.6、python3.7 version started supporting from release/1.2 branch, python3.8 version started supporting from release/1.8 branch, python3.9 version started supporting from release/2.1 branch

8. Create and enter the /paddle/build path:

mkdir -p /paddle/build && cd /paddle/build

9. Use the following command to install the dependencies:

Install protobuf 3.1.0.

pip3.7 install protobuf==3.1.0

Note: We used Python3.7 command as an example above, if the version of your Python is 3.6/3.8/3.9, please change pip3.7 in the commands to pip3.6/pip3.8/pip3.9

Installing patchelf, PatchELF is a small and useful program for modifying the dynamic linker and RPATH of ELF executables.

apt install patchelf

10. Execute cmake:

  • For users who need to compile the CPU version PaddlePaddle (We currently do not support the compilation of the GPU version PaddlePaddle under MacOS):

    cmake .. -DPY_VERSION=3.7 -DWITH_GPU=OFF -DWITH_TESTING=OFF -DWITH_AVX=OFF -DCMAKE_BUILD_TYPE=Release
    

For details on the compilation options, see the compilation options table.

Please attention to modify parameters -DPY_VERSION for the version of Python you want to compile with, for example -DPY_VERSION=3.7 means the version of python is 3.7

11. Execute compilation:

Use multicore compilation

make -j$(nproc)

12. After compiling successfully, go to the /paddle/build/python/dist directory and find the generated .whl package:

cd /paddle/build/python/dist

13. Install the compiled .whl package on the current machine or target machine: (For Python3: Please select the pip corresponding to the python version you wish to use, such as pip3.6)

For Python3:

pip3.7 install -U [whl package name]

Note: We used Python3.7 command as an example above, if the version of your Python is 3.6/3.8/3.9, please change pip3.7 in the commands to pip3.6/pip3.8/pip3.9

Congratulations, now that you have successfully installed PaddlePaddle using Docker, you only need to run PaddlePaddle after entering the Docker container. For more Docker usage, please refer to the official Docker documentation.



Local compilation

Please strictly follow the order of the following instructions

1. Check that your computer and operating system meet our supported compilation standards: uname -m and view the system version about this Mac. And install OpenCV in advance.

2. Install python and pip:

Please do not use the Python initially given by MacOS, we strongly recommend that you use Homebrew to install python (for Python3 please use python official download python3.6.x, python3.7.x, python3.8, python3.9), pip and other dependencies, This will greatly reduce the difficulty of installing and compiling.

Install using Python official website

Please note that when you have multiple pythons installed on your mac, make sure that the python you are using is the python you wish to use.

5. Put the PaddlePaddle source cloned in the Paddle folder in the current directory and go to the Paddle directory:

git clone https://github.com/PaddlePaddle/Paddle.git
cd Paddle

6. Switch to a more stable release branch to compile: (Note that python 3.6, python 3.7 version are supported from the 1.2 branch, python3.8 version started supporting from release/1.8 branch, python3.9 version started supporting from release/2.1 branch)

git checkout [name of the branch]

For example:

git checkout release/2.2

7. And please create and enter a directory called build:

mkdir build && cd build

8. Execute cmake:

For details on the compilation options, see the compilation options table.

  • For users who need to compile the CPU version PaddlePaddle:

    cmake .. -DPY_VERSION=3.7 -DPYTHON_INCLUDE_DIR=${PYTHON_INCLUDE_DIRS} \
    -DPYTHON_LIBRARY=${PYTHON_LIBRARY} -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release
    
  • -DPY_VERSION=3.7 Please change to the Python version of the installation environment.

9. Compile with the following command:

make -j4

10. After compiling successfully, go to the /paddle/build/python/dist directory and find the generated .whl package:

cd /paddle/build/python/dist

11. Install the compiled .whl package on the current machine or target machine:

pip install -U (whl package name)

or

pip3 install -U (whl package name)

Congratulations, now you have completed the process of compiling PaddlePaddle using this machine.



Verify installation

After the installation is complete, you can use python or python3 to enter the Python interpreter and then use

import paddle

and then

paddle.utils.run_check()

to verify that the installation was successful.

If PaddlePaddle is installed successfully! appears, it means the installation was successful.



How to uninstall

Please use the following command to uninstall PaddlePaddle (users who use Docker to install PaddlePaddle should use the following command in the container containing PaddlePaddle. Please use the corresponding version of pip):

  • CPU version of PaddlePaddle:

    pip uninstall paddlepaddle
    

    or

    pip3 uninstall paddlepaddle
    

Users installing PaddlePaddle with Docker, please use above commands in the container involved PaddlePaddle and attention to use the corresponding version of Pip