docker_install_cn.rst 8.3 KB
Newer Older
1 2
PaddlePaddle的Docker容器使用方式
================================
Z
zhangjinchao01 已提交
3

4
PaddlePaddle目前唯一官方支持的运行的方式是Docker容器。因为Docker能在所有主要操作系统(包括Linux,Mac OS X和Windows)上运行。 请注意,您需要更改 `Dockers设置 <https://github.com/PaddlePaddle/Paddle/issues/627>`_ 才能充分利用Mac OS X和Windows上的硬件资源。
Z
zhangjinchao01 已提交
5 6


Y
yi.wu 已提交
7
PaddlePaddle发布的docker镜像使用说明
L
liaogang 已提交
8
------------------------------
Z
zhangjinchao01 已提交
9

10 11 12 13 14 15 16 17 18 19 20
我们把PaddlePaddle的编译环境打包成一个镜像,称为开发镜像,里面涵盖了
PaddlePaddle需要的所有编译工具。把编译出来的PaddlePaddle也打包成一个镜
像,称为生产镜像,里面涵盖了PaddlePaddle运行所需的所有环境。每次
PaddlePaddle发布新版本的时候都会发布对应版本的生产镜像以及开发镜像。运
行镜像包括纯CPU版本和GPU版本以及其对应的非AVX版本。我们会在
`dockerhub.com <https://hub.docker.com/r/paddledev/paddle/>`_ 提供最新
的docker镜像,可以在"tags"标签下找到最新的Paddle镜像版本。为了方便在国
内的开发者下载Docker镜像,我们提供了国内的镜像服务器供大家使用。如果您
在国内,请把文档里命令中的paddlepaddle/paddle替换成
docker.paddlepaddle.org/paddle。

Y
update  
yi.wu 已提交
21
1. 开发镜像::code:`paddlepaddle/paddle:<version>-dev`
Z
zhangjinchao01 已提交
22

23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
   这个镜像包含了Paddle相关的开发工具以及编译和运行环境。用户可以使用开发镜像代替配置本地环境,完成开发,编译,发布,
   文档编写等工作。由于不同的Paddle的版本可能需要不同的依赖和工具,所以如果需要自行配置开发环境需要考虑版本的因素。
   开发镜像包含了以下工具:
   
   - gcc/clang
   - nvcc
   - Python
   - sphinx
   - woboq
   - sshd
   很多开发者会使用远程的安装有GPU的服务器工作,用户可以使用ssh登录到这台服务器上并执行 :code:`docker exec`进入开发镜像并开始工作,
   也可以在开发镜像中启动一个SSHD服务,方便开发者直接登录到镜像中进行开发:

   以交互容器方式运行开发镜像:

   .. code-block:: bash

      docker run -it --rm paddlepaddle/paddle:<version>-dev /bin/bash

   或者,可以以后台进程方式运行容器:

   .. code-block:: bash

      docker run -d -p 2202:22 -p 8888:8888 paddledev/paddle:<version>-dev
Z
zhangjinchao01 已提交
47

48
   然后用密码 :code:`root` SSH进入容器:
Z
zhangjinchao01 已提交
49

50
   .. code-block:: bash
51

52
      ssh -p 2202 root@localhost
53

54
   SSH方式的一个优点是我们可以从多个终端进入容器。比如,一个终端运行vi,另一个终端运行Python。另一个好处是我们可以把PaddlePaddle容器运行在远程服务器上,并在笔记本上通过SSH与其连接。
55

56
2. 生产镜像:根据CPU、GPU和非AVX区分了如下4个镜像:
57

58 59 60 61
   - GPU/AVX::code:`paddlepaddle/paddle:<version>-gpu`
   - GPU/no-AVX::code:`paddlepaddle/paddle:<version>-gpu-noavx`
   - CPU/AVX::code:`paddlepaddle/paddle:<version>`
   - CPU/no-AVX::code:`paddlepaddle/paddle:<version>-noavx`
62

63
   纯CPU镜像以及GPU镜像都会用到AVX指令集,但是2008年之前生产的旧电脑不支持AVX。以下指令能检查Linux电脑是否支持AVX:
64

65
   .. code-block:: bash
66

67
      if cat /proc/cpuinfo | grep -i avx; then echo Yes; else echo No; fi
Z
zhangjinchao01 已提交
68

69
   如果输出是No,就需要选择使用no-AVX的镜像
Z
zhangjinchao01 已提交
70

71 72
   以上方法在GPU镜像里也能用,只是请不要忘记提前在物理机上安装GPU最新驱动。
   为了保证GPU驱动能够在镜像里面正常运行,我们推荐使用[nvidia-docker](https://github.com/NVIDIA/nvidia-docker)来运行镜像。
L
liaogang 已提交
73

74
   .. code-block:: bash
L
liaogang 已提交
75

76
      nvidia-docker run -it --rm paddledev/paddle:0.10.0rc1-gpu /bin/bash
L
liaogang 已提交
77

78
   注意: 如果使用nvidia-docker存在问题,你也许可以尝试更老的方法,具体如下,但是我们并不推荐这种方法。:
Z
zhangjinchao01 已提交
79

80
   .. code-block:: bash
Z
zhangjinchao01 已提交
81

82 83 84
      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 paddledev/paddle:<version>-gpu
Z
zhangjinchao01 已提交
85

86
3. 运行以及发布您的AI程序
Z
zhangjinchao01 已提交
87

88
   假设您已经完成了一个AI训练的python程序 :code:`a.py`,这个程序是您在开发机上使用开发镜像完成开发。此时您可以运行这个命令在开发机上进行测试运行:
Z
zhangjinchao01 已提交
89

90
   .. code-block:: bash
Z
zhangjinchao01 已提交
91

92
      docker run -it -v $PWD:/work paddle /work/a.py
93

94
   如果要使用GPU,请运行:
95

96
   .. code-block:: bash
97

98
      nvidia-docker run -it -v $PWD:/work paddle /work/a.py
99 100


101 102
   这里`a.py`包含的所有依赖假设都可以在Paddle的运行容器中。如果需要包含更多的依赖、或者需要发布您的应用的镜像,可以编写`Dockerfile`使用`FROM paddledev/paddle:<version>`
   创建和发布自己的AI程序镜像。
103

Y
yi.wu 已提交
104 105
运行PaddlePaddle书籍
---------------------
106

Y
yi.wu 已提交
107
Jupyter Notebook是一个开源的web程序,大家可以通过它制作和分享带有代码、公式、图表、文字的交互式文档。用户可以通过网页浏览文档。
Z
zhangjinchao01 已提交
108

Y
yi.wu 已提交
109 110
PaddlePaddle书籍是为用户和开发者制作的一个交互式的Jupyter Nodebook。
如果您想要更深入了解deep learning,PaddlePaddle书籍一定是您最好的选择。
Z
zhangjinchao01 已提交
111

Y
yi.wu 已提交
112
我们提供可以直接运行PaddlePaddle书籍的docker镜像,直接运行:
Z
zhangjinchao01 已提交
113

114
.. code-block:: bash
Z
zhangjinchao01 已提交
115

Y
update  
yi.wu 已提交
116
    docker run -p 8888:8888 paddlepaddle/book
Z
zhangjinchao01 已提交
117

Y
yi.wu 已提交
118
然后在浏览器中输入以下网址:
Z
zhangjinchao01 已提交
119

Y
yi.wu 已提交
120
.. code-block:: text
Z
zhangjinchao01 已提交
121

Y
yi.wu 已提交
122
    http://localhost:8888/
Z
zhangjinchao01 已提交
123

Y
yi.wu 已提交
124
就这么简单,享受您的旅程!
Z
zhangjinchao01 已提交
125

126 127
通过Docker容器开发PaddlePaddle
------------------------------
Z
zhangjinchao01 已提交
128

Y
yi.wu 已提交
129 130
开发人员可以在Docker开发镜像中开发PaddlePaddle。这样开发人员可以以一致的方式在不同的平台上工作 - Linux,Mac OS X和Windows。

131
1. 制作PaddlePaddle开发镜像
L
liaogang 已提交
132

133 134
   PaddlePaddle每次发布新版本都会发布对应的开发镜像供开发者直接使用。这里介绍如生成造这个开发镜像。
   生成Docker镜像的方式有两个,一个是直接把一个容器转换成镜像,另一个是创建Dockerfile并运行docker build指令按照Dockerfile生成镜像。第一个方法的好处是简单快捷,适合自己实验,可以快速迭代。第二个方法的好处是Dockerfile可以把整个生成流程描述很清楚,其他人很容易看懂镜像生成过程,持续集成系统也可以简单地复现这个过程。我们采用第二个方法。Dockerfile位于PaddlePaddle repo的根目录。生成生产镜像只需要运行:
L
liaogang 已提交
135

136 137 138
   .. code-block:: bash
      
      git clone https://github.com/PaddlePaddle/Paddle.git
139
      cd Paddle
Y
yi.wu 已提交
140
      docker build -t paddle:dev .
L
liaogang 已提交
141

142
   docker build这个命令的-t指定了生成的镜像的名字,这里我们用paddle:dev。到此,PaddlePaddle开发镜像就被构建完毕了。
L
liaogang 已提交
143

144
2. 制作PaddlePaddle生产镜像
Z
zhangjinchao01 已提交
145

146
   生产镜像的生成分为两步,第一步是运行:
Y
yi.wu 已提交
147

148
   .. code-block:: bash
149 150
      
      docker run -v $(pwd):/paddle -e "WITH_GPU=OFF" -e "WITH_AVX=OFF" -e "WITH_TEST=ON" paddle:dev
Z
zhangjinchao01 已提交
151

152
   以上命令会编译PaddlePaddle,生成运行程序,以及生成创建生产镜像的Dockerfile。所有生成的的文件都在build目录下。“WITH_GPU”控制生成的生产镜像是否支持GPU,“WITH_AVX”控制生成的生产镜像是否支持AVX,”WITH_TEST“控制是否生成单元测试。
Z
zhangjinchao01 已提交
153

154
   第二步是运行:
Y
yi.wu 已提交
155

156
   .. code-block:: bash
157 158
      
      docker build -t paddle:prod -f build/Dockerfile .
Z
zhangjinchao01 已提交
159

160
以上命令会按照生成的Dockerfile把生成的程序拷贝到生产镜像中并做相应的配置,最终生成名为paddle:prod的生产镜像。
Z
zhangjinchao01 已提交
161

162
3. 运行单元测试
Z
zhangjinchao01 已提交
163

164
   运行以下指令:
Y
yi.wu 已提交
165

166
   .. code-block:: bash
167 168
      
      docker run -it -v $(pwd):/paddle paddle:dev bash -c "cd /paddle/build && ctest"
169 170 171 172

文档
----

Y
yi.wu 已提交
173
Paddle的Docker开发镜像带有一个通过 `woboq code browser
174 175 176 177 178 179
<https://github.com/woboq/woboq_codebrowser>`_ 生成的HTML版本的C++源代码,便于用户浏览C++源码。

只要在Docker里启动PaddlePaddle的时候给它一个名字,就可以再运行另一个Nginx Docker镜像来服务HTML代码:

.. code-block:: bash

Y
yi.wu 已提交
180
   docker run -d --name paddle-cpu-doc paddle:<version>-dev
181 182 183
   docker run -d --volumes-from paddle-cpu-doc -p 8088:80 nginx

接着我们就能够打开浏览器在 http://localhost:8088/paddle/ 浏览代码。