Paddle/doc/getstarted/build_and_install/build_from_source_en.md

Installing from Sources
==========================

* [1. Download and Setup](#download)
* [2. Requirements](#requirements)
* [3. Build on Ubuntu](#ubuntu)
* [4. Build on Centos](#centos)


## <span id="download">Download and Setup</span> 
You can download PaddlePaddle from the [github source](https://github.com/PaddlePaddle/Paddle).

```bash
git clone https://github.com/PaddlePaddle/Paddle paddle
cd paddle
```
## <span id="requirements">Requirements</span>

To compile the source code, your computer must be equipped with the following dependencies.

- **Compiler**: GCC >= 4.8 or Clang >= 3.3 (AppleClang >= 5.1) and gfortran compiler
- **CMake**: CMake >= 3.0 (at least CMake 3.4 on Mac OS X)
- **BLAS**: MKL, OpenBlas or ATLAS
- **Python**: only support Python 2.7
- **Go**

**Note:** For CUDA 7.0 and CUDA 7.5, GCC 5.0 and up are not supported!
For CUDA 8.0, GCC versions later than 5.3 are not supported!

### Options

PaddlePaddle supports some build options. 

<html>
<table> 
<thead>
<tr>
<th scope="col" class="left">Optional</th>
<th scope="col" class="left">Description</th>
</tr>
</thead>
<tbody>
<tr><td class="left">WITH_GPU</td><td class="left">Compile PaddlePaddle with NVIDIA GPU</td></tr>
<tr><td class="left">WITH_AVX</td><td class="left">Compile PaddlePaddle with AVX intrinsics</td></tr>
<tr><td class="left">WITH_DSO</td><td class="left">Compile PaddlePaddle with dynamic linked CUDA</td></tr>
<tr><td class="left">WITH_TESTING</td><td class="left">Compile PaddlePaddle with unit testing</td></tr>
<tr><td class="left">WITH_SWIG_PY</td><td class="left">Compile PaddlePaddle with inference api</td></tr>
<tr><td class="left">WITH_STYLE_CHECK</td><td class="left">Compile PaddlePaddle with style check</td></tr>
<tr><td class="left">WITH_PYTHON</td><td class="left">Compile PaddlePaddle with python interpreter</td></tr>
<tr><td class="left">WITH_DOUBLE</td><td class="left">Compile PaddlePaddle with double precision</td></tr>
<tr><td class="left">WITH_RDMA</td><td class="left">Compile PaddlePaddle with RDMA support</td></tr>
<tr><td class="left">WITH_TIMER</td><td class="left">Compile PaddlePaddle with stats timer</td></tr>
<tr><td class="left">WITH_PROFILER</td><td class="left">Compile PaddlePaddle with GPU profiler</td></tr>
<tr><td class="left">WITH_DOC</td><td class="left">Compile PaddlePaddle with documentation</td></tr>
<tr><td class="left">WITH_COVERAGE</td><td class="left">Compile PaddlePaddle with code coverage</td></tr>
<tr><td class="left">COVERALLS_UPLOAD</td><td class="left">Package code coverage data to coveralls</td></tr>
<tr><td class="left">ON_TRAVIS</td><td class="left">Exclude special unit test on Travis CI</td></tr>
</tbody>
</table>
</html>

**Note:**
  - The GPU version works best with Cuda Toolkit 8.0 and cuDNN v5.
  - Other versions like Cuda Toolkit 7.0, 7.5 and cuDNN v3, v4 are also supported.
  - **To utilize cuDNN v5, Cuda Toolkit 7.5 is prerequisite and vice versa.**

As a simple example, consider the following:  

1. **BLAS Dependencies(optional)**
  
    CMake will search BLAS libraries from system. If not found, OpenBLAS will be downloaded, built and installed automatically.
    To utilize preinstalled BLAS， you can simply specify MKL, OpenBLAS or ATLAS via `MKL_ROOT`, `OPENBLAS_ROOT` or `ATLAS_ROOT`.

    ```bash
    # specify MKL
    cmake .. -DMKL_ROOT=<mkl_path>
    # or specify OpenBLAS
    cmake .. -DOPENBLAS_ROOT=<openblas_path>
    ```

2. **Doc Dependencies(optional)**

    To generate PaddlePaddle's documentation, install dependencies and set `-DWITH_DOC=ON` as follows:

    ```bash
    pip install 'sphinx>=1.4.0'
    pip install sphinx_rtd_theme recommonmark

    # install doxygen on Ubuntu
    sudo apt-get install doxygen 
    # install doxygen on Mac OS X
    brew install doxygen

    # active docs in cmake
    cmake .. -DWITH_DOC=ON`
    ```

## <span id="ubuntu">Build on Ubuntu 14.04</span>

### Install Dependencies

- **Paddle Dependencies**

    ```bash
    # necessary
    sudo apt-get update
    sudo apt-get install -y git curl gcc g++ gfortran make build-essential automake
    sudo apt-get install -y python python-pip python-numpy libpython-dev bison
    sudo pip install 'protobuf==3.1.0.post1'

    # Install Go
    # You can follow https://golang.org/doc/install for a detailed explanation.
    wget -O go.tgz https://storage.googleapis.com/golang/go1.8.1.linux-amd64.tar.gz && \
    tar -C $HOME -xzf go.tgz && \
    mkdir $HOME/gopath && \
    rm go.tgz

    # Setup environment variables
    export GOROOT=$HOME/go
    export GOPATH=$HOME/gopath
    export PATH=$PATH:$GOROOT/bin

    # install cmake 3.4
    curl -sSL https://cmake.org/files/v3.4/cmake-3.4.1.tar.gz | tar -xz && \
        cd cmake-3.4.1 && ./bootstrap && make -j4 && sudo make install && \
        cd .. && rm -rf cmake-3.4.1
    ```

- **GPU Dependencies (optional)**

    To build GPU version, you will need the following installed:

        1. a CUDA-capable GPU
        2. A supported version of Linux with a gcc compiler and toolchain
        3. NVIDIA CUDA Toolkit (available at http://developer.nvidia.com/cuda-downloads)
        4. NVIDIA cuDNN Library (availabel at https://developer.nvidia.com/cudnn)

    The CUDA development environment relies on tight integration with the host development environment,
    including the host compiler and C runtime libraries, and is therefore only supported on
    distribution versions that have been qualified for this CUDA Toolkit release.
        
    After downloading cuDNN library, issue the following commands:

    ```bash
    sudo tar -xzf cudnn-7.5-linux-x64-v5.1.tgz -C /usr/local
    sudo chmod a+r /usr/local/cuda/include/cudnn.h /usr/local/cuda/lib64/libcudnn*
    ```
    Then you need to set LD\_LIBRARY\_PATH, PATH environment variables in ~/.bashrc.

    ```bash
    export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH
    export PATH=/usr/local/cuda/bin:$PATH
    ```

### Build and Install

As usual, the best option is to create build folder under paddle project directory.

```bash
mkdir build && cd build
``` 

Finally, you can build and install PaddlePaddle:

```bash
# you can add build option here, such as:    
cmake .. -DCMAKE_INSTALL_PREFIX=<path to install>
# please use sudo make install, if you want to install PaddlePaddle into the system
make -j `nproc` && make install
# set PaddlePaddle installation path in ~/.bashrc
export PATH=<path to install>/bin:$PATH
# install PaddlePaddle Python modules.
sudo pip install <path to install>/opt/paddle/share/wheels/*.whl
```
## <span id="centos">Build on Centos 7</span>

### Install Dependencies

- **CPU Dependencies**

    ```bash
    # necessary
    sudo yum update
    sudo yum install -y epel-release
    sudo yum install -y make cmake3 python-devel python-pip gcc-gfortran swig git
    sudo pip install wheel numpy
    sudo pip install 'protobuf>=3.0.0'
    ```
  
- **GPU Dependencies (optional)**

    To build GPU version, you will need the following installed:

        1. a CUDA-capable GPU
        2. A supported version of Linux with a gcc compiler and toolchain
        3. NVIDIA CUDA Toolkit (available at http://developer.nvidia.com/cuda-downloads)
        4. NVIDIA cuDNN Library (availabel at https://developer.nvidia.com/cudnn)

    The CUDA development environment relies on tight integration with the host development environment,
    including the host compiler and C runtime libraries, and is therefore only supported on
    distribution versions that have been qualified for this CUDA Toolkit release.
        
    After downloading cuDNN library, issue the following commands:

    ```bash
    sudo tar -xzf cudnn-7.5-linux-x64-v5.1.tgz -C /usr/local
    sudo chmod a+r /usr/local/cuda/include/cudnn.h /usr/local/cuda/lib64/libcudnn*
    ```
    Then you need to set LD\_LIBRARY\_PATH, PATH environment variables in ~/.bashrc.

    ```bash
    export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH
    export PATH=/usr/local/cuda/bin:$PATH
    ```

### Build and Install

As usual, the best option is to create build folder under paddle project directory.

```bash
mkdir build && cd build
``` 

Finally, you can build and install PaddlePaddle:

```bash
# you can add build option here, such as:    
cmake3 .. -DCMAKE_INSTALL_PREFIX=<path to install>
# please use sudo make install, if you want to install PaddlePaddle into the system
make -j `nproc` && make install
# set PaddlePaddle installation path in ~/.bashrc
export PATH=<path to install>/bin:$PATH
# install PaddlePaddle Python modules.
sudo pip install <path to install>/opt/paddle/share/wheels/*.whl
```
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								Installing from Sources
-												Update build docs (#149)

* Add automatic check AVX in CMake

* Add indent in FindAVX.cmake

* Revise table format and some words in build docs

* Update build docs

* Update build docs

											
										
										
											8 years ago
+								==========================
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								* [1. Download and Setup](#download)
 								* [2. Requirements](#requirements)
 								* [3. Build on Ubuntu](#ubuntu)
-												add centos build doc

											
										
										
											8 years ago
+								* [4. Build on Centos](#centos)
-												add build on MAC OSX docs

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								## <span id="download">Download and Setup</span>
-												Fix a wrong link in build doc
											
										
										
											8 years ago
+								You can download PaddlePaddle from the [github source](https://github.com/PaddlePaddle/Paddle).
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								```bash
-												Update build docs
											
										
										
											8 years ago
+								git clone https://github.com/PaddlePaddle/Paddle paddle
-												Add automatic check AVX in CMake (#145)

* Add automatic check AVX in CMake
* Revise table format and some words in build docs

											
										
										
											8 years ago
+								cd paddle
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								```
 								## <span id="requirements">Requirements</span>
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Add docs for compiler version

											
										
										
											8 years ago
+								To compile the source code, your computer must be equipped with the following dependencies.
-												Add gfortran in docker

											
										
										
											8 years ago
+								- **Compiler**: GCC >= 4.8 or Clang >= 3.3 (AppleClang >= 5.1) and gfortran compiler
-												Update dockerfiles for develop branch

											
										
										
											8 years ago
+								- **CMake**: CMake >= 3.0 (at least CMake 3.4 on Mac OS X)
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								- **BLAS**: MKL, OpenBlas or ATLAS
-												Update dockerfiles for develop branch

											
										
										
											8 years ago
+								- **Python**: only support Python 2.7
-												Add documentation for installing Go when building Paddle manually

											
										
										
											8 years ago
+								- **Go**
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Upgrade cuda minimum version to 7.0

											
										
										
											8 years ago
+								**Note:** For CUDA 7.0 and CUDA 7.5, GCC 5.0 and up are not supported!
 								For CUDA 8.0, GCC versions later than 5.3 are not supported!
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								### Options
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update build and install docs

											
										
										
											8 years ago
+								PaddlePaddle supports some build options.
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update build docs (#149)

* Add automatic check AVX in CMake

* Add indent in FindAVX.cmake

* Revise table format and some words in build docs

* Update build docs

* Update build docs

											
										
										
											8 years ago
+								<html>
 								<table>
 								<thead>
 								<tr>
 								<th scope="col" class="left">Optional</th>
 								<th scope="col" class="left">Description</th>
 								</tr>
 								</thead>
 								<tbody>
-												Update build and install docs

											
										
										
											8 years ago
+								<tr><td class="left">WITH_GPU</td><td class="left">Compile PaddlePaddle with NVIDIA GPU</td></tr>
 								<tr><td class="left">WITH_AVX</td><td class="left">Compile PaddlePaddle with AVX intrinsics</td></tr>
 								<tr><td class="left">WITH_DSO</td><td class="left">Compile PaddlePaddle with dynamic linked CUDA</td></tr>
 								<tr><td class="left">WITH_TESTING</td><td class="left">Compile PaddlePaddle with unit testing</td></tr>
 								<tr><td class="left">WITH_SWIG_PY</td><td class="left">Compile PaddlePaddle with inference api</td></tr>
 								<tr><td class="left">WITH_STYLE_CHECK</td><td class="left">Compile PaddlePaddle with style check</td></tr>
 								<tr><td class="left">WITH_PYTHON</td><td class="left">Compile PaddlePaddle with python interpreter</td></tr>
 								<tr><td class="left">WITH_DOUBLE</td><td class="left">Compile PaddlePaddle with double precision</td></tr>
 								<tr><td class="left">WITH_RDMA</td><td class="left">Compile PaddlePaddle with RDMA support</td></tr>
 								<tr><td class="left">WITH_TIMER</td><td class="left">Compile PaddlePaddle with stats timer</td></tr>
 								<tr><td class="left">WITH_PROFILER</td><td class="left">Compile PaddlePaddle with GPU profiler</td></tr>
 								<tr><td class="left">WITH_DOC</td><td class="left">Compile PaddlePaddle with documentation</td></tr>
-												change ON_COVERALLS to WITH_COVERAGE

											
										
										
											8 years ago
+								<tr><td class="left">WITH_COVERAGE</td><td class="left">Compile PaddlePaddle with code coverage</td></tr>
-												Update build and install docs

											
										
										
											8 years ago
+								<tr><td class="left">COVERALLS_UPLOAD</td><td class="left">Package code coverage data to coveralls</td></tr>
 								<tr><td class="left">ON_TRAVIS</td><td class="left">Exclude special unit test on Travis CI</td></tr>
-												Update build docs (#149)

* Add automatic check AVX in CMake

* Add indent in FindAVX.cmake

* Revise table format and some words in build docs

* Update build docs

* Update build docs

											
										
										
											8 years ago
+								</tbody>
-												Update build docs (#148)

* Add automatic check AVX in CMake

* Add indent in FindAVX.cmake

* Revise table format and some words in build docs

* Update build docs

											
										
										
											8 years ago
+								</table>
-												Update build docs (#149)

* Add automatic check AVX in CMake

* Add indent in FindAVX.cmake

* Revise table format and some words in build docs

* Update build docs

* Update build docs

											
										
										
											8 years ago
+								</html>
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								**Note:**
-												Upgrade cuda minimum version to 7.0

											
										
										
											8 years ago
+								  - The GPU version works best with Cuda Toolkit 8.0 and cuDNN v5.
 								  - Other versions like Cuda Toolkit 7.0, 7.5 and cuDNN v3, v4 are also supported.
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								  - **To utilize cuDNN v5, Cuda Toolkit 7.5 is prerequisite and vice versa.**
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								As a simple example, consider the following:
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Add CBLAS in build doc

											
										
										
											8 years ago
+. **BLAS Dependencies(optional)**
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Add external openblas

											
										
										
											8 years ago
+								    CMake will search BLAS libraries from system. If not found, OpenBLAS will be downloaded, built and installed automatically.
 								    To utilize preinstalled BLAS， you can simply specify MKL, OpenBLAS or ATLAS via `MKL_ROOT`, `OPENBLAS_ROOT` or `ATLAS_ROOT`.
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    ```bash
-												Remove git submodule from docs

											
										
										
											8 years ago
+								    # specify MKL
 								    cmake .. -DMKL_ROOT=<mkl_path>
 								    # or specify OpenBLAS
 								    cmake .. -DOPENBLAS_ROOT=<openblas_path>
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    ```
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+. **Doc Dependencies(optional)**
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    To generate PaddlePaddle's documentation, install dependencies and set `-DWITH_DOC=ON` as follows:
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    ```bash
 								    pip install 'sphinx>=1.4.0'
-												remove breathe and doc/howto/source directory

											
										
										
											8 years ago
+								    pip install sphinx_rtd_theme recommonmark
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    # install doxygen on Ubuntu
 								    sudo apt-get install doxygen
 								    # install doxygen on Mac OS X
 								    brew install doxygen
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    # active docs in cmake
 								    cmake .. -DWITH_DOC=ON`
 								    ```
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								## <span id="ubuntu">Build on Ubuntu 14.04</span>
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								### Install Dependencies
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Add gfortran in docker

											
										
										
											8 years ago
+								- **Paddle Dependencies**
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    ```bash
 								    # necessary
 								    sudo apt-get update
-												Update build doc and dockerfile

											
										
										
											8 years ago
+								    sudo apt-get install -y git curl gcc g++ gfortran make build-essential automake
 								    sudo apt-get install -y python python-pip python-numpy libpython-dev bison
-												Add gfortran in docker

											
										
										
											8 years ago
+								    sudo pip install 'protobuf==3.1.0.post1'
-												Add documentation for installing Go when building Paddle manually

											
										
										
											8 years ago
+								    # Install Go
 								    # You can follow https://golang.org/doc/install for a detailed explanation.
 								    wget -O go.tgz https://storage.googleapis.com/golang/go1.8.1.linux-amd64.tar.gz && \
 								    tar -C $HOME -xzf go.tgz && \
 								    mkdir $HOME/gopath && \
 								    rm go.tgz
 								    # Setup environment variables
 								    export GOROOT=$HOME/go
 								    export GOPATH=$HOME/gopath
 								    export PATH=$PATH:$GOROOT/bin
-												Add gfortran in docker

											
										
										
											8 years ago
+								    # install cmake 3.4
 								    curl -sSL https://cmake.org/files/v3.4/cmake-3.4.1.tar.gz | tar -xz && \
 								        cd cmake-3.4.1 && ./bootstrap && make -j4 && sudo make install && \
 								        cd .. && rm -rf cmake-3.4.1
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    ```
-												Add gfortran in docker

											
										
										
											8 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								- **GPU Dependencies (optional)**
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    To build GPU version, you will need the following installed:
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+. a CUDA-capable GPU
 . A supported version of Linux with a gcc compiler and toolchain
 . NVIDIA CUDA Toolkit (available at http://developer.nvidia.com/cuda-downloads)
 . NVIDIA cuDNN Library (availabel at https://developer.nvidia.com/cudnn)
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    The CUDA development environment relies on tight integration with the host development environment,
 								    including the host compiler and C runtime libraries, and is therefore only supported on
 								    distribution versions that have been qualified for this CUDA Toolkit release.
 								    After downloading cuDNN library, issue the following commands:
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								    ```bash
 								    sudo tar -xzf cudnn-7.5-linux-x64-v5.1.tgz -C /usr/local
 								    sudo chmod a+r /usr/local/cuda/include/cudnn.h /usr/local/cuda/lib64/libcudnn*
 								    ```
-												Add automatic check AVX in CMake (#145)

* Add automatic check AVX in CMake
* Revise table format and some words in build docs

											
										
										
											8 years ago
+								    Then you need to set LD\_LIBRARY\_PATH, PATH environment variables in ~/.bashrc.
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
 								    ```bash
 								    export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH
 								    export PATH=/usr/local/cuda/bin:$PATH
 								    ```
 								### Build and Install
 								As usual, the best option is to create build folder under paddle project directory.
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
 								```bash
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								mkdir build && cd build
-												Update build and install docs

											
										
										
											8 years ago
+								```
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
-												Update build and install docs

											
										
										
											8 years ago
+								Finally, you can build and install PaddlePaddle:
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
 								```bash
 								# you can add build option here, such as:
-												Update build and install docs

											
										
										
											8 years ago
+								cmake .. -DCMAKE_INSTALL_PREFIX=<path to install>
-												Add automatic check AVX in CMake (#145)

* Add automatic check AVX in CMake
* Revise table format and some words in build docs

											
										
										
											8 years ago
+								# please use sudo make install, if you want to install PaddlePaddle into the system
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
+								make -j `nproc` && make install
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								# set PaddlePaddle installation path in ~/.bashrc
-												add install path to /opt/compiler/gcc-4.8.2/bin:/home/liaogang/.jumbo/opt/sun-java6/bin:/home/liaogang/.jumbo/opt/sun-java6/jre/bin:/home/liaogang/.jumbo/opt/sun-java6/db/bin:/home/liaogang/.jumbo/bin/core_perl:/home/liaogang/.jumbo/bin:/usr/local/ganglia/sbin:/usr/local/ganglia/bin:/usr/local/apr/bin:/usr/local/cuda/bin:/opt/compiler/gcc-4.8.2/bin:/home/liaogang/.jumbo/opt/sun-java6/bin:/home/liaogang/.jumbo/opt/sun-java6/jre/bin:/home/liaogang/.jumbo/opt/sun-java6/db/bin:/home/liaogang/.jumbo/bin/core_perl:/home/liaogang/.jumbo/bin:/usr/local/ganglia/sbin:/usr/local/ganglia/bin:/usr/local/apr/bin:/usr/local/cuda/bin:/usr/lib64/qt-3.3/bin:/usr/local/bin:/bin:/usr/bin:/opt/ibutils/bin:/opt/bin:/home/opt/bin:/usr/local/sbin:/usr/sbin:/sbin:/opt/bin:/home/opt/bin:/home/liaogang/bin
ISSUE=4594417

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1424 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
+								export PATH=<path to install>/bin:$PATH
-												Update build and install docs

											
										
										
											8 years ago
+								# install PaddlePaddle Python modules.
-												Update Mac OS X port
* follow comments to fix bugs

											
										
										
											9 years ago
+								sudo pip install <path to install>/opt/paddle/share/wheels/*.whl
-												fix dash and space bug,
ISSUE=4586495

git-svn-id: https://svn.baidu.com/idl/trunk/paddle@1408 1ad973e4-5ce8-4261-8a94-b56d1f490c56

											
										
										
											9 years ago
+								```
-												add centos build doc

											
										
										
											8 years ago
+								## <span id="centos">Build on Centos 7</span>
 								### Install Dependencies
 								- **CPU Dependencies**
 								    ```bash
 								    # necessary
 								    sudo yum update
 								    sudo yum install -y epel-release
 								    sudo yum install -y make cmake3 python-devel python-pip gcc-gfortran swig git
 								    sudo pip install wheel numpy
 								    sudo pip install 'protobuf>=3.0.0'
 								    ```
 								- **GPU Dependencies (optional)**
 								    To build GPU version, you will need the following installed:
 . a CUDA-capable GPU
 . A supported version of Linux with a gcc compiler and toolchain
 . NVIDIA CUDA Toolkit (available at http://developer.nvidia.com/cuda-downloads)
 . NVIDIA cuDNN Library (availabel at https://developer.nvidia.com/cudnn)
 								    The CUDA development environment relies on tight integration with the host development environment,
 								    including the host compiler and C runtime libraries, and is therefore only supported on
 								    distribution versions that have been qualified for this CUDA Toolkit release.
 								    After downloading cuDNN library, issue the following commands:
 								    ```bash
 								    sudo tar -xzf cudnn-7.5-linux-x64-v5.1.tgz -C /usr/local
 								    sudo chmod a+r /usr/local/cuda/include/cudnn.h /usr/local/cuda/lib64/libcudnn*
 								    ```
 								    Then you need to set LD\_LIBRARY\_PATH, PATH environment variables in ~/.bashrc.
 								    ```bash
 								    export LD_LIBRARY_PATH=/usr/local/cuda/lib64:$LD_LIBRARY_PATH
 								    export PATH=/usr/local/cuda/bin:$PATH
 								    ```
 								### Build and Install
 								As usual, the best option is to create build folder under paddle project directory.
 								```bash
 								mkdir build && cd build
 								```
 								Finally, you can build and install PaddlePaddle:
 								```bash
 								# you can add build option here, such as:
 								cmake3 .. -DCMAKE_INSTALL_PREFIX=<path to install>
 								# please use sudo make install, if you want to install PaddlePaddle into the system
 								make -j `nproc` && make install
 								# set PaddlePaddle installation path in ~/.bashrc
 								export PATH=<path to install>/bin:$PATH
 								# install PaddlePaddle Python modules.
 								sudo pip install <path to install>/opt/paddle/share/wheels/*.whl
 								```