Skip to content

Commit 62acf79

Browse files
committed
Merge branch 'develop' of https://github.com/PaddlePaddle/Paddle into momentum_op
2 parents d432b10 + 1b6804f commit 62acf79

File tree

7 files changed

+145
-16
lines changed

7 files changed

+145
-16
lines changed

doc/getstarted/build_and_install/pip_install_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ PaddlePaddle可以使用常用的Python包管理工具
3434
:align: center
3535

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

4040
"cpu_avx_mkl", "`paddlepaddle-0.10.0-cp27-cp27mu-linux_x86_64.whl <http://[email protected]/repository/download/Manylinux1_CpuAvxCp27cp27mu/.lastSuccessful/paddlepaddle-0.10.0-cp27-cp27mu-linux_x86_64.whl>`_", "`paddlepaddle-0.10.0-cp27-cp27m-linux_x86_64.whl <http://[email protected]/repository/download/Manylinux1_CpuAvxCp27cp27mu/.lastSuccessful/paddlepaddle-0.10.0-cp27-cp27m-linux_x86_64.whl>`_", "`paddle.tgz <http://[email protected]/repository/download/Manylinux1_CpuAvxCp27cp27mu/.lastSuccessful/paddle.tgz>`_"
@@ -83,4 +83,4 @@ PaddlePaddle发布的安装包会尽量对齐 `manylinux1 <https://www.python.or
8383
8484
获取当前系统支持的安装包格式,并检查和需安装的包是否匹配。pypi安装包可以在 `这个 <https://pypi.python.org/pypi/paddlepaddle/0.10.5>`_ 链接中找到。
8585

86-
如果系统支持的是 linux_x86_64 而安装包是 manylinux1_x86_64 ,需要升级pip版本到最新; 如果系统支持 manylinux1_x86_64 而安装包(本地)是 linux_x86_64 ,可以重命名这个whl包为 manylinux1_x86_64 再安装。
86+
如果系统支持的是 linux_x86_64 而安装包是 manylinux1_x86_64 ,需要升级pip版本到最新; 如果系统支持 manylinux1_x86_64 而安装包(本地)是 linux_x86_64 ,可以重命名这个whl包为 manylinux1_x86_64 再安装。

doc/getstarted/build_and_install/pip_install_en.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ If the links below shows up the login form, just click "Log in as guest" to star
3737
:align: center
3838

3939
.. csv-table:: whl package of each version
40-
:header: "version", "cp27-cp27mu", "cp27-cp27mu", "C-API"
40+
:header: "version", "cp27-cp27mu", "cp27-cp27m", "C-API"
4141
:widths: 1, 3, 3, 3
4242

4343
"cpu_avx_mkl", "`paddlepaddle-0.10.0-cp27-cp27mu-linux_x86_64.whl <http://[email protected]/repository/download/Manylinux1_CpuAvxCp27cp27mu/.lastSuccessful/paddlepaddle-0.10.0-cp27-cp27mu-linux_x86_64.whl>`_", "`paddlepaddle-0.10.0-cp27-cp27m-linux_x86_64.whl <http://[email protected]/repository/download/Manylinux1_CpuAvxCp27cp27mu/.lastSuccessful/paddlepaddle-0.10.0-cp27-cp27m-linux_x86_64.whl>`_", "`paddle.tgz <http://[email protected]/repository/download/Manylinux1_CpuAvxCp27cp27mu/.lastSuccessful/paddle.tgz>`_"

doc/howto/dev/write_docs_cn.rst

Lines changed: 58 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,64 @@
33
##################
44

55
PaddlePaddle的文档包括英文文档 ``doc`` 和中文文档 ``doc_cn`` 两个部分。文档都是通过 `cmake`_ 驱动 `sphinx`_ 编译生成,生成后的文档分别存储在编译目录的 ``doc`` 和 ``doc_cn`` 两个子目录下。
6-
6+
也可以利用PaddlePaddle 工具来编译文档,这个情况下所有的文件会存在整理过的的文件目录 .ppo_workspace/content 下
77

88
如何构建文档
99
============
1010

11-
PaddlePaddle的文档构建有两种方式。
11+
PaddlePaddle的文档构建有三种方式。
12+
13+
14+
使用PaddlePaddle.org工具
15+
--------------
16+
这个是目前推荐的使用方法。除了可以自动编译文档,也可以直接在网页预览文档。
17+
18+
文件工具是使用Docker,需要在系统里先安装好Docker工具包。Docker安装请参考Docker的官网。安装好Docker之后及可用以下命令启动工具
19+
20+
.. code-block:: bash
21+
22+
mkdir paddlepaddle # Create paddlepaddle working directory
23+
cd paddlepaddle
24+
25+
# Clone the content repositories
26+
git clone https://github.com/PaddlePaddle/Paddle.git
27+
git clone https://github.com/PaddlePaddle/book.git
28+
git clone https://github.com/PaddlePaddle/models.git
29+
git clone https://github.com/PaddlePaddle/Mobile.git
30+
31+
# Please specify the working directory through -v
32+
docker run -it -p 8000:8000 -v `pwd`:/var/content paddlepaddle/paddlepaddle.org:latest
33+
34+
注意: PaddlePaddle.org 会在 -v (volume) 指定的内容存储库运行命令
35+
之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档
36+
编译后的文件将被存储在工作目录 <paddlepaddle working directory>/.ppo_workspace/content。
37+
38+
如果不想使用 Docker,你还可以通过运行Django框架直接激活工具的服务器。使用下面的命令来运行它。
39+
40+
.. code-block:: bash
41+
42+
mkdir paddlepaddle # Create paddlepaddle working directory
43+
cd paddlepaddle
44+
45+
# Clone the content repositories and PaddlePaddle.org
46+
git clone https://github.com/PaddlePaddle/Paddle.git
47+
git clone https://github.com/PaddlePaddle/book.git
48+
git clone https://github.com/PaddlePaddle/models.git
49+
git clone https://github.com/PaddlePaddle/Mobile.git
50+
git clone https://github.com/PaddlePaddle/PaddlePaddle.org.git
51+
52+
# Please specify the PaddlePaddle working directory. In the current setting, it should be pwd
53+
export CONTENT_DIR=<path_to_paddlepaddle_working_directory>
54+
export ENV=''
55+
cd PaddlePaddle.org/portal/
56+
pip install -r requirements.txt
57+
python manage.py runserver
58+
59+
工具服务器将读取环境变量 CONTENT_DIR 搜索代码库。请指定的PaddlePaddle工作目录给环境变量 CONTENT_DIR。
60+
之后再用网页连到http://localhost:8000就可以在网页上生成需要的文档。
61+
编译后的文件将被存储在工作目录 <paddlepaddle working directory>/.ppo_workspace/content。
62+
63+
想了解更多PaddlePaddle.org工具的详细信息,可以 `点击这里 <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.cn.md>`_ 。
1264

1365
使用Docker构建
1466
--------------
@@ -47,17 +99,12 @@ PaddlePaddle的文档构建有两种方式。
4799

48100
PaddlePaddle文档使用 `sphinx`_ 自动生成,用户可以参考sphinx教程进行书写。
49101

50-
如何更新文档主题
51-
================
52-
53-
PaddlePaddle文档主题在 `TO_YOUR_PADDLE_CLONE_PATH/doc_theme` 文件夹下,包含所有和前端网页设计相关的文件。
54-
55-
如何更新doc.paddlepaddle.org
102+
如何更新www.paddlepaddle.org
56103
============================
57104

58-
更新的文档以PR的形式提交到github中,提交方式参见 `贡献文档 <http://doc.paddlepaddle.org/develop/doc_cn/howto/dev/contribute_to_paddle_cn.html>`_ 。
59-
目前PaddlePaddle的develop分支的文档是自动触发更新的,用户可以分别查看最新的 `中文文档 <http://doc.paddlepaddle.org/develop/doc_cn/>`_ 和
60-
`英文文档 <http://doc.paddlepaddle.org/develop/doc/>`_ 。
105+
更新的文档以PR的形式提交到github中,提交方式参见 `贡献文档 <http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html>`_ 。
106+
目前PaddlePaddle的develop分支的文档是自动触发更新的,用户可以分别查看最新的 `中文文档 <http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html>`_ 和
107+
`英文文档 <http://www.paddlepaddle.org/docs/develop/documentation/en/getstarted/index_en.html>`_ 。
61108

62109

63110
.. _cmake: https://cmake.org/

doc/howto/dev/write_docs_en.rst

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
##################
2+
Contribute Documentation
3+
##################
4+
5+
PaddlePaddle supports English documentation ``doc`` and Chinese documentation ``doc_cn``.
6+
Both are compiled by `cmake`_ and `sphinx`_ , the compiled documentations will be stored under ``doc`` and ``doc_cn`` directories.
7+
When using the PaddlePaddle.org to compile documentations, the compiled documentations will be stored under a consolidated directory: .ppo_workspace/content
8+
9+
How to Build Documentations
10+
============
11+
12+
We recommend using PaddlePaddle.org tool to build documentation
13+
14+
15+
Use PaddlePaddle.org tool
16+
--------------
17+
This is the recommended method to build documentation. It can compile documentation and preview the documentation in a web browser.
18+
19+
The tool uses Docker, please install it on your system. Please check Docker official website on how to install Docker. You may use the following commands to activate the tool
20+
21+
.. code-block:: bash
22+
23+
mkdir paddlepaddle # Create paddlepaddle working directory
24+
cd paddlepaddle
25+
26+
# Clone the content repositories. You may only clone the contents you need
27+
git clone https://github.com/PaddlePaddle/Paddle.git
28+
git clone https://github.com/PaddlePaddle/book.git
29+
git clone https://github.com/PaddlePaddle/models.git
30+
git clone https://github.com/PaddlePaddle/Mobile.git
31+
32+
# Please specify the working directory through -v
33+
docker run -it -p 8000:8000 -v `pwd`:/var/content paddlepaddle/paddlepaddle.org:latest
34+
35+
Note: PaddlePaddle.org will read the content repos specified in the -v (volume) flag of the docker run command
36+
Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation
37+
The compiled documentations will be stored in <paddlepaddle working directory>/.ppo_workspace/content
38+
39+
40+
If you don't wish to use Docker, you can also activate the tool through Django. Use the following the commands to set up
41+
42+
.. code-block:: bash
43+
44+
mkdir paddlepaddle # Create paddlepaddle working directory
45+
cd paddlepaddle
46+
47+
# Clone the content repositories and PaddlePaddle.org
48+
git clone https://github.com/PaddlePaddle/Paddle.git
49+
git clone https://github.com/PaddlePaddle/book.git
50+
git clone https://github.com/PaddlePaddle/models.git
51+
git clone https://github.com/PaddlePaddle/Mobile.git
52+
git clone https://github.com/PaddlePaddle/PaddlePaddle.org.git
53+
54+
# Please specify the PaddlePaddle working directory. In the current setting, it should be pwd
55+
export CONTENT_DIR=<path_to_paddlepaddle_working_directory>
56+
export ENV=''
57+
cd PaddlePaddle.org/portal/
58+
pip install -r requirements.txt
59+
python manage.py runserver
60+
61+
Use a web browser and navigate to http://localhost:8000, click the buttons to compile the documentation
62+
The compiled documentations will be stored in <paddlepaddle working directory>/.ppo_workspace/content
63+
64+
If you want to learn more on the PaddlePaddle.org, please `click here <https://github.com/PaddlePaddle/PaddlePaddle.org/blob/develop/README.md>`_ 。
65+
66+
How to write Documentations
67+
============
68+
69+
PaddlePaddle uses `sphinx`_ to compile documentations,Please check sphinx official website for more detail.
70+
71+
72+
How to update www.paddlepaddle.org
73+
============================
74+
75+
Please create PRs and submit them to github, please check `Contribute Code <http://www.paddlepaddle.org/docs/develop/documentation/en/howto/dev/contribute_to_paddle_en.html>`_ 。
76+
PaddlePaddle develop branch will update the documentation once the PR is merged. User may check latest `Chinese Docs <http://www.paddlepaddle.org/docs/develop/documentation/zh/getstarted/index_cn.html>`_ and
77+
`English Docs <http://www.paddlepaddle.org/docs/develop/documentation/en/getstarted/index_en.html>`_ 。
78+
79+
.. _cmake: https://cmake.org/
80+
.. _sphinx: http://www.sphinx-doc.org/en/1.4.8/

doc/howto/index_cn.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
.. toctree::
2020
:maxdepth: 1
2121

22+
dev/contribute_to_paddle_cn.md
2223
dev/write_docs_cn.rst
2324

2425
模型配置

doc/howto/index_en.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Development
2020

2121
dev/new_layer_en.rst
2222
dev/contribute_to_paddle_en.md
23+
dev/write_docs_en.rst
2324

2425
Configuration
2526
-------------

paddle/platform/gpu_info.cc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ limitations under the License. */
1818

1919
#include "paddle/platform/enforce.h"
2020

21-
DEFINE_double(fraction_of_gpu_memory_to_use, 0.95,
22-
"Default use 95% of GPU memory for PaddlePaddle,"
21+
DEFINE_double(fraction_of_gpu_memory_to_use, 0.92,
22+
"Default use 92% of GPU memory for PaddlePaddle,"
2323
"reserve the rest for page tables, etc");
2424

2525
namespace paddle {

0 commit comments

Comments
 (0)