diff --git a/doc/getstarted/build_and_install/build_from_source_en.md b/doc/getstarted/build_and_install/build_from_source_en.md index aaa07d49d3148266db27670a98c2b27db4dc0a8f..1980c3624df359aa1c2a46f7160f984657ab634d 100644 --- a/doc/getstarted/build_and_install/build_from_source_en.md +++ b/doc/getstarted/build_and_install/build_from_source_en.md @@ -11,32 +11,21 @@ You can download PaddlePaddle from the [github source](https://github.com/Paddle ```bash git clone https://github.com/PaddlePaddle/Paddle paddle cd paddle -git submodule update --init --recursive ``` - -If you already have a local PaddlePaddle repo and have not initialized the submodule, your local submodule folder will be empty. You can simply run the last line of the above codes in your PaddlePaddle home directory to initialize your submodule folder. - -If you have already initialized your submodule and you would like to sync with the upstream submodule repo, you can run the following command -``` -git submodule update --remote -``` - ## Requirements 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) -- **CMake**: version >= 2.8 +- **CMake**: version >= 3.0 - **BLAS**: MKL, OpenBlas or ATLAS -- **Protocol Buffers**: version >= 2.4, **Note: 3.x is not supported** -- **Python**: only python 2.7 is supported currently **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. To enable it, first you need to install the related libraries. +PaddlePaddle supports some build options.
WITH_GPU | Compile with GPU mode. |
WITH_DOUBLE | Compile with double precision floating-point, default: single precision. |
WITH_TESTING | Compile with gtest for PaddlePaddle's unit testing. |
WITH_DOC | Compile to generate PaddlePaddle's docs, default: disabled (OFF). |
WITH_SWIG_PY | Compile with python predict API, default: disabled (OFF). |
WITH_STYLE_CHECK | Compile with code style check, default: enabled (ON). |
WITH_GPU | Compile PaddlePaddle with NVIDIA GPU |
WITH_AVX | Compile PaddlePaddle with AVX intrinsics |
WITH_DSO | Compile PaddlePaddle with dynamic linked CUDA |
WITH_TESTING | Compile PaddlePaddle with unit testing |
WITH_SWIG_PY | Compile PaddlePaddle with inference api |
WITH_STYLE_CHECK | Compile PaddlePaddle with style check |
WITH_PYTHON | Compile PaddlePaddle with python interpreter |
WITH_DOUBLE | Compile PaddlePaddle with double precision |
WITH_RDMA | Compile PaddlePaddle with RDMA support |
WITH_TIMER | Compile PaddlePaddle with stats timer |
WITH_PROFILER | Compile PaddlePaddle with GPU profiler |
WITH_DOC | Compile PaddlePaddle with documentation |
ON_COVERALLS | Compile PaddlePaddle with code coverage |
COVERALLS_UPLOAD | Package code coverage data to coveralls |
ON_TRAVIS | Exclude special unit test on Travis CI |