diff --git a/doc/fluid/beginners_guide/install/FAQ_en.md b/doc/fluid/beginners_guide/install/FAQ_en.md new file mode 100644 index 0000000000000000000000000000000000000000..b3218c85ee647e3daf7b08c80c23ed9b10ed3c02 --- /dev/null +++ b/doc/fluid/beginners_guide/install/FAQ_en.md @@ -0,0 +1,130 @@ +*** + + +# **FAQ** + +- How to compile python2.7 as a shared library under CentOS6? + + > Use the following instructions: + + + + ./configure --prefix=/usr/local/python2.7 --enable-shared + make && make install + + +- Ubuntu18.04 under libidn11 can not be found? + + > Use the following instructions: + + apt install libidn11 + +- When Ubuntu compiles, a lot of code segments are not recognized? + + > This may be caused by a mismatch in the cmake version. Please use the following command in the gcc installation directory: + + apt install gcc-4.8 g++-4.8 + cp gcc gcc.bak + cp g++ g++.bak + rm gcc + rm g++ + ln -s gcc-4.8 gcc + ln -s g++-4.8 g++ + + + + +- Encountered paddlepaddle*.whl is not a supported wheel on this platform? + + > The main reason for this problem is that there is no paddlepaddle installation package that matches the current system. Please check if the Python version is 2.7 series. In addition, the latest pip official source installation package defaults to the manylinux1 standard, you need to use the latest pip (>9.0.0) to install. You can update your pip by following these instructions: + + pip install --upgrade pip + or + + python -c "import pip; print(pip.pep425tags.get_supported())" + + > If the system supports linux_x86_64 and the installation package is manylinux1_x86_64, you need to upgrade the pip version to the latest; if the system supports manylinux1_x86_64 and the installation package (local) is linux_x86_64, you can rename this whl package to manylinux1_x86_64 and install it again. + +- Is there a problem with Docker compilation? + + > Please refer to [Issue12079](https://github.com/PaddlePaddle/Paddle/issues/12079) on GitHub. + +- What is Docker? + + > If you haven't heard of Docker, you can think of it as a virtualenv-like system, but it virtualises more than the Python runtime environment. + +- Is Docker still a virtual machine? + + > Someone uses a virtual machine to analogize to Docker. It should be emphasized that Docker does not virtualize any hardware. The compiler tools running in the Docker container are actually run directly on the native CPU and operating system. The performance is the same as installing the compiler on the machine. + +- Why use Docker? + + > Installing the tools and configurations in a Docker image standardizes the build environment. This way, if you encounter problems, others can reproduce the problem to help. In addition, for developers accustomed to using Windows and MacOS, there is no need to configure a cross-compilation environment using Docker. + +- Can I choose not to use Docker? + + > Of course you can. You can install development tools to the machine in the same way that you install them into Docker image. This document describes the Docker-based development process because it is easier than the other methods. + +- How hard is it to learn Docker? + + > It's not difficult to understand Docker. It takes about ten minutes to read this [article](https://zhuanlan.zhihu.com/p/19902938). + This can save you an hour of installing and configuring various development tools, as well as the need for new installations when switching machines. Don't forget that PaddlePaddle updates may lead to the need for new development tools. Not to mention the benefits of simplifying the recurrence of problems. + +- Can I use an IDE? + + > Of course, because the source code is on the machine. By default, the IDE calls a program like make to compile the source code. We only need to configure the IDE to call the Docker command to compile the source code. + Many PaddlePaddle developers use Emacs. They add two lines to their `~/.emacs` configuration file. + `global-set-key "\C-cc" 'compile` + `setq compile-command "docker run --rm -it -v $(git rev-parse --show- Toplevel): /paddle paddle:dev"` + You can start the compilation by pressing `Ctrl-C` and` c`. + +- Can I compile in parallel? + + > Yes. Our Docker image runs a [Bash script](https://github.com/PaddlePaddle/Paddle/blob/develop/paddle/paddle/scripts/paddle_build.sh). This script calls `make -j$(nproc)` to start as many processes as the CPU cores to compile in parallel. + +- Docker needs sudo? + + > If you develop with your own computer, you will naturally have admin privileges (sudo). If you are developing from a public computer, you need to ask the administrator to install and configure Docker. In addition, the PaddlePaddle project is working hard to support other container technologies that don't require sudo, such as rkt. + +- Is compiling slow on Windows/MacOS? + + > Docker runs on both Windows and MacOS. However, it is actually running on a Linux virtual machine. It may be necessary to pay attention to allocate more CPU and memory to this virtual machine to ensure efficient compilation. Please refer to [issue627](https://github.com/PaddlePaddle/Paddle/issues/627) for details. + +- Not enough disk? + + > In the example in this article, the `--rm` parameter is used in the `docker run`command to ensure that containers after the end of the run are not retained on disk. You can use the `docker ps -a` command to see containers that are stopped but not deleted. The `docker build` command sometimes produces some intermediate results, an image with no name, and it also occupies the disk. You can refer to this [article](https://zaiste.net/removing_docker_containers/) to clean up this content. + +- Can't I open `http://localhost:8888/` when using the book under DockerToolbox? + + > You need to replace localhost with virtual machine ip. Generally type this in the browser: `http://192.168.99.100:8888/` + +- After the pip install gpu version of PaddlePaddle runing, the SegmentFault appears as follows: + + @ 0x7f6c8d214436 paddle::platform::EnforceNotMet::EnforceNotMet() + + @ 0x7f6c8dfed666 paddle::platform::GetCUDADeviceCount() + + @ 0x7f6c8d2b93b6 paddle::framework::InitDevices() + + > The main reason for this problem is that your graphics card driver is lower than the corresponding CUDA version. Please ensure that your graphics card driver supports the CUDA version used. + + +- `Fatal Python error: PyThreadState_Get: no current thread running` error occurs when importing paddle.fluid after installing PaddlePaddle on MacOS. + + + - For Python2.7.x (install by brew): Please use `export LD_LIBRARY_PATH=/usr/local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7 && export DYLD_LIBRARY_PATH=/usr/ Local/Cellar/python@2/2.7.15_1/Frameworks/Python.framework/Versions/2.7` + - For Python2.7.x (install by Python.org): Please use `export LD_LIBRARY_PATH=/Library/Frameworks/Python.framework/Versions/2.7 && export DYLD_LIBRARY_PATH=/Library/Frameworks/Python.framework/Versions/2.7` + - For Python3.5.x (install by Python.org): Please use `export LD_LIBRARY_PATH=/Library/Frameworks/Python.framework/Versions/3.5/ && export DYLD_LIBRARY_PATH=/Library/Frameworks/Python.framework/Versions/3.5 /` + + +- Use customized openblas under MACOS. See issue for details: + + >[ISSUE 13217](https://github.com/PaddlePaddle/Paddle/issues/13721) + +- Swig has been installed but there is still a problem that swig can't find. See issue for details: + + >[ISSUE 13759](https://github.com/PaddlePaddle/Paddle/issues/13759) + +- The question "target pattern contain no '%'." appears. See issue for details: + + >[ISSUE 13806](https://github.com/PaddlePaddle/Paddle/issues/13806) diff --git a/doc/fluid/beginners_guide/install/Tables_en.md b/doc/fluid/beginners_guide/install/Tables_en.md new file mode 100644 index 0000000000000000000000000000000000000000..9041a2deb66a56e03fdf15a3eb0350e87b0cd50b --- /dev/null +++ b/doc/fluid/beginners_guide/install/Tables_en.md @@ -0,0 +1,665 @@ +*** +# APPENDIX + + +## Compile Dependency Table + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Dependency package name Version Description Installation command
CMake 3.4
GCC 4.8 / 5.4 recommends using devtools2 for CentOS
Python 2.7.x. depends on libpython2.7.so apt install python-dev or yum install python-devel
SWIG at least 2.0 apt install swig or yum install swig
wget any apt install wget or yum install wget
openblas any
pip at least 9.0.1 apt install python-pip or yum install Python-pip
numpy >=1.12.0 pip install numpy==1.14.0
protobuf 3.1.0 pip install protobuf==3.1.0
wheel any pip install wheel
patchELF any apt install patchelf or read github patchELF official documentation
go >=1.8 optional
+

+ + +*** + +

+## **Compile Option Table** + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Option Description Default
WITH_GPU Whether to support GPU ON
WITH_C_API Whether to compile CAPI OFF
WITH_DOUBLE Whether to use double precision floating point numeber OFF
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_STYLE_CHECK Whether to perform code style checking at compile time ON
WITH_TESTING Whether to turn on unit test OFF
WITH_DOC Whether to compile Chinese and English documents OFF
WITH_SWIG_PY Whether to compile PYTHON's SWIG interface, which can be used for predicting and customizing training Auto
WITH_GOLANG Whether to compile the fault-tolerant parameter server of the go language 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_MKL Whether to uses the MKL math library, if not, using OpenBLAS ON
WITH_RDMA Whether to compile the relevant parts that supports RDMA OFF
WITH_BRPC_RDMA Whether to use BRPC RDMA as RPC protocol OFF
ON_INFER Whether to turn on prediction optimization OFF
DWITH_ANAKIN Whether to Compile ANAKIN OFF
+

+ + +**BLAS** + +PaddlePaddle supports two BLAS libraries, [MKL](https://software.intel.com/en-us/mkl) and [OpenBlAS](http://www.openblas.net/). 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](https://github.com/PaddlePaddle/Paddle/tree/develop/doc/design/mkldnn#cmake). + +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** + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Version Number Release Discription
paddlepaddle==[version code] such as paddlepaddle==1.0.1 (download version 1.0.1 which only supports CPU PaddlePaddle) Only support the corresponding version of the CPU PaddlePaddle, please refer to Pypi for the specific version.
paddlepaddle-gpu==1.0.1 Using version 1.0.1 compiled with CUDA 9.0 and cuDNN 7
paddlepaddle-gpu==1.0.1.post87 Using version 1.0.1 compiled with CUDA 8.0 and cuDNN 7
paddlepaddle-gpu==1.0.1.post85 Using version 1.0.1 compiled with CUDA 8.0 and cuDNN 5
paddlepaddle-gpu==1.0.0 Using version 1.0.0 compiled with CUDA 9.0 and cuDNN 7
paddlepaddle-gpu==1.0.0.post87 Using version 1.0.0 compiled with CUDA 8.0 and cuDNN 7
paddlepaddle-gpu==1.0.0.post85 Using version 1.0.0 compiled with CUDA 8.0 and cuDNN 5
paddlepaddle-gpu==0.15.0 Using version 0.15.0 compiled with CUDA 9.0 and cuDNN 7
paddlepaddle-gpu==0.15.0.post87 Using version 0.15.0 compiled with CUDA 8.0 and cuDNN 7
paddlepaddle-gpu==0.15.0.post85 Using version 0.15.0 compiled with CUDA 8.0 and cuDNN 5
paddlepaddle-gpu==0.14.0 Using version 0.15.0 compiled with CUDA 9.0 and cuDNN 7
paddlepaddle-gpu==0.14.0.post87 Using version 0.15.0 compiled with CUDA 8.0 and cuDNN 7
paddlepaddle-gpu==0.14.0.post85 Using version 0.15.0 compiled with CUDA 8.0 and cuDNN 5
paddlepaddle-gpu==0.13.0 Using version 0.13.0 compiled with CUDA 9.0 and cuDNN 7
paddlepaddle-gpu==0.12.0 Using version 0.12.0 compiled with CUDA 8.0 and cuDNN 5
paddlepaddle-gpu==0.11.0.post87 Using version 0.11.0 compiled with CUDA 8.0 and cuDNN 7
paddlepaddle-gpu==0.11.0.post85 Using version 0.11.0 compiled with CUDA 8.0 and cuDNN 5
paddlepaddle-gpu==0.11.0 Using version 0.11.0 compiled with CUDA 7.5 and cuDNN 5
+

+ + + +You can find various distributions of PaddlePaddle-gpu in [the Release History](https://pypi.org/project/paddlepaddle-gpu/#history). + +*** +

+## Installation Mirrors and Introduction + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
Version Number Release Description
hub.baidubce.com/paddlepaddle/paddle:latest The latest pre-installed image of the PaddlePaddle CPU version
hub.baidubce.com/paddlepaddle/paddle:latest-dev The latest PaddlePaddle development environment
hub.baidubce.com/paddlepaddle/paddle:[Version] Replace version with a specific version, preinstalled PaddlePaddle image in historical version
hub.baidubce.com/paddlepaddle/paddle:latest-gpu The latest pre-installed image of the PaddlePaddle GPU version
+

+ + + +You can find the docker image for each release of PaddlePaddle in the [DockerHub](https://hub.docker.com/r/paddlepaddle/paddle/tags/). + +*** + +

+ +## **Multi-version whl package list - Release** + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Release Instruction cp27-cp27mu cp27-cp27m cp35-cp35m cp36-cp36m cp37-cp37m
cpu-noavx-mkl + paddlepaddle-1.2.0-cp27-cp27mu-linux_x86_64.whl + paddlepaddle-1.2.0-cp27-cp27m-linux_x86_64.whl + paddlepaddle-1.2.0-cp35-cp35m-linux_x86_64.whl + paddlepaddle-1.2.0-cp36-cp36m-linux_x86_64.whl + paddlepaddle-1.2.0-cp37-cp37m-linux_x86_64.whl
cpu_avx_mkl + paddlepaddle-1.2.0-cp27-cp27mu-linux_x86_64.whl + paddlepaddle-1.2.0-cp27-cp27m-linux_x86_64.whl + paddlepaddle-1.2.0-cp35-cp35m-linux_x86_64.whl + paddlepaddle-1.2.0-cp36-cp36m-linux_x86_64.whl + paddlepaddle-1.2.0-cp37-cp37m-linux_x86_64.whl
cpu_avx_openblas + paddlepaddle-1.2.0-cp27-cp27mu-linux_x86_64.whl paddlepaddle-1.2.0-cp27-cp27m-linux_x86_64.whl + paddlepaddle-1.2.0-cp35-cp35m-linux_x86_64.whl + paddlepaddle-1.2.0-cp36-cp36m-linux_x86_64.whl + paddlepaddle-1.2.0-cp37-cp37m-linux_x86_64.whl
cuda8.0_cudnn5_avx_mkl paddlepaddle_gpu-1.2.0-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.2.0-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.2.0-cp35-cp35m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0-cp36-cp36m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0-cp37-cp37m-linux_x86_64.whl
cuda8.0_cudnn7_noavx_mkl paddlepaddle_gpu-1.2.0-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.2.0-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.2.0-cp35-cp35m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0-cp36-cp36m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0-cp37-cp37m-linux_x86_64.whl
cuda8.0_cudnn7_avx_mkl paddlepaddle_gpu-1.2.0.post87-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.2.0.post87-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.2.0.post87-cp35-cp35m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0.post87-cp36-cp36m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0.post87-cp37-cp37m-linux_x86_64.whl
cuda9.0_cudnn7_avx_mkl paddlepaddle_gpu-1.2.0-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-1.2.0-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-1.2.0-cp35-cp35m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0-cp36-cp36m-linux_x86_64.whl + paddlepaddle_gpu-1.2.0-cp37-cp37m-linux_x86_64.whl
+

+ + +

+ + + + +## **Multi-version whl package list - dev** + + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Release Instruction cp27-cp27mu cp27-cp27m cp35-cp35m cp36-cp36m cp37-cp37m
cpu-noavx-mkl + paddlepaddle-latest-cp27-cp27mu-linux_x86_64.whl + paddlepaddle-latest-cp27-cp27m-linux_x86_64.whl + paddlepaddle-latest-cp35-cp35m-linux_x86_64.whl + paddlepaddle-latest-cp36-cp36m-linux_x86_64.whl + paddlepaddle-latest-cp37-cp37m-linux_x86_64.whl
cpu_avx_mkl + paddlepaddle-latest-cp27-cp27mu-linux_x86_64.whl + paddlepaddle-latest-cp27-cp27m-linux_x86_64.whl + paddlepaddle-latest-cp35-cp35m-linux_x86_64.whl + paddlepaddle-latest-cp36-cp36m-linux_x86_64.whl + paddlepaddle-latest-cp37-cp37m-linux_x86_64.whl
cpu_avx_openblas + paddlepaddle-latest-cp27-cp27mu-linux_x86_64.whl paddlepaddle-latest-cp27-cp27m-linux_x86_64.whl + paddlepaddle-latest-cp35-cp35m-linux_x86_64.whl + paddlepaddle-latest-cp36-cp36m-linux_x86_64.whl + paddlepaddle-latest-cp37-cp37m-linux_x86_64.whl
cuda8.0_cudnn5_avx_mkl paddlepaddle_gpu-latest-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-latest-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-latest-cp35-cp35m-linux_x86_64.whl paddlepaddle_gpu-latest-cp36-cp36m-linux_x86_64.whl paddlepaddle_gpu-latest-cp37-cp37m-linux_x86_64.whl
cuda8.0_cudnn7_noavx_mkl paddlepaddle_gpu-latest-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-latest-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-latest-cp35-cp35m-linux_x86_64.whl + paddlepaddle_gpu-latest-cp36-cp36m-linux_x86_64.whl + paddlepaddle_gpu-latest-cp37-cp37m-linux_x86_64.whl
cuda8.0_cudnn7_avx_mkl paddlepaddle_gpu-latest-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-latest-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-latest-cp35-cp35m-linux_x86_64.whl paddlepaddle_gpu-latest-cp36-cp36m-linux_x86_64.whl paddlepaddle_gpu-latest-cp37-cp37m-linux_x86_64.whl
cuda9.0_cudnn7_avx_mkl paddlepaddle_gpu-latest-cp27-cp27mu-linux_x86_64.whl paddlepaddle_gpu-latest-cp27-cp27m-linux_x86_64.whl paddlepaddle_gpu-latest-cp35-cp35m-linux_x86_64.whl paddlepaddle_gpu-latest-cp36-cp36m-linux_x86_64.whl paddlepaddle_gpu-latest-cp37-cp37m-linux_x86_64.whl
+

+ + +

+ +## 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](http://www.paddlepaddle.org/docs/develop/book/01.fit_a_line/index.cn.html) 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](#FAQ). + + +

+## Perform GPU training using Docker + +*** + +In order to ensure that the GPU driver works properly in the image, we recommend using [nvidia-docker](https://github.com/NVIDIA/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 + + + +**About AVX:** + +AVX is a set of CPU instructions that speeds up the calculation of PaddlePaddle. The latest PaddlePaddle Docker image is enabled by default for AVX compilation, so if your computer does not support AVX, you need to [compile](/build_from_source_cn.html) PaddlePaddle to no-avx version separately. + +The following instructions can check if the Linux computer supports AVX: + +`if cat /proc/cpuinfo | grep -i avx; then echo Yes; else echo No; fi` + +If the output is No, you need to choose a mirror that uses no-AVX. + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/fluid/beginners_guide/install/compile/compile_CentOS_en.md b/doc/fluid/beginners_guide/install/compile/compile_CentOS_en.md new file mode 100644 index 0000000000000000000000000000000000000000..9cecda894b2569535053d4bd9124f6769bd9934e --- /dev/null +++ b/doc/fluid/beginners_guide/install/compile/compile_CentOS_en.md @@ -0,0 +1,212 @@ +*** +# **Compile under CentOS from Source Code** + +This instruction will show you how to compile PaddlePaddle on a 64-bit desktop or laptop and CentOS. The Centos systems we support must meet the following requirements: + +* CentOS 7 / 6 (this involves whether the related tools can be installed normally) + +## Determine which version to compile + +* **Only PaddlePaddle for CPU is supported.** + +## Choose a compilation method + +We provide two compilation methods under the CentOS system: + +* Docker source code compilation (the CentOS 6 / 7 GPU version is not supported) (this image already contains python2.7, python3.6, python3.7 environment) +* Direct native source code compilation (does not support all versions of CentOS 6 and GPU versions of CentOS 7) + +We recommend using **Docker for compilation** because we are installing both the tools and the configuration in a Docker image. This way, if you encounter problems, others can reproduce the problem to 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 native CPU and operating system. The performance is the same as installing the compiler on the machine. + +Also for those who can't install Docker for a variety of reasons, we also provide a way to **compile directly from sources**, but since the situation on host machine is more complicated, we only support specific systems. + + +### ***Compile with 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](https://docs.docker.com/install/). + +Once you have **properly installed Docker**, you can start **compiling PaddlePaddle with Docker**: + +1. First select the path where you want to store PaddlePaddle, 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` + +2. Go to the Paddle directory: `cd Paddle` + +3. Take advantage of the image we provided (with this command you don't have to download the image in advance): + + `docker run --name paddle-test -v $PWD:/paddle --network=host -it` `hub.baidubce.com/paddlepaddle/paddle:latest-dev /bin/bash` + + > `--name paddle-test` names the Docker container you created as paddle-test, `-v $PWD:/paddle` mounts the current directory to the /paddle directory in the Docker container (the PWD variable in Linux will expand to the current [Absolute path](https://baike.baidu.com/item/%E7%BB%9D%E5%AF%B9%E8%B7%AF%E5%BE%84/481185)), `-it` keeps interacting with the host, `hub.baidubce.com/paddlepaddle/paddle` creates a Docker container with an image called `hub.baidubce.com/paddlepaddle/paddle:latest-dev`, /bin/bash enters the container After starting the `/bin/bash` command. + +4. After entering Docker, go to the paddle directory: `cd paddle` + +5. Switch to a more stable version to compile: + + `git checkout v1.1` + +6. Create and enter the /paddle/build path: + + `mkdir -p /paddle/build && cd /paddle/build` + +7. Use the following command to install the dependencies: (For Python3: Please select the pip for the python version you wish to use, such as pip3.5, pip3.6) + + + For Python2: pip install protobuf==3.1.0 + For Python3: pip3.5 install protobuf==3.1.0 + + + > Install protobuf 3.1.0 + + `apt install patchelf` + + > Installing patchelf, PatchELF is a small and useful program for modifying the dynamic linker and RPATH of ELF executables. + +8. Execute cmake: + + > For details on the compilation options, see the [compilation options table](../Tables.html/#Compile). + + * For users who need to compile the **CPU version PaddlePaddle**: + + `cmake .. -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release` + + > We currently do not support the compilation of the GPU version PaddlePaddle under CentOS. + +9. Execute compilation: + + `make -j$(nproc)` + + > Use multicore compilation + +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: (For Python3: Please select the pip corresponding to the python version you wish to use, such as pip3.5, pip3.6) + + + For Python2: pip install (whl package name) + For Python3: pip3.5 install (whl package name) + + +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](https://docs.docker.com/). + +> Notes: 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. + +Congratulations, you have now completed the process of compiling PaddlePaddle using Docker. + + + +

+### *Local compilation* + +**Please strictly follow the order of the following instructions** + + +1. Check that your computer and operating system meet the compilation standards we support: `uname -m && cat /etc/*release` + +2. Update the source of `yum`: `yum update`, and add the necessary yum source: `yum install -y epel-release`, and install openCV in advance + +3. Install the necessary tools `bzip2` and `make`: `yum install -y bzip2 `, `yum install -y make` + +4. We support compiling and installing with virtualenv. First, create a virtual environment called `paddle-venv` with the following command: + + * a. Install Python-dev: + + For Python2: yum install python-devel + For Python3: (Please refer to the official Python installation process) + + + * b. Install pip: + + + For Python2: yum install python-pip (please have a pip version of 9.0.1 and above) + For Python3: (Please refer to the official Python installation process, and ensure that the pip3 version 9.0.1 and above, please note that in python3.6 and above, pip3 does not necessarily correspond to the python version, such as python3.7 default only Pip3.7) + + * c. (Only For Python3) set Python3 related environment variables, here is python3.5 version example, please replace with the version you use (3.6, 3.7): + + 1. First find the path to the Python lib using ``` find `dirname $(dirname + $(which python3))` -name "libpython3.so"``` . If it is 3.6 or 3.7, change `python3` to `python3.6` or `python3.7`, then replace [python-lib-path] in the following steps with the file path found. + + 2. Set PYTHON_LIBRARIES: `export PYTHON_LIBRARY=[python-lib-path]`. + + 3. Secondly, use ```find `dirname $(dirname + $(which python3))`/include -name "python3.5m"``` to find the path to Python Include, please pay attention to the python version, then replace the following [python-include-path] to the file path found. + + 4. Set PYTHON_INCLUDE_DIR: `export PYTHON_INCLUDE_DIRS=[python-include-path]` + + 5. Set the system environment variable path: `export PATH=[python-lib-path]:$PATH `(here replace the last two levels content of [python-lib-path] with /bin/) + + * d. Install the virtual environment `virtualenv` and `virtualenvwrapper` and create a virtual environment called `paddle-venv`: (please note the pip3 commands corresponding to the python version, such as pip3.6, pip3.7) + + 1. `pip install virtualenv` or `pip3 install virtualenv` + + 2. `Pip install virtualenvwrapper` or `pip3 install virtualenvwrapper` + + 3. Find `virtualenvwrapper.sh`: `find / -name virtualenvwrapper.sh` (please find the corresponding Python version of `virtualenvwrapper.sh`) + + 4. See the installation method in `virtualenvwrapper.sh`: `cat vitualenvwrapper.sh` + + 5. Install `virtualwrapper` + + 6. Create a virtual environment called `paddle-venv`: `mkvirtualenv paddle-venv` + +5. Enter the virtual environment: `workon paddle-venv` + +6. Before **executing the compilation**, please confirm that the related dependencies mentioned in the [compile dependency table](../Tables.html/#third_party) are installed in the virtual environment: + + * Here is the installation method for `patchELF`. Other dependencies can be installed using `yum install` or `pip install`/`pip3 install` followed by the name and version: + + `yum install patchelf` + > Users who can't use apt installation can refer to patchElF [github official documentation](https://gist.github.com/ruario/80fefd174b3395d34c14). + +7. 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` + +8. Switch to a more stable release branch for compilation (support for Python 3.6 and 3.7 is added from the 1.2 branch): + + - `git checkout release/1.2.0` + +9. And please create and enter a directory called build: + + - `mkdir build && cd build` + +10. Execute cmake: + + > For details on the compilation options, see the [compilation options table](../Tables.html/#Compile). + + * For users who need to compile the **CPU version PaddlePaddle**: + + + For Python2: cmake .. -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + For Python3: cmake .. -DPY_VERSION=3.5 -DPYTHON_INCLUDE_DIR=${PYTHON_INCLUDE_DIRS} \ + -DPYTHON_LIBRARY=${PYTHON_LIBRARY} -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + + + > If you encounter `Could NOT find PROTOBUF (missing: PROTOBUF_LIBRARY PROTOBUF_INCLUDE_DIR)`, you can re-execute the cmake command. + > Please note that the PY_VERSION parameter is replaced with the python version you need. + +11. Compile with the following command: + + `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: + + `Pip install (whl package name) `or `pip3 install (whl package name)` + +Congratulations, now you have completed the process of compiling PaddlePaddle natively. + +

+### ***Verify installation*** + +After the installation is complete, you can use `python` 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` diff --git a/doc/fluid/beginners_guide/install/compile/compile_MacOS_en.md b/doc/fluid/beginners_guide/install/compile/compile_MacOS_en.md new file mode 100644 index 0000000000000000000000000000000000000000..51ea6d3cae3330a8dd3536e9108189c9c5cdcd0a --- /dev/null +++ b/doc/fluid/beginners_guide/install/compile/compile_MacOS_en.md @@ -0,0 +1,207 @@ +*** +# **Compile under MacOS from Source Code** + +This instruction will show you how to compile PaddlePaddle on *64-bit desktops or laptops* and MacOS systems. The MacOS systems we support need to meet the following requirements: + +* MacOS 10.12/10.13/10.14 (this involves whether the related tools can be installed normally) + +## Determine which version to compile + +* **Only PaddlePaddle for CPU is supported.** + +## Choose a compilation method + +Under the MacOS 10.12/10.13/10.14 system we offer 2 ways to compile: + +* Docker source compilation (this image already contains python2.7, python3.6, python3.7 environment) +* Direct source code compilation + + +We recommend **using Docker for compilation** because we are installing both the tools and the configuration in a Docker image. This way, if you encounter problems, others can reproduce the problem to 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 native CPU and operating system. The performance is the same as installing the compiler on the machine. + +Also for those who can't install Docker for a variety of reasons, we also provide a way to **compile directly from local sources**, but since the situation on this machine is more complicated, we only support specific systems. + +

+### ***Compile with 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](https://docs.docker.com/install/). + +> Please note that running Docker on MacOS requires logging in with your dockerID, otherwise an Authenticate Failed error will occur. + +Once you have **properly installed Docker**, you can start **compiling PaddlePaddle with Docker**: + +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. Take advantage of the image we provided (with this command you don't have to download the image in advance): + + `docker run --name paddle-test -v $PWD:/paddle --network=host -it` `hub.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](https://baike.baidu.com/item/绝对路径/481185)), -it keeps interacting with the host, `hub.baidubce.com/paddlepaddle/paddle:latest-dev` creates a Docker container with a mirror named `hub.baidubce.com/paddlepaddle/paddle:latest-dev`, /bin /bash starts the /bin/bash command after entering the container. + +5. After entering Docker, go to the paddle directory: `cd paddle` + +6. Switch to a more stable version to compile: + + `git checkout v1.1` + +7. Create and enter the /paddle/build path: + + `mkdir -p /paddle/build && cd /paddle/build` + +8. Use the following command to install the dependencies: (For Python3: Please select the pip for the python version you wish to use, such as pip3.5, pip3.6) + + + For Python2: pip install protobuf==3.1.0 + For Python3: pip3.5 install protobuf==3.1.0 + + > Install protobuf 3.1.0. + + `apt install patchelf` + + > Installing patchelf, PatchELF is a small and useful program for modifying the dynamic linker and RPATH of ELF executables. + +9. Execute cmake: + + > For details on the compilation options, see the [compilation options table](../Tables.html/#Compile). + + * For users who need to compile the **CPU version PaddlePaddle**: + + `cmake .. -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release` + + > We currently do not support the compilation of the GPU version PaddlePaddle under CentOS. + +10. Execute compilation: + + `make -j$(nproc)` + + > Use multicore compilation + +11. After compiling successfully, go to the `/paddle/build/python/dist `directory and find the generated `.whl` package: `cd /paddle/build/python/dist` + +12. 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.5, pip3.6) + + + For Python2: pip install (whl package name) + For Python3: pip3.5 install (whl package name) + + +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](https://docs.docker.com/). + +> 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. + +Congratulations, you have now completed the process of compiling PaddlePaddle using Docker. + + +

+### ***Native 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](https://brew.sh/) to install python (for Python3 please use python [official download](https://www.python.org/downloads/mac-osx/) python3.5.x, python3.6.x, python3.7.x), pip and other dependencies, This will greatly reduce the difficulty of installing and compiling. + + For python2: brew install python@2 + For python3: 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. + +3. (Only For Python2) Set Python-related environment variables: + + - Use `find / -name libpython2.7.dylib` to find your current python `libpython2.7.dylib` path and use `export LD_LIBRARY_PATH=[libpython2.7.dylib path] && export DYLD_LIBRARY_PATH=[libpython2.7.dylib to the top two directories of the directory]` + +4. (Only For Python3) Set Python-related environment variables: + + - a. First use + ```find `dirname $(dirname + $(which python3))` -name "libpython3.*.dylib"``` + to find the path to Pythonlib (the first one it prompts is the dylib path for the python you need to use), then (below [python-lib-path] is replaced by finding the file path) + + - b. Set PYTHON_LIBRARIES: `export PYTHON_LIBRARY=[python-lib-path]` + + - c. Secondly use the path to find PythonInclude (usually find the above directory of [python-lib-path] as the include of the same directory, then find the path of python3.x or python2.x in the directory), then (the [python-include-path] in the following commands should be replaced by the path found here) + + - d. Set PYTHON_INCLUDE_DIR: `export PYTHON_INCLUDE_DIRS=[python-include-path]` + + - e. Set the system environment variable path: `export PATH=[python-bin-path]:$PATH` (here [python-bin-path] is the result of replacing the last two levels of [python-lib-path] with the path after /bin/ ) + + - f. Set the dynamic library link: `export LD_LIBRARY_PATH=[python-ld-path]` and `export DYLD_LIBRARY_PATH=[python-ld-path]` (here [python-ld-path] is the [python-bin-path]'s parent directory ) + + - g. (Optional) If you are compiling PaddlePaddle on MacOS 10.14, make sure you have the [appropriate version](http://developer.apple.com/download) of Xcode installed. + + +5. Before **compilation**, please confirm that the relevant dependencies mentioned in the [compilation dependency table](h../Tables.html/#third_party) are installed in your environment, otherwise we strongly recommend using `Homebrew` to install related dependencies. + + > Under MacOS, if you have not modified or installed the dependencies mentioned in the "Compile Dependency Table", you only need to use `pip` to install `numpy`, `protobuf`, `wheel`, use `homebrew` to install `wget`, `swig`,then install `cmake`. + + - a. Here is a special description of the installation of **CMake**: + + Since we are using CMake3.4 please follow the steps below: + + 1. Download the CMake image from the [official CMake website](https://cmake.org/files/v3.4/cmake-3.4.3-Darwin-x86_64.dmg) and install it. + + 2. Enter `sudo "/Applications/CMake.app/Contents/bin/cmake-gui" –install` in the console + + - b. If you do not want to use the system default blas and want to use your own installed OPENBLAS please read [FAQ](../FAQ.html/#OPENBLAS) + +6. 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` + +7. 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) + + `git checkout release/1.2` + +8. And please create and enter a directory called build: + + `mkdir build && cd build` + +9. Execute cmake: + + > For details on the compilation options, see the [compilation options table](../Tables.html/#Compile). + + * For users who need to compile the **CPU version PaddlePaddle**: + + + For Python2: cmake .. -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + For Python3: cmake .. -DPY_VERSION=3.5 -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.5`` Please change to the Python version of the installation environment. + +10. Compile with the following command: + + `make -j4` + +11. After compiling successfully, go to the `/paddle/build/python/dist `directory and find the generated `.whl` package: `cd /paddle/build/python/dist` + +12. Install the compiled `.whl` package on the current machine or target machine: + + `pip install (whl package name)` or `pip3 install (whl package name)` + + > If you have multiple python environments and pips installed on your computer, please see the [FAQ](../Tables.html/#MACPRO). + +Congratulations, now you have completed the process of compiling PaddlePaddle using this machine. + +

+### ***Verify installation*** + +After the installation is complete, you can use `python` 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` diff --git a/doc/fluid/beginners_guide/install/compile/compile_Ubuntu_en.md b/doc/fluid/beginners_guide/install/compile/compile_Ubuntu_en.md new file mode 100644 index 0000000000000000000000000000000000000000..073e4973112ba3b22782ede4640318dddb2068d8 --- /dev/null +++ b/doc/fluid/beginners_guide/install/compile/compile_Ubuntu_en.md @@ -0,0 +1,213 @@ +*** +# **Compile under Ubuntu from Source Code** + +This instruction describes how to compile PaddlePaddle on *64-bit desktops or laptops* and Ubuntu systems. The Ubuntu systems we support must meet the following requirements: + +* Ubuntu 14.04/16.04/18.04 (this involves whether the related tools can be installed successfully) + +## Determine which version to compile + +* **CPU version of PaddlePaddle**, if your system does not have an NVIDIA® GPU, you must install this version. This version is easier than the GPU version. So even if you have a GPU on your computer, we recommend that you first install the CPU version of PaddlePaddle to check if your local environment is suitable. + +* **GPU version of PaddlePaddle**, in order to make the PaddlePaddle program run more quickly, we usually use the GPU to accelerate the PaddlePaddle program, but the GPU version of PaddlePaddle needs to have the NVIDIA® GPU that meets the following conditions (see NVIDIA for the specific installation process and configuration). Official documentation: [For CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/), For [cuDNN](https://docs.nvidia.com/deeplearning/sdk/cudnn-install/)) + + * *CUDA Toolkit 9.0 with cuDNN v7* + * *CUDA Toolkit 8.0 with cuDNN v7* + * *Hardware devices with GPU compute capability exceeding 1.0* + +## Choose a compilation method + +Under Ubuntu's system we offer 2 ways to compile: + +* Docker source compilation (this image already contains python2.7, python3.6, python3.7 environment) + +* Direct native source code compilation (does not support GPU version under ubuntu18.04) + +We recommend using **Docker for compilation** because we are installing both the tools and the configuration in a Docker image. This way, if you encounter problems, others can reproduce the problem to help. In addition, for developers accustomed to using Windows and MacOS, there is no need to configure a cross-compilation environment using Docker. Someone uses a virtual machine to analogize to 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 native CPU and operating system. The performance is the same as installing the compiler on the machine. + +We also provide methods that can be **compiled from local source code**, but since the situation on host machine is more complicated, we only provide support for specific systems. + +

+## ***Compile with 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](https://docs.docker.com/install/). + +> Please note that to install and use the PaddlePaddle version that supports GPU, you must first install nvidia-docker + +Once you have **properly installed Docker**, you can start **compiling PaddlePaddle with Docker**: + +1. First select the path where you want to store PaddlePaddle, 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` + +2. Go to the Paddle directory: `cd Paddle` + +3. Take advantage of the image we provided (with this command you don't have to download the image in advance): + + `docker run --name paddle-test -v $PWD:/paddle --network=host -it hub.baidubce.com/paddlepaddle/paddle:latest-dev /bin/bash` + + > --name paddle-test names the Docker container you created as paddle-test, -v $PWD:/paddle mounts 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](https://baike.baidu.com/item/%E7%BB%9D%E5%AF%B9%E8%B7%AF%E5%BE%84/481185)), -it keeps interacting with the host, `hub.baidubce.com/paddlepaddle/paddle:latest-dev` creates a Docker container with a mirror named `hub.baidubce.com/paddlepaddle/paddle:latest-dev`, /bin /bash Starts the /bin/bash command after entering the container. + +4. After entering Docker, go to the paddle directory: `cd paddle` + +5. 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) + + `git checkout release/1.2.0` + +6. Create and enter the /paddle/build path: + + `mkdir -p /paddle/build && cd /paddle/build` + +7. Use the following command to install the dependencies: (For Python3: Please select the pip for the python version you wish to use, such as pip3.5, pip3.6) + + For Python2: pip install protobuf==3.1.0 + For Python3: pip3.5 install protobuf==3.1.0 + + + > Install protobuf 3.1.0. + + `apt install patchelf` + + > Installing patchelf, PatchELF is a small and useful program for modifying the dynamic linker and RPATH of ELF executables. + +8. Execute cmake: + + > For the meaning of the specific compiling options, [compilation options table](../Tables.html/#Compile) is your resort. Please note that the parameter `-DPY_VERSION` is the python version used in your current environment. + + * For users who need to compile the **CPU version PaddlePaddle**: + + `cmake .. -DPY_VERSION=3.5 -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release` + + * For users who need to compile the **GPU version PaddlePaddle**: + + `cmake .. -DPY_VERSION=3.5 -DWITH_FLUID_ONLY=ON -DWITH_GPU=ON -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release` + +9. Execute compilation: + + `make -j$(nproc)` + + > Use multicore compilation + +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: (For Python3: Please select the pip corresponding to the python version you wish to use, such as pip3.5, pip3.6) + + For Python2: pip install (whl package name) + For Python3: pip3.5 install (whl package name) + + +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](https://docs.docker.com/). + +> 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. + +Congratulations, you have now completed the process of compiling PaddlePaddle using Docker. + + +

+### ***Local compilation*** + +**Please strictly follow the following instructions step by step** + +1. Check that your computer and operating system meet the compilation standards we support: `uname -m && cat /etc/*release` + +2. Update the source of `apt`: `apt update`, and install openCV in advance. + +3. We support compiling and installing with virtualenv. First, create a virtual environment called `paddle-venv` with the following command: + + * a. Install Python-dev: (Please install python3.x-dev that matches the current environment python version) + + For Python2: apt install python-dev + For Python3: apt install python3.5-dev + + * b. Install pip: (Please ensure that pip version is 9.0.1 and above ): (Please note that the version corresponding to python3 is modified) + + For Python2: apt install python-pip + For Python3: apt-get udpate && apt-get install -y software-properties-common && add-apt-repository ppa:deadsnakes/ppa && apt install curl && curl https://bootstrap.pypa.io/get-pip. Py -o - | python3.5 && easy_install pip + + + * c. Install the virtual environment `virtualenv` and `virtualenvwrapper` and create a virtual environment called `paddle-venv` (please note the python version) : + + 1. `apt install virtualenv` or `pip install virtualenv` or `pip3 install virtualenv` + 2. `apt install virtualenvwrapper` or `pip install virtualenvwrapper` or `pip3 install virtualenvwrapper` + 3. Find `virtualenvwrapper.sh`: `find / -name virtualenvwrapper.sh` + 4. (Only for Python3) Set the interpreter path for the virtual environment: `export VIRTUALENVWRAPPER_PYTHON=/usr/bin/python3.5` + 5. See the installation method in `virtualenvwrapper.sh`: `cat virtualenvwrapper.sh` + 6. Install `virtualwrapper` according to the installation method in `virtualenvwrapper.sh` + 7. Create a virtual environment called `paddle-venv`: `mkvirtualenv paddle-venv` + +4. Enter the virtual environment: `workon paddle-venv` + +5. Before **executing the compilation**, please confirm that the related dependencies mentioned in [the compile dependency table](../Tables.html/#third_party) are installed in the virtual environment: + + * Here is the installation method for `patchELF`. Other dependencies can be installed using `apt install` or `pip install` followed by the name and version: + + `apt install patchelf` + + > Users who can't use apt installation can refer to patchElF [github official documentation](https://gist.github.com/ruario/80fefd174b3395d34c14). + +6. Clone the PaddlePaddle source code in the Paddle folder in the current directory and go to the Paddle directory: + + - `git clone https://github.com/PaddlePaddle/Paddle.git` + + - `cd Paddle` + +7. Switch to a more stable release branch to compile, replacing the brackets and their contents with **the target branch name**: + + - `git checkout [name of target branch]` + +8. And please create and enter a directory called build: + + `mkdir build && cd build` + +9. Execute cmake: + + > For details on the compilation options, see [the compilation options table](../Tables.html/#Compile). + + * For users who need to compile the **CPU version of PaddlePaddle**: (For Python3: Please configure the correct python version for the PY_VERSION parameter) + + For Python2: cmake .. -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + For Python3: cmake .. -DPY_VERSION=3.5 -DWITH_FLUID_ONLY=ON -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + + + * For users who need to compile **GPU version of PaddlePaddle**: (*only support ubuntu16.04/14.04*) + + 1. Please make sure that you have installed nccl2 correctly, or install nccl2 according to the following instructions (here is ubuntu 16.04, CUDA9, ncDNN7 nccl2 installation instructions), for more information on the installation information please refer to the [NVIDIA official website](https://developer.nvidia.com/nccl/nccl-download): + + i. `wget http: / /developer.download.nvidia.com/compute/machine-learning/repos/ubuntu1604/x86_64/nvidia-machine-learning-repo-ubuntu1604_1.0.0-1_amd64.deb ` + + ii. `dpkg -i nvidia-machine-learning-repo-ubuntu1604_1 .0.0-1_amd64.deb` + + iii. `sudo apt-get install -y libnccl2=2.2.13-1+cuda9.0 libnccl-dev=2.2.13-1+cuda9.0` + + 2. If you have already installed `nccl2` correctly, you can start cmake: *(For Python3: Please configure the correct python version for the PY_VERSION parameter)* + + For Python2: cmake .. -DWITH_FLUID_ONLY=ON -DWITH_GPU=ON -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + For Python3: cmake .. -DPY_VERSION=3.5 -DWITH_FLUID_ONLY=ON -DWITH_GPU=ON -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release + + + > `-DPY_VERSION=3.5` Please change to the Python version of the installation environment + +10. Compile with the following command: + + `make -j$(nproc)` + +11. After compiling successfully, go to the `/paddle/build/python/dist `directory and find the generated `.whl` package: `cd /paddle/build/python/dist` + +12. Install the compiled `.whl` package on the current machine or target machine: + + `Pip install (whl package name)` or `pip3 install (whl package name)` + +Congratulations, now you have completed the process of compiling PaddlePaddle natively. + +

+### ***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` + +- ***GPU version of PaddlePaddle***: `pip uninstall paddlepaddle-gpu` or `pip3 uninstall paddlepaddle-gpu` diff --git a/doc/fluid/beginners_guide/install/compile/compile_Windows_en.md b/doc/fluid/beginners_guide/install/compile/compile_Windows_en.md new file mode 100644 index 0000000000000000000000000000000000000000..86c84ade026c34282443be4b20c3580302cf6a81 --- /dev/null +++ b/doc/fluid/beginners_guide/install/compile/compile_Windows_en.md @@ -0,0 +1,104 @@ +*** +# **Compile under Windows from Source Code** + +This instruction will show you how to compile PaddlePaddle on a *64-bit desktop or laptop* and Windows 10. The Windows systems we support must meet the following requirements: + +* Windows 10 Family Edition / Professional Edition / Enterprise Edition +* Visual Studio 2015 Update3 + +## Determine which version to compile + +* **Only PaddlePaddle for CPU is supported.** + +## Choose a compilation method + +We provide one compilation method under the Windows system: + +* Direct source code compilation + +Since the situation on host machine is more complicated, we only support specific systems. + +Please note: The current version does not support NCCL, distributed, AVX, warpctc and MKL related functions. + + +### ***Local compilation*** + +**Please strictly follow the following instructions step by step** + +1. Check that your computer and operating system meet our supported compilation standards + + * Windows 10 Family Edition / Professional Edition / Enterprise Edition + + * Visual Studio 2015 Update3 + +2. Install the necessary tools i.e. cmake, git and python : + + > Cmake requires version 3.0 and above, which can be downloaded from the official website and added to the environment variable. [Download here](https://cmake.org/download/). + + > Git can be downloaded on the official website and added to the environment variable. [Download here](https://gitforwindows.org/). + + > Python requires version 2.7 and above, and ensure that modules such as numpy, protobuf, wheel are installed. [Download here](https://www.python.org/download/releases/2.7/). + + + * To Install numpy package you can use command `pip install numpy` or command `pip3 install numpy` + + * To Install protobuf package you can use command `pip install protobuf` or command `pip3 install protobuf` + + * To Install Wheel package you can use command `pip install wheel` or `pip3 install wheel` + + +3. Clone the PaddlePaddle source in the Paddle folder in the current directory and go to the Paddle directory: + + - `git clone https://github.com/PaddlePaddle/Paddle.git` + - `cd Paddle` + +4. Switch to a more stable release branch for compilation (supports 1.2.x and above): + + - `git checkout release/x.x.x` + +5. Create a directory called build and enter it: + + - `mkdir build` + - `cd build` + +6. Execute cmake: + + > For details on the compilation options, see [the compilation options list](../Tables.html/#Compile). + + * For users who need to compile **the CPU version PaddlePaddle**: + + For Python2:`cmake .. -G "Visual Studio 14 2015 Win64" -DPYTHON_INCLUDE_DIR = $ {PYTHON_INCLUDE_DIRS} + -DPYTHON_LIBRARY = $ {PYTHON_LIBRARY} + -DPYTHON_EXECUTABLE = $ {PYTHON_EXECUTABLE} -DWITH_FLUID_ONLY = ON -DWITH_GPU = OFF -DWITH_TESTING = OFF -DCMAKE_BUILD_TYPE =Release` + + + For Python3: `cmake .. -G "Visual Studio 14 2015 Win64" -DPY_VERSION = 3.5 -DPYTHON_INCLUDE_DIR = $ {PYTHON_INCLUDE_DIRS} + -DPYTHON_LIBRARY = $ {PYTHON_LIBRARY} + -DPYTHON_EXECUTABLE = $ {PYTHON_EXECUTABLE} -DWITH_FLUID_ONLY = ON -DWITH_GPU = OFF -DWITH_TESTING =OFF -DCMAKE_BUILD_TYPE=Release` + + > If you encounter `Could NOT find PROTOBUF (missing: PROTOBUF_LIBRARY PROTOBUF_INCLUDE_DIR)`, you can re-execute the cmake command. + +7. Some third-party dependencies (openblas, snappystream) currently require users to provide pre-compiled versions, or download pre-compiled files from `https://github.com/wopeizl/Paddle_deps` and place the entire `third_party` folder in the `build` directory. + +8. Use Blend for Visual Studio 2015 to open `paddle.sln` file, select the platform `x64`, configure with `Release`, then begin to compile + +9. Having compiled successfully, go to the `\paddle\build\python\dist`directory and find the generated `.whl` package: + + `cd \paddle\build\python\dist` + +10. Install the compiled `.whl` package on the current machine or target machine: + + `pip install (whl package name)` or `pip3 install (whl package name)` + +Congratulations, now you have completed the process of compiling PaddlePaddle natively. + + +### ***Verify installation*** + +After the installation is complete, you can use: `python` to enter the Python interpreter and then use `import paddle.fluid`. If there is no error prompted, the installation is successful. + +### ***How to uninstall*** + +Please use the following command to uninstall PaddlePaddle: + +* ***CPU version of PaddlePaddle*** : `pip uninstall paddlepaddle` or `pip3 uninstall paddlepaddle` diff --git a/doc/fluid/beginners_guide/install/compile/fromsource_en.rst b/doc/fluid/beginners_guide/install/compile/fromsource_en.rst new file mode 100644 index 0000000000000000000000000000000000000000..970a0abcb59f687fb78ac976be60b4ce4a963f7b --- /dev/null +++ b/doc/fluid/beginners_guide/install/compile/fromsource_en.rst @@ -0,0 +1,13 @@ +============================== +**Compile From Source Code** +============================== + +You can also choose to compile and install PaddlePaddle in the way of source code compilation. However, due to the diversity of the native environment, complicated problems may occur when compiling the source code, which may cause your installation to fail. In order to ensure your smooth installation, it is recommended that you prefer the normal installation method. + +.. toctree:: + + + compile_Ubuntu_en.md + compile_CentOS_en.md + compile_MacOS_en.md + compile_Windows_en.md diff --git a/doc/fluid/beginners_guide/install/install_CentOS_en.md b/doc/fluid/beginners_guide/install/install_CentOS_en.md new file mode 100644 index 0000000000000000000000000000000000000000..c4ec953ccae21aadfa4bb064f10acce85ca5a068 --- /dev/null +++ b/doc/fluid/beginners_guide/install/install_CentOS_en.md @@ -0,0 +1,148 @@ +*** + +# **Install under CentOS** + +This note will show you how to install PaddlePaddle on a *64-bit desktop or laptop* and CentOS. The CentOS system we support needs to meet the following requirements: + +Please note: Attempts on other systems may cause the installation to fail. Please ensure that your environment meets the conditions. The installation we provide by default requires your computer processor to support the AVX instruction set. Otherwise, please select the version of `no_avx` in [the latest Release installation package list](./Tables.html/#ciwhls-release). + +Under CentOS you can use `cat /proc/cpuinfo | grep avx` to check if your processor supports the AVX instruction set. + +* CentOS 6 / 7 + +## Determine which version to install + +* Only PaddlePaddle for CPU is supported. If your computer does not have an NVIDIA® GPU, you can only install this version. If your computer has a GPU, it is recommended that you install the CPU version of PaddlePaddle first to check if your local environment is suitable. + +* PaddlePaddle with GPU support, in order to make the PaddlePaddle program run more quickly, we accelerate the PaddlePaddle program through the GPU, but the GPU version of PaddlePaddle needs to have the NVIDIA® GPU that meets the following conditions (see the NVIDIA official for the specific installation process and configuration). Documentation: [For CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/), [For cuDNN](https://docs.nvidia.com/deeplearning/sdk/cudnn-install/)) + + * *CUDA Toolkit 9.0 with cuDNN v7* + * *CUDA Toolkit 8.0 with cuDNN v7* + * *Hardware devices with GPU compute capability exceeding 1.0* + + +## Choose an installation method + +We offer 4 installation methods under the CentOS system: + +* Pip installation +* Docker installation (the GPU version is not supported) (the version of python in the image is 2.7) +* Source code compilation and installation (all versions of CentOS 6 and GPU version of CentOS 7 are not supported) +* 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 native environment and may have some issues related to your local environment. + +**Use Docker for installation** (the safest way to install), because we are installing 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 run directly on the native CPU and operating system. The performance is the same as installing the compiler on the machine. + +Compile and install from [**source**](#ct_source) and [**use Docker**](#ct_docker). This is a process of compiling the PaddlePaddle source code into a binary file and then installing the binary file. Compared with the binary form of PaddlePaddle that has been successfully tested and compiled for you, this manual compilation is more complicated, and we will answer you in detail at the end of this tutorial. + + +

+## ***Install PaddlePaddle using pip*** + +First, we use the following commands to check if **the environment of this machine** is suitable for installing PaddlePaddle: + +`Uname -m && cat /etc/*release` + +> The above command will display the operating system and processing bits of the machine. Please make sure your computer is consistent with the requirements of this tutorial. + +Second, your computer needs to meet the following requirements: + +* Python2.7.x (devel), Pip >= 9.0.1 + + > CentOS6 needs to compile Python 2.7 into a [shared library](./FAQ.html/#FAQ). + +* Python3.5+.x (devel), Pip3 >= 9.0.1 + + > You may have installed pip on your CentOS. Please use pip -V to confirm that we recommend using pip 9.0.1 or higher to install. + + Update the source of yum: `yum update` and install the extension source to install pip: `yum install -y epel-release` + + Use the following command to install or upgrade Python and pip to the required version: + + + - For Python2: `sudo yum install python-devel python-pip` + - For Python3: (Please refer to the official Python installation, and pay attention to whether the python3 version is consistent with the python version corresponding to the pip3 command. If there are multiple python3 versions, please specify the pip version such as pip3.7, or add soft link from pip3 to the python version you use. ) + + + + + > Even if you already have `Python` in your environment, you need to install the `python develop` package. + +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 who need **the GPU version PaddlePaddle**: `pip install paddlepaddle-gpu` or `pip3 install paddlepaddle-gpu` + + > 1 . In order to prevent problem "nccl.h cannot be found", please first install nccl2 according to the instructions of [NVIDIA official website](https://developer.nvidia.com/nccl/nccl-download). + + > 2 . If you do not specify the pypi package version number, we will by default provide you with a version of PaddlePaddle that supports Cuda 9/cuDNN v7. + + * For users with `Cannot uninstall 'six'.` problems, the probable reason is the existing Python installation issues in your system. In this case, use `pip install paddlepaddle --ignore-installed six`(CPU) or `pip install paddlepaddle-gpu -- Ignore-installed six` (GPU) to resolve. + + * 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](./Tables.html/#whls). If you need to obtain and install **the latest PaddlePaddle development branch**, you can download and install the latest whl installation package and c-api development package from [the latest dev installation package list](./Tables.html/#ciwhls) or our [CI system](https://paddleci.ngrok.io/project.html?projectId=Manylinux1&tab=projectOverview). 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](https://docs.docker.com/install/). + +> Please note that to install and use the PaddlePaddle version that supports GPU, you must first install [nvidia-docker](https://github.com/NVIDIA/nvidia-docker). + +Once you have **properly installed Docker**, you can start **installing PaddlePaddle with Docker**. + +1. Use the following command to pull the image we pre-installed for PaddlePaddle: + + * For users who need a **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](./Tables.html/#dockers)) + + +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 /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](https://baike.baidu.com/item/%E7%BB%9D%E5%AF%B9%E8%B7%AF%E5%BE%84/481185) of the current path ) which is mounted to the /paddle directory inside the container; `` 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 the 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 in the last step. + +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](https://docs.docker.com/). + +> 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` + +* ***GPU version of PaddlePaddle***: `pip uninstall paddlepaddle-gpu` or `pip3 uninstall paddlepaddle-gpu` diff --git a/doc/fluid/beginners_guide/install/install_MacOS_en.md b/doc/fluid/beginners_guide/install/install_MacOS_en.md new file mode 100644 index 0000000000000000000000000000000000000000..0e4e5cc6f9076f24be29008c8c4389f57bd5b152 --- /dev/null +++ b/doc/fluid/beginners_guide/install/install_MacOS_en.md @@ -0,0 +1,124 @@ +*** +# **Install under 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](https://brew.sh/) or [Python.org](https://www.python.org/ftp/python/2.7.15/python-2.7.15-macosx10.9.pkg). For Python3, please use python3.5.x, Python3.6.x or python3.7.x provided by [Python.org](https://www.python.org/downloads/mac-osx/). + + + 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](./Tables.html/#ciwhls-release). 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](https://paddleci.ngrok.io/project.html?projectId=Manylinux1&tab=projectOverview) 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](https://docs.docker.com/install/). + +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](./Tables.html/#dockers)) + +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 /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](https://baike.baidu.com/item/绝对路径/481185) ) of the current path is mounted to the /paddle directory inside the container; `` 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](https://docs.docker.com/). + +> 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` diff --git a/doc/fluid/beginners_guide/install/install_Ubuntu_en.md b/doc/fluid/beginners_guide/install/install_Ubuntu_en.md new file mode 100644 index 0000000000000000000000000000000000000000..912926230be797b7c81a28a679cec7b17207987d --- /dev/null +++ b/doc/fluid/beginners_guide/install/install_Ubuntu_en.md @@ -0,0 +1,159 @@ +*** + +# **Install under Ubuntu** + +This instruction describes how to install PaddlePaddle on a *64-bit desktop or laptop and Ubuntu system. The Ubuntu systems we support must meet the following requirements: + +Please note: Attempts on other systems may cause the installation to fail. Please ensure that your environment meets the conditions. The installation we provide by default requires your computer processor to support the AVX instruction set. Otherwise, please select the version of `no_avx` in the [latest Release installation package list](./Tables.html/#ciwhls-release). + +Under Ubuntu, you can use `cat /proc/cpuinfo | grep avx` to check if your processor supports the AVX instruction set. + +* Ubuntu 14.04 /16.04 /18.04 + +## Determine which version to install + +* PaddlePaddle for CPU is supported. If your computer does not have an NVIDIA® GPU, you can only install this version. If your computer has a GPU, it is also recommended that you install the CPU version of PaddlePaddle first to check if your local environment is suitable. + +* PaddlePaddle for GPU is supported. In order to make the PaddlePaddle program run more quickly, we accelerate the PaddlePaddle program through the GPU, but the GPU version of the PaddlePaddle needs to have the NVIDIA® GPU that meets the following conditions (see the NVIDIA official documentation for the specific installation process and configuration: [For CUDA](https://docs.nvidia.com/cuda/cuda-installation-guide-linux/), [For cuDNN](https://docs.nvidia.com/deeplearning/sdk/cudnn-install/)) + + * *CUDA Toolkit 9.0 with cuDNN v7* + * *CUDA Toolkit 8.0 with cuDNN v7* + * *Hardware devices with GPU computing power exceeding 1.0* + + + +## Choose an installation method + +Under the Ubuntu system, we offer 4 installation methods: + +* Pip installation +* Docker installation (the version of python in the image is 2.7) +* Source code compilation and installation +* Docker source code compilation and installation (the python version in the image is 2.7, 3.5, 3.6, 3.7) + + +**With pip installation** (the easiest way to install), we offer you a pip installation method, but it depends more on your native 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 native CPU and operating system. The performance is the same as installing the compiler on the machine. + +Compile and install from [**source**](#ubt_source) and [**use Docker**](#ubt_docker). This is a process of compiling the PaddlePaddle source code into a binary file and then installing the binary file. Compared to the binary PaddlePaddle that has been successfully tested and compiled for you, the manual compilation is more complicated, we will answer you in detail at the end of the description. + +

+### ***Install using pip*** + + +First, we use the following commands to **check if the environment of this machine** is suitable for installing PaddlePaddle: + + uname -m && cat /etc/*release + +>The above command will display the operating system and processing bits of the machine. Please make sure your computer is consistent with the requirements of this tutorial. + +Second, your computer needs to meet any of the following requirements: + +* Python2.7.x (dev), Pip >= 9.0.1 +* Python3.5+.x (dev), Pip3 >= 9.0.1 + +>You may have installed pip on your Ubuntu. Please use pip -V or pip3 -V to confirm its version is the recommended pip 9.0.1 or higher. + + Update apt source: `apt update` + +Use the following command to install or upgrade Python and pip to the required version: (pip and dev installation in python3.6, python3.7 differs greatly across different Ubuntu versions, thus the steps are omitted here) + + - For python2: `sudo apt install python-dev python-pip` + + - For python3.5: `sudo apt install python3.5-dev and curl https://bootstrap.pypa.io/get-pip.py -o - | python3.5 && easy_install pip` + + - For python3.6, python3.7: We assumed that python3.6 (3.7) and the corresponding versions of dev and pip3 are properly installed by yourself. + + +>Even if you already have Python 2 or Python 3 in your environment, you need to install Python-dev or Python 3.5 (3.6, 3.7) -dev. + +Now let's 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 who need **the GPU version PaddlePaddle**: `pip install paddlepaddle-gpu` or `pip3 install paddlepaddle-gpu` + + > 1.In order to prevent problem "nccl.h cannot be found", please first install nccl2 according to the following command (here is ubuntu 16.04, CUDA9, ncDNN v7 nccl2 installation instructions), for more information about the installation information, please refer to [the NVIDIA official website](https://developer.nvidia.com/nccl/nccl-download): + + i. `Wget http://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu1604/x86_64/nvidia-machine-learning-repo-ubuntu1604_1.0.0-1_amd64.deb` + ii. `dpkg -i nvidia-machine- Learning-repo-ubuntu1604_1.0.0-1_amd64.deb` + iii. `sudo apt-get install -y libnccl2=2.2.13-1+cuda9.0 libnccl-dev=2.2.13-1+cuda9.0` + + > 2.If you do not specify the pypi package version number, we will by default provide you with a version of PaddlePaddle that supports Cuda 9/cuDNN v7. + + * For users with `Cannot uninstall 'six'.` problems, the probable reason is the existing Python installation issues in your system. In this case, use `pip install paddlepaddle --ignore-installed six`(CPU) or `pip install paddlepaddle-gpu -- Ignore-installed six` (GPU) to resolve. + + * 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](./Tables.html/#whls). If you need to obtain and install **the latest PaddlePaddle development branch**, you can download and install the latest whl installation package and c-api development package from [the latest dev installation package list](./Tables.html/#ciwhls) or our [CI system](https://paddleci.ngrok.io/project.html?projectId=Manylinux1&tab=projectOverview). To log in, click on "Log in as guest". + + +Now you have completed the process of installing PaddlePaddle using `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](https://docs.docker.com/install/). + +> Please note that to install and use the PaddlePaddle version that supports GPU, you must first install [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) + +If Docker is **properly installed**, you can start **installing PaddlePaddle using Docker**. + +1. Use the following command to pull the image we pre-installed for PaddlePaddle: + + * For users who need **a 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` + + * For users who need **a GPU version of PaddlePaddle**, use the following command to pull the image we pre-installed for your *PaddlePaddle For GPU*: + + `Docker pull hub.baidubce.com/paddlepaddle/paddle:1.2-gpu-cuda9.0-cudnn7` + + * 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](https://github.com/PaddlePaddle/FluidDoc/blob/develop/doc/fluid/beginners_guide/install/Tables.html/#dockers)) + +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 /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; `` 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](https://docs.docker.com/). + +>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` + +- ***GPU version of PaddlePaddle***: `pip uninstall paddlepaddle-gpu` or `pip3 uninstall paddlepaddle-gpu` diff --git a/doc/fluid/beginners_guide/install/install_Windows_en.md b/doc/fluid/beginners_guide/install/install_Windows_en.md new file mode 100644 index 0000000000000000000000000000000000000000..75f0a30711e3fbe55372c48c5ea88dc1c029e86e --- /dev/null +++ b/doc/fluid/beginners_guide/install/install_Windows_en.md @@ -0,0 +1,52 @@ +*** + +# **Install under Windows** + +This instruction will show you how to install PaddlePaddle on a 64-bit desktop or laptop and Windows. The Windows systems we support must meet the following requirements. + + +Please note: Attempts on other systems may cause the installation to fail. Please ensure that your environment meets the conditions. The installation we provide by default requires your computer processor to support the AVX instruction set. Otherwise, please select the version of `no_avx` in [the multi-version whl package installation list](Tables.html/#ciwhls): + +Windows can use software such as `cpu-z` to detect whether your processor supports the AVX instruction set. + +The current version does not support NCCL, distributed, AVX, warpctc and MKL related functions. + +* *Windows 7/8 and Windows 10 Professional/Enterprise Edition* + +## Determine which version to install + +* Under Windows, we currently only offer PaddlePaddle that supports CPU. + +## Choose an installation method + +### ***Install using pip*** + +We do not provide a quick installation command, please install according to the following steps： + +* First, **check that your computer and operating system** meet the following requirements: + + For python2: Python2.7.15 downloaded from official Python + For python3: Use python3.5.x, python3.6.x or python3.7.x downloaded from official Python + +* Python2.7.x :pip >= 9.0.1 +* Python3.5.x, python3.6.x or python3.7.x :pip3 >= 9.0.1 + +Here's how to install PaddlePaddle: + +* Use pip install to install PaddlePaddle: + + ** paddlepaddle's dependency package `recordio` may not be installed with `pip`'s default source, you can use `easy_install recordio` to install. ** + + ** For users who need **the CPU version PaddlePaddle**: `pip install paddlepaddle` or `pip3 install paddlepaddle`. ** + +Now you have completed the process of installing PaddlePaddle via `pip install`. + +## ***Verify installation*** + +After completing the installation, 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*** + +Use the following command to uninstall PaddlePaddle (users who use Docker to install PaddlePaddle, please use the following command in the container containing PaddlePaddle): + +* ***CPU version of PaddlePaddle***: `pip uninstallpaddlepaddle `or `pip3 uninstall paddlepaddle`