Install on MacOS

This instruction will show you how to install PaddlePaddle on a 64-bit desktop or laptop and MacOS system. The MacOS system we support must meet the following requirements.

Please note: Attempts on other systems may cause the installation to fail.

  • MacOS 10.11/10.12/10.13/10.14

Determine which version to install

  • Only PaddlePaddle for CPU is supported.

Choose an installation method

Under the MacOS system we offer 3 installation methods:

  • Pip installation (not supported for GPU version) (distributed architecture is not supported under python3)
  • Docker installation (the GPU version is not supported) (the version of python in the image is 2.7)
  • Docker source compilation and installation (not supported for GPU version) (Python version 2.7, 3.5, 3.6, 3.7 in image)

With pip installation (the easiest way to install), we offer you a pip installation method, but it depends more on your local environment and may have some issues related to your local environment.

Use Docker for installation (the safest way to install), because we have installed the tools and configuration in a Docker image so that if something goes wrong, others can reproduce the problem for help. In addition, for developers accustomed to using Windows and MacOS, there is no need to configure a cross-compilation environment using Docker. It should be emphasized that Docker does not virtualize any hardware. The compiler tools running in the Docker container are actually running directly on the local CPU and operating system. The performance is the same as installing the compiler on the machine.



Install using pip

Due to the large difference in Python situation in MacOS, we do not provide quick installation commands. Please follow the steps below to install.

First, check whether your computer and operating system meet our supported compilation standards or not by uname -m and view the system version About This Mac in the Apple menu.

Second, your computer needs to meet the following requirements:

Please do not use the Python originally provided by MacOS. For Python 2, we recommend Python2.7.15 provided by Homebrew or Python.org. For Python3, please use python3.5.x, Python3.6.x or python3.7.x provided by Python.org.

    For python2: brew install python@2 or use Python officially downloaded python2.7.15
    For python3: Use python3.5.x, python3.6.x or python3.7.x downloaded from Python official site
  • Python2.7.x, Pip >= 9.0.1

  • Python3.5.x, Pip3 >= 9.0.1

  • Python3.6.x, Pip3 >= 9.0.1

  • Python3.7.x, Pip3 >= 9.0.1

    Note: You may have installed pip on your MacOS. Please use pip -V to confirm that its version is the recommended pip 9.0.1 or higher.

Here's how to install PaddlePaddle:

  1. Use pip install to install PaddlePaddle:

    • For users who need the CPU version PaddlePaddle: pip install paddlepaddle or pip3 install paddlepaddle

    • For users with other requirements: pip install paddlepaddle==[version number] or pip3 install paddlepaddle==[version number]

    For the version number, please refer to the latest Release installation package list. If you need to obtain and install the latest PaddlePaddle development branch, you can download the latest whl installation package and c-api development package from the CI system and install it. To log in, click on "Log in as guest".

Now you have completed the process of installing PaddlePaddle via pip install.



Install using Docker

In order to better use Docker and avoid problems, we recommend using the highest version of Docker. For details on installing and using Docker, please refer to the official Docker documentation.

Please note that running docker on MacOS requires logging in with your dockerID, otherwise an Authenticate Failed error will occur.

If Docker is properly installed, you can start using Docker to install PaddlePaddle.

  1. Use the following command to pull the image we pre-installed for PaddlePaddle:

    • For users who need the CPU version of PaddlePaddle, use the following command to pull the image we pre-installed for your PaddlePaddle For CPU:

      Docker pull hub.baidubce.com/paddlepaddle/paddle: 1.2

    • You can also pull any of our Docker images by following the instructions below:

      Docker pull hub.baidubce.com/paddlepaddle/paddle:[tag]

      (Please replace [tag] with the contents of the mirror table)

  2. Use the following command to build from the already pulled image and enter the Docker container:

    Docker run --name [Name of container] -it -v $PWD:/paddle <imagename> /bin/bash

    In the above command, --name [Name of container] sets the name of the Docker; the -it parameter indicates that the container is running interactively with the host machine; -v $PWD:/paddle specifies the current path (the PWD variable in Linux will expand to The absolute path ) of the current path is mounted to the /paddle directory inside the container; <imagename> specifies the name of the image to use, if you need to use our image please use hub.baidubce.com/paddlepaddle/paddle:[tag]. Note: The meaning of tag is the same as the second step; /bin/bash is the command to be executed in Docker.

  3. (Optional: When you need to enter the Docker container a second time) re-enter the PaddlePaddle container with the following command:

    Docker start [Name of container]

    start the container created previously.

    Docker attach [Name of container]

    Enter the started container.

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.

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 in the container.



Verify installation

After the installation is complete, you can use python or python3 to enter the python interpreter and then use import paddle.fluid to verify that 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