forked from PaddlePaddle/docs
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Synchronize the English compilation and installation doc with chinese…
…,test=develop (PaddlePaddle#1920) Synchronize the English compilation and installation doc with chinese.
- Loading branch information
1 parent
4c14798
commit 8e63ecf
Showing
5 changed files
with
190 additions
and
154 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,99 +1,118 @@ | ||
# **Compile on 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: | ||
## Environment preparation | ||
|
||
* Windows 10 Professional Edition / Enterprise Edition | ||
* Visual Studio 2015 Update3 | ||
* **Windows 7/8/10 Pro/Enterprise(64bit)** | ||
* **GPU Version support CUDA 9.0/9.1/9.2/10.0/10.1, and only support single GPU** | ||
* **Python version 2.7.15+/3.5.1+/3.6/3.7(64bit)** | ||
* **pip version 9.0.1+(64bit)** | ||
* **Visual Studio 2015 Update3** | ||
|
||
## Choose a compilation method | ||
## Choose CPU/GPU | ||
|
||
We provide one compilation method under the Windows system: | ||
* If your computer doesn't have NVIDIA® GPU, please install CPU version of PaddlePaddle | ||
|
||
* Direct source code compilation | ||
* If your computer has NVIDIA® GPU, and the following conditions are met,GPU version of PaddlePaddle is recommended. | ||
* **CUDA toolkit 9.0/9.1/9.2/10.0/10.1 with cuDNN v7.3+** | ||
* **GPU's computing capability exceeds 1.0** | ||
|
||
Since the situation on host machine is more complicated, we only support specific systems. | ||
## Installation steps | ||
|
||
Please note: The current version does not support NCCL and distributed related functions. | ||
There is one compilation methods in Windows system: | ||
|
||
* Direct native source code compilation(NCCL, distributed and other related functions are not supported temporarily) | ||
|
||
### ***Local compilation*** | ||
<a name="win_source"></a> | ||
### ***Direct native source code compilation*** | ||
|
||
**Please strictly follow the following instructions step by step** | ||
|
||
1. Check that your computer and operating system meet our supported compilation standards | ||
1. Install the necessary tools i.e. cmake, git and python: | ||
|
||
* Windows 10 Professional Edition / Enterprise Edition | ||
> Cmake requires version 3.5 and above, which can be downloaded from the [official website](https://cmake.org/download/) and added to the environment variable. | ||
* Visual Studio 2015 Update3 | ||
> Python requires version 2.7 and above, which can be downloaded from the [official website](https://www.python.org/download/releases/2.7/). | ||
2. Install the necessary tools i.e. cmake, git and python : | ||
* After installing python, please check whether the python version is the expected version by `python-version`, because you may have more than one python installed on your computer. You can handle conflicts of multiple pythons by changing the order of the environment variables. | ||
|
||
> 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/). | ||
> `numpy, protobuf, wheel` are needed to be installed. Use the 'pip' command. | ||
> Git can be downloaded on the official website and added to the environment variable. [Download here](https://gitforwindows.org/). | ||
* To Install numpy package you can use command `pip install numpy` | ||
|
||
> 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 protobuf package you can use command `pip install protobuf` | ||
|
||
* To Install Wheel package you can use command `pip install wheel` | ||
|
||
* To Install numpy package you can use command `pip install numpy` or command `pip3 install numpy` | ||
> Git can be downloaded on the [official website](https://gitforwindows.org/) and added to the environment variable. | ||
* To Install protobuf package you can use command `pip install protobuf` or command `pip3 install protobuf` | ||
2. Clone the PaddlePaddle source code to the Paddle subdirectories of the current directory and go to the Paddle subdirectories: | ||
|
||
* To Install Wheel package you can use command `pip install wheel` or `pip3 install wheel` | ||
- `git clone https://github.com/PaddlePaddle/Paddle.git` | ||
- `cd Paddle` | ||
|
||
3. Switch to a more stable release branch for compilation: | ||
|
||
3. Clone the PaddlePaddle source in the Paddle folder in the current directory and go to the Paddle directory: | ||
`git checkout [name of the branch]` | ||
|
||
- `git clone https://github.com/PaddlePaddle/Paddle.git` | ||
- `cd Paddle` | ||
For example: | ||
|
||
4. Switch to a more stable release branch for compilation : | ||
`git checkout release/1.7` | ||
|
||
- `git checkout release/1.5` | ||
Note: python3.6、python3.7 version started supporting from release/1.2 | ||
|
||
5. Create a directory called build and enter it: | ||
4. Create a directory called build and enter it: | ||
|
||
- `mkdir build` | ||
- `cd build` | ||
|
||
6. Execute cmake: | ||
5. 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` | ||
`cmake .. -G "Visual Studio 14 2015 Win64" -DWITH_GPU=OFF -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release` | ||
|
||
* For users who need to compile **the GPU version PaddlePaddle**: | ||
|
||
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` | ||
`cmake .. -G "Visual Studio 14 2015 Win64" -DWITH_GPU=ON -DWITH_TESTING=OFF -DCMAKE_BUILD_TYPE=Release` | ||
|
||
Python2 by default,Python3 please add: | ||
|
||
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. | ||
> -DPY_VERSION=3 (or 3.5、3.6、3.7) | ||
8. Use Blend for Visual Studio 2015 to open `paddle.sln` file, select the platform `x64`, configure with `Release`, then begin to compile | ||
If your device information contains multiple Python or CUDA, you can also specify a specific version of Python or CUDA by setting the corresponding compile options: | ||
|
||
9. Having compiled successfully, go to the `\paddle\build\python\dist`directory and find the generated `.whl` package: | ||
> -DPYTHON_EXECUTABLE: the installation path of python | ||
`cd \paddle\build\python\dist` | ||
> -DCUDA_TOOLKIT_ROOT_DIR: the installation path of CUDA | ||
For example: (for instance only, please set it according to your actual installation path) | ||
|
||
10. Install the compiled `.whl` package on the current machine or target machine: | ||
`cmake .. -G "Visual Studio 14 2015 Win64" -DCMAKE_BUILD_TYPE=Release -DWITH_GPU=ON -DWITH_TESTING=OFF -DPYTHON_EXECUTABLE=C:\\Python36\\python.exe -DCUDA_TOOLKIT_ROOT_DIR="C:\\Program Files\\NVIDIA GPU Computing Toolkit\\CUDA\v10.0"` | ||
|
||
`pip install (whl package name)` or `pip3 install (whl package name)` | ||
6. Use Blend for Visual Studio 2015 to open `paddle.sln` file, select the platform `x64`, configure with `Release`, then begin to compile | ||
|
||
Congratulations, now you have completed the process of compiling PaddlePaddle natively. | ||
7. After compilation successfully, go to the `\paddle\build\python\dist` directory and find the generated `.whl` package: | ||
|
||
`cd \paddle\build\python\dist` | ||
|
||
8. Install the generated `.whl` package: | ||
|
||
`pip install -U (whl package name)` | ||
|
||
Congratulations, you have completed the process of compiling PaddlePaddle successfully! | ||
|
||
### ***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. | ||
After the compilation and installation is completed, you can use `python` to enter the Python interface, input `import paddle.fluid as fluid` and then `fluid.install_check.run_check()` to verify that the installation was successful. | ||
|
||
If `Your Paddle Fluid is installed succesfully!` appears, it means the compilation and installation was successful. | ||
|
||
|
||
### ***How to uninstall*** | ||
|
||
Please use the following command to uninstall PaddlePaddle: | ||
|
||
* ***CPU version of PaddlePaddle*** : `pip uninstall paddlepaddle` or `pip3 uninstall paddlepaddle` | ||
* ***CPU version of PaddlePaddle*** : `pip uninstall paddlepaddle` | ||
|
||
* ***GPU version of PaddlePaddle*** : `pip uninstall paddlepaddle-gpu` or `pip3 uninstall paddlepaddle-gpu` | ||
* ***GPU version of PaddlePaddle*** : `pip uninstall paddlepaddle-gpu` |
Oops, something went wrong.