Skip to content

Commit 19a0a32

Browse files
committed
revert build cn docs
1 parent f953a6e commit 19a0a32

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
PaddlePaddle的编译选项
2+
======================
3+
4+
PaddlePaddle的编译选项,包括生成CPU/GPU二进制文件、链接何种BLAS库等。用户可在调用cmake的时候设置它们,详细的cmake使用方法可以参考 `官方文档 <https://cmake.org/cmake-tutorial>`_ 。
5+
6+
Bool型的编译选项
7+
----------------
8+
用户可在cmake的命令行中,通过使用 ``-D`` 命令设置该类编译选项,例如
9+
10+
.. code-block:: bash
11+
12+
cmake .. -DWITH_GPU=OFF
13+
14+
.. csv-table:: Bool型的编译选项
15+
:widths: 1, 7, 2
16+
:file: compile_options.csv
17+
18+
BLAS/CUDA/Cudnn的编译选项
19+
--------------------------
20+
BLAS
21+
+++++
22+
23+
PaddlePaddle支持以下任意一种BLAS库:`MKL <https://software.intel.com/en-us/intel-mkl>`_ ,`ATLAS <http://math-atlas.sourceforge.net/>`_ ,`OpenBlAS <http://www.openblas.net/>`_ 和 `REFERENCE BLAS <http://www.netlib.org/blas/>`_ 。
24+
25+
.. csv-table:: BLAS路径相关的编译选项
26+
:widths: 1, 2, 7
27+
:file: cblas_settings.csv
28+
29+
CUDA/Cudnn
30+
+++++++++++
31+
32+
PaddlePaddle可以使用cudnn v2之后的任何一个版本来编译运行,但尽量请保持编译和运行使用的cudnn是同一个版本。 我们推荐使用最新版本的cudnn v5.1。
33+
34+
编译选项的设置
35+
++++++++++++++
36+
37+
PaddePaddle通过编译时指定路径来实现引用各种BLAS/CUDA/Cudnn库。cmake编译时,首先在系统路径(/usr/lib\:/usr/local/lib)中搜索这几个库,同时也会读取相关路径变量来进行搜索。 通过使用 ``-D`` 命令可以设置,例如
38+
39+
.. code-block:: bash
40+
41+
cmake .. -DMKL_ROOT=/opt/mkl/ -DCUDNN_ROOT=/opt/cudnnv5
42+
43+
注意:这几个编译选项的设置,只在第一次cmake的时候有效。如果之后想要重新设置,推荐清理整个编译目录(``rm -rf``)后,再指定。
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
编译选项,描述,注意
2+
MKL_ROOT,MKL的路径,${MKL_ROOT}/include下需要包含mkl.h,${MKL_ROOT}/lib目录下需要包含mkl_core,mkl_sequential和mkl_intel_lp64三个库。
3+
ATLAS_ROOT,ATLAS的路径,${ATLAS_ROOT}/include下需要包含cblas.h,${ATLAS_ROOT}/lib下需要包含cblas和atlas两个库。
4+
OPENBLAS_ROOT,OpenBLAS的路径,${OPENBLAS_ROOT}/include下需要包含cblas.h,${OPENBLAS_ROOT}/lib下需要包含openblas库。
5+
REFERENCE_CBLAS_ROOT,REFERENCE BLAS的路径,${REFERENCE_CBLAS_ROOT}/include下需要包含cblas.h,${REFERENCE_CBLAS_ROOT}/lib下需要包含cblas库。
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
选项,说明,默认值
2+
WITH_GPU,是否支持GPU。,取决于是否寻找到CUDA工具链
3+
WITH_DOUBLE,是否使用双精度浮点数。,否
4+
WITH_DSO,是否运行时动态加载CUDA动态库,而非静态加载CUDA动态库。,是
5+
WITH_AVX,是否编译含有AVX指令集的PaddlePaddle二进制文件,是
6+
WITH_PYTHON,是否内嵌PYTHON解释器。方便今后的嵌入式移植工作。,是
7+
WITH_STYLE_CHECK,是否编译时进行代码风格检查,是
8+
WITH_RDMA,是否开启RDMA,否
9+
WITH_TIMER,是否开启计时功能。如果开启会导致运行略慢,打印的日志变多,但是方便调试和测Benchmark,否
10+
WITH_TESTING,是否开启单元测试,取决于是否寻找到GTEST
11+
WITH_DOC,是否编译中英文文档,否
12+
WITH_SWIG_PY,是否编译PYTHON的SWIG接口,该接口可用于预测和定制化训练,取决于是否寻找到SWIG

0 commit comments

Comments
 (0)