Skip to content

Commit 5848288

Browse files
committed
Integrate doc en/cn into single doc
1 parent 0fd44c6 commit 5848288

File tree

110 files changed

+1030
-1848
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+1030
-1848
lines changed

CMakeLists.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ find_package(Protobuf REQUIRED)
1111

1212
# Check protobuf library version.
1313
execute_process(COMMAND ${PROTOBUF_PROTOC_EXECUTABLE} --version
14-
OUTPUT_VARIABLE PROTOBUF_VERSION)
14+
OUTPUT_VARIABLE PROTOBUF_VERSION)
1515
string(REPLACE "libprotoc " "" PROTOBUF_VERSION ${PROTOBUF_VERSION})
1616

1717
set(PROTOBUF_3 OFF)
@@ -169,5 +169,4 @@ add_subdirectory(paddle)
169169
add_subdirectory(python)
170170
if(WITH_DOC)
171171
add_subdirectory(doc)
172-
add_subdirectory(doc_cn)
173172
endif()

doc/CMakeLists.txt

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,50 @@ if(NOT DEFINED SPHINX_THEME_DIR)
77
endif()
88

99
# configured documentation tools and intermediate build results
10-
set(BINARY_BUILD_DIR "${CMAKE_CURRENT_BINARY_DIR}/_build")
10+
set(BINARY_BUILD_DIR_EN "${CMAKE_CURRENT_BINARY_DIR}/en/_build")
1111

1212
# Sphinx cache with pickled ReST documents
13-
set(SPHINX_CACHE_DIR "${CMAKE_CURRENT_BINARY_DIR}/_doctrees")
13+
set(SPHINX_CACHE_DIR_EN "${CMAKE_CURRENT_BINARY_DIR}/en/_doctrees")
1414

15-
# HTML output directory
16-
set(SPHINX_HTML_DIR "${CMAKE_CURRENT_BINARY_DIR}/html")
15+
# HTML output director
16+
set(SPHINX_HTML_DIR_EN "${CMAKE_CURRENT_BINARY_DIR}/en/html")
1717

1818
configure_file(
19-
"${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in"
20-
"${BINARY_BUILD_DIR}/conf.py"
19+
"${CMAKE_CURRENT_SOURCE_DIR}/conf.py.en.in"
20+
"${BINARY_BUILD_DIR_EN}/conf.py"
2121
@ONLY)
2222

2323
sphinx_add_target(paddle_docs
2424
html
25-
${BINARY_BUILD_DIR}
26-
${SPHINX_CACHE_DIR}
25+
${BINARY_BUILD_DIR_EN}
26+
${SPHINX_CACHE_DIR_EN}
2727
${CMAKE_CURRENT_SOURCE_DIR}
28-
${SPHINX_HTML_DIR})
28+
${SPHINX_HTML_DIR_EN})
2929

3030
add_dependencies(paddle_docs
3131
gen_proto_py)
32+
33+
34+
# configured documentation tools and intermediate build results
35+
set(BINARY_BUILD_DIR_CN "${CMAKE_CURRENT_BINARY_DIR}/cn/_build")
36+
37+
# Sphinx cache with pickled ReST documents
38+
set(SPHINX_CACHE_DIR_CN "${CMAKE_CURRENT_BINARY_DIR}/cn/_doctrees")
39+
40+
# HTML output directory
41+
set(SPHINX_HTML_DIR_CN "${CMAKE_CURRENT_BINARY_DIR}/cn/html")
42+
43+
configure_file(
44+
"${CMAKE_CURRENT_SOURCE_DIR}/conf.py.cn.in"
45+
"${BINARY_BUILD_DIR_CN}/conf.py"
46+
@ONLY)
47+
48+
sphinx_add_target(paddle_docs_cn
49+
html
50+
${BINARY_BUILD_DIR_CN}
51+
${SPHINX_CACHE_DIR_CN}
52+
${CMAKE_CURRENT_SOURCE_DIR}
53+
${SPHINX_HTML_DIR_CN})
54+
55+
add_dependencies(paddle_docs_cn
56+
gen_proto_py)
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
DataProvider的介绍
22
==================
33

4-
DataProvider是PaddlePaddle负责提供数据的模块。其作用是将数据传入内存或显存,让神经网络可以进行训练或预测。用户可以通过简单使用Python接口 `PyDataProvider2 <pydataprovider2.html>`_ ,来自定义传数据的过程。如果有更复杂的使用,或者需要更高的效率,用户也可以在C++端自定义一个 ``DataProvider`` 。
4+
DataProvider是PaddlePaddle负责提供数据的模块。其作用是将数据传入内存或显存,让神经网络可以进行训练或预测。用户可以通过简单使用Python接口 `PyDataProvider2 <pydataprovider2.html>`_ ,来自定义传数据的过程。如果有更复杂的使用,或者需要更高的效率,用户也可以在C++端自定义一个 ``DataProvider`` 。
55

66
PaddlePaddle需要用户在网络配置(trainer_config.py)中定义使用哪种DataProvider,并且在DataProvider中实现如何访问训练文件列表(train.list)或测试文件列表(test.list)。
77

8-
- train.list和test.list存放在本地(推荐直接存放到训练目录,以相对路径引用)。一般情况下,两者均为纯文本文件,其中每一行对应一个数据文件地址:
9-
10-
- 如果数据文件存于本地磁盘,这个地址则为它的绝对路径或相对路径(相对于PaddlePaddle程序运行时的路径)。
11-
- 地址也可以为hdfs文件路径,或者数据库连接路径等。
12-
- 由于这个地址会被DataProvider使用,因此,如何解析该地址也是用户自定义DataProvider时需要考虑的地方。
8+
- train.list和test.list存放在本地(推荐直接存放到训练目录,以相对路径引用)。一般情况下,两者均为纯文本文件,其中每一行对应一个数据文件地址:
9+
10+
- 如果数据文件存于本地磁盘,这个地址则为它的绝对路径或相对路径(相对于PaddlePaddle程序运行时的路径)。
11+
- 地址也可以为hdfs文件路径,或者数据库连接路径等。
12+
- 由于这个地址会被DataProvider使用,因此,如何解析该地址也是用户自定义DataProvider时需要考虑的地方。
1313
- 如果没有设置test.list,或设置为None,那么在训练过程中不会执行测试操作;否则,会根据命令行参数指定的测试方式,在训练过程中进行测试,从而防止过拟合。

0 commit comments

Comments
 (0)