Update installation docs #5818

typhoonzero · 2017-11-22T05:01:36Z

For convenient review, please look here

should add latest download links according to Paddle do not fit PEP 513 manylinux1 standard #4050 (comment)

wangkuiyi

Why would we need to convert markdown files into RST?

typhoonzero · 2017-11-22T06:45:37Z

@wangkuiyi convert markdown files into RST so that these docs can be deployed to http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html

luotao1 · 2017-11-22T07:04:19Z

@wangkuiyi RST is much convenient and strong for displaying table, code, index tree, etc than Markdown.

Though I was not familiar with each function of RST , there is an example when we want to display table beautifully on both website and github.

If we use Markdown, we should write html, see https://github.com/PaddlePaddle/Paddle/pull/5399/files#diff-dfd1b6519ee0558a1c7b124efa2ea816 for example. @Xreki do a lot of work in display table beautifully in Rename doc/howto/cross_compiling into doc/mobile #5399 , but don't find a better way than html.
If we use RST, the code is more simply:

luotao1 · 2017-11-22T07:06:40Z

@typhoonzero Markdown docs can also be deployed to http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html

luotao1 · 2017-11-22T07:26:13Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+   git clone https://github.com/PaddlePaddle/Paddle.git
+   cd Paddle
+   # 如果使用Docker编译环境，执行下面的命令
+   docker run -it -v $PWD:/paddle -e "WITH_GPU=ON" -e "WITH_TESTING=OFF" paddlepaddle/paddle_manylinux_devel:cuda8.0_cudnn5 bash -x paddle/scripts/docker/build.sh


示例中WITH_GPU=OFF会不会好一点， 23行也是。或者说明一下？

luotao1 · 2017-11-22T07:41:43Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+    "MKL_ROOT", "${MKL_ROOT}/include下需要包含mkl.h，${MKL_ROOT}/lib目录下需要包含mkl_core，mkl_sequential和mkl_intel_lp64三个库。"
+    "ATLAS_ROOT", "${ATLAS_ROOT}/include下需要包含cblas.h，${ATLAS_ROOT}/lib下需要包含cblas和atlas两个库。"
+    "OPENBLAS_ROOT", "${OPENBLAS_ROOT}/include下需要包含cblas.h，${OPENBLAS_ROOT}/lib下需要包含openblas库。"
+    "REFERENCE_CBLAS_ROOT", "${REFERENCE_CBLAS_ROOT}/include下需要包含cblas.h，${REFERENCE_CBLAS_ROOT}/lib下需要包含cblas库。"


现在这些ROOT都不用用户自己指定了，OpenBlas和MKL都是自动下载第三方库。

编译选项："WITH_MKL", "是否使用MKL数学库", "是"
否的时候：使用OpenBlas数学库。

如果机器含有AVX2指令集，还会下载MKL-DNN数学库，文档：https://github.com/PaddlePaddle/Paddle/tree/develop/doc/design/mkldnn#cmake

可以再组织一下。

@Xreki @hedaoyuan ATLAS是不是可以删了？

luotao1 · 2017-11-22T07:43:22Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+CUDA/Cudnn
+++++++++++
+
+PaddlePaddle可以使用cudnn v2之后的任何一个版本来编译运行，但尽量请保持编译和运行使用的cudnn是同一个版本。 我们推荐使用最新版本的cudnn v5.1。


PaddlePaddle可以使用cudnn v2之后的任何一个版本来编译运行

现在必须使用V5.1 @qingqing01 这块还有什么其他需要注意的地方么

cudnn -> cuDNN, 要求最低v5.1吧，其他应该没了。

CUDA加下 CUDA_ARCH_NAME参数，提醒开发者-DCUDA_ARCH_NAME=Auto可以加速编译吧。

luotao1 · 2017-11-22T07:43:51Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+
+..  code-block:: bash
+
+    cmake .. -DMKL_ROOT=/opt/mkl/ -DCUDNN_ROOT=/opt/cudnnv5


-DMKL_ROOT=/opt/mkl/ 这个可以去掉，用户不用设置了。

只保留了MKL和OpenBLAS，我看cmake中其他的已经没在使用了。

luotao1 · 2017-11-22T07:50:06Z

doc/getstarted/build_and_install/docker_install_cn.rst

-  访问到主机上的文件。可以通过*挂载Volume*的方式，将主机上的文件或目录挂载到
-  Docker容器中。下面的命令把当前目录挂载到了容器中的 /data 目录下，容器使用
-  debian镜像，并且启动后执行 :code:`ls /data`。
+下载GPU版本的Docker镜像：


这里只说明了GPU版本的镜像，是不是也要说明一下CPU版本的Docker镜像（使用MKL数学库）和CPU版本的Docker镜像（使用OpenBlas数学库）呢？

luotao1 · 2017-11-22T07:51:24Z

doc/getstarted/build_and_install/docker_install_cn.rst


  .. code-block:: bash
+     docker pull paddlepaddle/paddle:latest-gpu


这里没有显示33行的内容。

luotao1 · 2017-11-22T07:54:01Z

doc/getstarted/build_and_install/docker_install_cn.rst


-   如果要使用GPU，请运行：
+假设您已经在当前目录编写了一个PaddlePaddle的程序 :code:`train.py`（可以参考


这里能加一下当前目录是什么吗，因为很多用户不知道56行那个命令去哪儿打：

cd your_dir; docker run -it -v $PWD:/work paddlepaddle/paddle /work/train.py

luotao1 · 2017-11-22T07:55:02Z

doc/getstarted/build_and_install/docker_install_cn.rst


+使用Docker可以快速在本地启动一个包含了PaddlePaddle官方Book教程的Jupiter Notebook，可以通过网页浏览。


Jupiter笔误

luotao1 · 2017-11-22T07:57:00Z

doc/getstarted/build_and_install/index_cn.rst


 ..  toctree::
    :maxdepth: 1

-    cmake/build_from_source_cn.rst
+    build_from_source_cn.rst


需要加一个FAQ的链接么？https://github.com/PaddlePaddle/Paddle/blob/develop/doc/faq/build_and_install/index_cn.rst

luotao1 · 2017-11-22T07:58:52Z

doc/getstarted/build_and_install/pip_install_cn.rst

+
+如果需要获取并安装最新的（开发分支）PaddlePaddle，可以从我们的CI系统中下载最新的whl安装包并安装，在下面的链接中，使用guest登陆，然后点击Artifact标签，可以找到最新的whl安装包：
+
+- `CPU版本 <https://paddleci.ngrok.io/viewLog.html?buildTypeId=Manylinux1_CpuAvxCp27cp27mu&buildId=lastSuccessful>`_


29行的CPU版本是使用MKL数学库，https://paddleci.ngrok.io/viewType.html?buildTypeId=Manylinux1_CpuAvxOpenblas 这个是使用OpenBlas数学库

typhoonzero · 2017-11-22T08:11:09Z

Markdown docs can also be deployed to http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html

@luotao1 Thanks, I see.

luotao1 · 2017-11-22T09:25:31Z

doc/getstarted/build_and_install/docker_install_cn.rst

-   然后用密码 :code:`root` SSH进入容器：
+下载指定版本的Docker镜像，可以从
+ `DockerHub网站 <https://hub.docker.com/r/paddlepaddle/paddle/tags/>`_
+ 获取可选的tag，并执行下面的命令：


这段上下文这儿格式不对，请调整。

luotao1 · 2017-11-22T09:28:07Z

doc/getstarted/build_and_install/docker_install_cn.rst


  .. code-block:: bash

-     docker run paddlepaddle/paddle:0.10.0
+     docker pull docker.paddlepaddle.org/paddle


这儿的命令都缩进了

底下book那里没有缩进了两格

请调整全文相似缩进的地方。

luotao1 · 2017-11-22T09:29:48Z

doc/getstarted/build_and_install/docker_install_cn.rst

-   .. code-block:: bash
-
-      docker build -t paddle:prod -f build/Dockerfile ./build
+关于AVX：


117行要加粗么

Comments all done, also updated docs under doc/getstarted

luotao1 · 2017-11-22T09:31:46Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+
+PaddlePaddle编译需要使用到下面的依赖（包含但不限于），其他的依赖软件，会自动在编译时下载。
+
+.. csv-table:: PaddlePaddle编译依赖


表格的标题是斜体？不过可以等merge进整体网站的时候看看标题是否还是斜体。

qingqing01 · 2017-11-22T10:29:07Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+CUDA/Cudnn
+++++++++++
+
+PaddlePaddle可以使用cudnn v2之后的任何一个版本来编译运行，但尽量请保持编译和运行使用的cudnn是同一个版本。 我们推荐使用最新版本的cudnn v5.1。


CUDA加下 CUDA_ARCH_NAME参数，提醒开发者-DCUDA_ARCH_NAME=Auto可以加速编译吧。

qingqing01 · 2017-11-22T10:31:23Z

doc/getstarted/build_and_install/build_from_source_cn.rst

+    "WITH_TESTING", "是否开启单元测试", "是"
+    "WITH_DOC", "是否编译中英文文档", "否"
+    "WITH_SWIG_PY", "是否编译PYTHON的SWIG接口，该接口可用于预测和定制化训练", "自动"
+    "WITH_GOLANG", "是否编译go语言的可容错parameter server", "是"


“是“ -> ON, “否”-> OFF?

wangkuiyi · 2017-11-22T16:53:11Z

@luotao1 I looked into https://github.com/PaddlePaddle/Paddle/pull/5399/files#diff-dfd1b6519ee0558a1c7b124efa2ea816, but I don't understand why would we need to change Markdown table format in that diff into HTML format? What was the reason that prevented out documentation system from displaying Markdown table format?

In general, it's much more difficult to write RST than Markdown. Also, to ease the documentation work, we'd prefer one format instead of two.

luotao1 · 2017-11-23T05:36:08Z

@wangkuiyi The reason is that Sphinx doesn't support markdown table: https://stackoverflow.com/questions/44461762/sphinx-is-not-recognising-my-markdown-tables

luotao1

#5818 (review) CUDA加下 CUDA_ARCH_NAME参数，提醒开发者-DCUDA_ARCH_NAME=Auto可以加速编译吧。

英文文档请 @helinwang 再看一遍？

luotao1 · 2017-11-24T08:05:47Z

doc/getstarted/build_and_install/docker_install_cn.rst


-      docker run -it -v $PWD:/work paddle /work/a.py
+假设您已经在当前目录（比如在/home/work）编写了一个PaddlePaddle的程序 :code:`train.py` （可以参考
+`PaddlePaddleBook <http://www.paddlepaddle.org/docs/develop/book/01.fit_a_line/index.cn.html>`_


格式请调整

luotao1 · 2017-11-24T08:06:24Z

doc/getstarted/build_and_install/docker_install_cn.rst


-   这里`a.py`包含的所有依赖假设都可以在Paddle的运行容器中。如果需要包含更多的依赖、或者需要发布您的应用的镜像，可以编写`Dockerfile`使用`FROM paddledev/paddle:0.10.0`
-   创建和发布自己的AI程序镜像。
+**注：PaddlePaddle Docker镜像为了减小体积，默认没有安装vim，您可以在容器中执行 :code:`apt-get install -y vim` 安装后，在容器中编辑代码。**


格式请调整。

luotao1 · 2017-11-24T08:08:21Z

doc/getstarted/build_and_install/pip_install_cn.rst

+
+..  csv-table:: 各个版本最新的whl包
+    :header: "版本说明", "cp27-cp27mu", "cp27-cp27mu", "C-API"
+    :widths: 1, 3, 3, 3


openblas版本的没有c-api?

luotao1 · 2017-11-24T08:11:00Z

doc/getstarted/index_en.rst

+Quick Install
+----------------------
+
+You can use pip to install PaddlePaddle using a single command, supports


using->with

Thanks for reviewing, comments all done.

luotao1 · 2017-11-24T08:15:24Z

doc/getstarted/index_cn.rst

+
+下载 `房价模型文件 <https://raw.githubusercontent.com/PaddlePaddle/book/develop/01.fit_a_line/fit_a_line.tar>`_
+
+创建一个 housing.py 并粘贴此Python代码 (请确保fit_a_line.tar 是在正确的路径上)


这里不需要fit_a_line.tar的路径了。https://github.com/PaddlePaddle/book/blob/develop/01.fit_a_line/infer.py
最新的代码里面已经将路径封装了paddle.dataset.uci_housing.model()
英文的请做同样的修改。

luotao1 · 2017-11-24T08:18:38Z

doc/getstarted/build_and_install/build_from_source_en.rst

+
+You can pass compile options to use intended BLAS/CUDA/Cudnn libraries.
+When running cmake command, it will search system paths like
+:code:`/usr/lib\:/usr/local/lib` and then search paths that you


多了一个\

luotao1 · 2017-11-24T08:23:20Z

doc/getstarted/build_and_install/pip_install_en.rst

+If you wish to install the latest develop branch PaddlePaddle, 
+you can download the latest whl package from our CI system. Access
+the below links, log in as guest, then click at the "Artifact"
+tab, you'll find the download link of whl packages.


这里需要配图说明一下怎么登录我们的ci系统么？
另外，我看中文文档中没有如何登陆ci系统的介绍，求加上。

luotao1 · 2017-11-24T08:26:08Z

doc/getstarted/build_and_install/pip_install_en.rst

+PaddlePaddle installation packages (whl) does not only contain .py files,
+but also binaries built from C++ code, we ensure that PaddlePaddle can
+run on current mainline Linux distributions, like CentOS 6, Ubuntu 14.04
+and MacOS 10.12.


we前面的逗号改成句号。

luotao1 · 2017-11-24T08:32:28Z

doc/getstarted/build_and_install/docker_install_en.rst


-   Following command will run unit test:
+**NOTE: We did not install vim in the default docker image to reduce the image size, you can run :code:`apt-get install -y vim` to install it if you need to edit python files.**


格式请调整。

luotao1

ci的图过高，是不是裁剪成

就行了呢？

luotao1

LGTM! Excellent Job!!

update installation docs

4691659

typhoonzero requested a review from luotao1 November 22, 2017 05:01

wangkuiyi requested changes Nov 22, 2017

View reviewed changes

luotao1 reviewed Nov 22, 2017

View reviewed changes

qingqing01 reviewed Nov 22, 2017

View reviewed changes

follow comments

2e46c35

fix link

4c28d40

luotao1 reviewed Nov 24, 2017

View reviewed changes

typhoonzero mentioned this pull request Nov 26, 2017

在10.0没有Ubuntu的安装包，怎么安装的 #5914

Closed

typhoonzero added 3 commits November 27, 2017 10:16

follow comments2

669da50

add picture

13ac960

update formats

5331f93

luotao1 reviewed Nov 27, 2017

View reviewed changes

update picture

bd6c905

typhoonzero requested a review from helinwang November 27, 2017 04:51

luotao1 approved these changes Nov 27, 2017

View reviewed changes

wangkuiyi approved these changes Nov 27, 2017

View reviewed changes

luotao1 merged commit 9de8ce1 into PaddlePaddle:develop Nov 27, 2017

typhoonzero deleted the polish_install_docs branch December 22, 2017 05:45


		.. code-block:: bash

		cmake .. -DMKL_ROOT=/opt/mkl/ -DCUDNN_ROOT=/opt/cudnnv5


		.. code-block:: bash
		docker pull paddlepaddle/paddle:latest-gpu


		如果要使用GPU，请运行：
		假设您已经在当前目录编写了一个PaddlePaddle的程序 :code:`train.py`（可以参考


		使用Docker可以快速在本地启动一个包含了PaddlePaddle官方Book教程的Jupiter Notebook，可以通过网页浏览。


		如果需要获取并安装最新的（开发分支）PaddlePaddle，可以从我们的CI系统中下载最新的whl安装包并安装，在下面的链接中，使用guest登陆，然后点击Artifact标签，可以找到最新的whl安装包：

		- `CPU版本 <https://paddleci.ngrok.io/viewLog.html?buildTypeId=Manylinux1_CpuAvxCp27cp27mu&buildId=lastSuccessful>`_


		PaddlePaddle编译需要使用到下面的依赖（包含但不限于），其他的依赖软件，会自动在编译时下载。

		.. csv-table:: PaddlePaddle编译依赖


		下载 `房价模型文件 <https://raw.githubusercontent.com/PaddlePaddle/book/develop/01.fit_a_line/fit_a_line.tar>`_

		创建一个 housing.py 并粘贴此Python代码 (请确保fit_a_line.tar 是在正确的路径上)


		Following command will run unit test:
		NOTE: We did not install vim in the default docker image to reduce the image size, you can run :code:`apt-get install -y vim` to install it if you need to edit python files.

Update installation docs #5818

Update installation docs #5818

Conversation

typhoonzero commented Nov 22, 2017 • edited by qingqing01 Loading

wangkuiyi left a comment

Choose a reason for hiding this comment

typhoonzero commented Nov 22, 2017

luotao1 commented Nov 22, 2017 • edited Loading

luotao1 commented Nov 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luotao1 Nov 22, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

typhoonzero commented Nov 22, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangkuiyi commented Nov 22, 2017 • edited Loading

luotao1 commented Nov 23, 2017

luotao1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luotao1 left a comment

Choose a reason for hiding this comment

luotao1 left a comment

Choose a reason for hiding this comment

typhoonzero commented Nov 22, 2017 •

edited by qingqing01

Loading

luotao1 commented Nov 22, 2017 •

edited

Loading

luotao1 Nov 22, 2017 •

edited

Loading

wangkuiyi commented Nov 22, 2017 •

edited

Loading