Skip to content

Commit 60acca7

Browse files
authored
Update0323 (#718)
* fix layers. ==> fluid.layers. (#688) * fix data_reader_cn and dataset_cn (#685) * fix textual content * fix issue #682 3 3.2 * fix issues in conv * Fix io_cn (#597) * routine bug fix * update text info * fix io_cn all * 持久性变量=>长期变量 * 1220 improve cnapi (#509) * 1220 update cnapi * Apply suggestions from code review Co-Authored-By: haowang101779990 <[email protected]> * refine reader doc (#686) * update VisualDL README to add more details (#694) * improve save_load_variables cn (#689) * improve save_load_variables * Update save_load_variables.rst * fix typo of models (#698) * fix typo of models * fix en * Fix arguments according to 1.3 en + ceil,floor 翻译 +operator 翻译 (#695) * Fix arguments according to 1.3 en + ceil,floor trans +operator trans * fix LoDTensorArray spell * update_reading_data (#699) * add api_guides low_level backward parameter program_en (#696) * add api_guides low_level backward parameter program_en * Apply suggestions from code review Co-Authored-By: zy0531 <[email protected]> * Apply suggestions from code review Co-Authored-By: zy0531 <[email protected]> * Update backward_en.rst * Update parameter_en.rst * Update program_en.rst * Update doc/fluid/api_guides/low_level/program_en.rst
1 parent 6cd92b0 commit 60acca7

File tree

24 files changed

+635
-280
lines changed

24 files changed

+635
-280
lines changed

doc/fluid/api_cn/data/data_reader_cn.rst

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ DataFeeder
1111
.. py:class:: paddle.fluid.data_feeder.DataFeeder(feed_list, place, program=None)
1212
1313
14-
DataFeeder将读卡器返回的数据转换为可以输入Executor和ParallelExecutor的数据结构。读卡器通常返回一个小批量数据条目列表。列表中的每个数据条目都是一个样本。每个样本都是具有一个或多个特征的列表或元组。
14+
DataFeeder将reader返回的数据转换为可以输入Executor和ParallelExecutor的数据结构。reader通常返回一个小批量数据条目列表。列表中的每个数据条目都是一个样本。每个样本都是具有一个或多个特征的列表或元组。
1515

1616
简单用法如下:
1717

@@ -42,7 +42,7 @@ DataFeeder将读卡器返回的数据转换为可以输入Executor和ParallelExe
4242
参数:
4343
- **feed_list** (list) – 将输入模型的变量或变量的名称。
4444
- **place** (Place) – place表示将数据输入CPU或GPU,如果要将数据输入GPU,请使用fluid.CUDAPlace(i)(i表示GPU的ID),如果要将数据输入CPU,请使用fluid.CPUPlace()。
45-
- **program** (Program) –将数据输入的Program,如果Program为None,它将使用default_main_program() 。默认值None.
45+
- **program** (Program) –将数据输入的Program,如果Program为None,它将使用default_main_program() 。默认值None
4646

4747
抛出异常: ``ValueError`` – 如果某些变量未在Program中出现
4848

@@ -81,7 +81,7 @@ DataFeeder将读卡器返回的数据转换为可以输入Executor和ParallelExe
8181
需要多个mini-batches。每个mini-batch都将提前在每个设备上输入。
8282

8383
参数:
84-
- **iterable** (list|tuple) – 输入的数据
84+
- **iterable** (list|tuple) – 输入的数据
8585
- **num_places** (int) – 设备编号,默认值为None。
8686

8787
返回: 转换结果
@@ -96,19 +96,19 @@ DataFeeder将读卡器返回的数据转换为可以输入Executor和ParallelExe
9696

9797
.. py:method:: decorate_reader(reader, multi_devices, num_places=None, drop_last=True)
9898
99-
将输入数据转换成读卡器返回的多个mini-batches。每个mini-batch
99+
将输入数据转换成reader返回的多个mini-batches。每个mini-batch分别送入各设备中。
100100

101101
参数:
102-
- **reader** (function) – reader是可以生成数据的函数
103-
- **multi_devices** (bool) – 是否用多个设备
102+
- **reader** (function) – reader是可以生成数据的函数
103+
- **multi_devices** (bool) – 是否用多个设备
104104
- **num_places** (int) – 如果multi_devices是True, 你可以指定GPU的使用数量, 如果multi_devices是None, 会使用当前机器的所有GPU ,默认值None。
105-
- **drop_last** (bool) – 如果最后一个batch的大小小于batch_size,是否删除最后一个batch,默认值True。
105+
- **drop_last** (bool) – 如果最后一个batch的大小小于batch_size,选择是否删除最后一个batch,默认值True。
106106

107107
返回: 转换结果
108108

109109
返回类型: dict
110110

111-
引起异常: ValueError – 如果drop_last为False并且数据批不适合设备
111+
抛出异常``ValueError``如果drop_last为False并且数据batch和设备数目不匹配
112112

113113

114114
.. _cn_api_paddle_data_reader_reader:
@@ -120,14 +120,14 @@ Reader
120120

121121
- reader是一个读取数据(从文件、网络、随机数生成器等)并生成数据项的函数。
122122
- reader creator是返回reader函数的函数。
123-
- reader decorator是一个函数,它接受一个或多个读卡器,并返回一个读卡器
124-
- batch reader是一个函数,它读取数据(从读卡器、文件、网络、随机数生成器等)并生成一批数据项。
123+
- reader decorator是一个函数,它接受一个或多个reader,并返回一个reader
124+
- batch reader是一个函数,它读取数据(从reader、文件、网络、随机数生成器等)并生成一批数据项。
125125

126126

127127
Data Reader Interface
128128
------------------------------------
129129

130-
的确,数据阅读器不必是读取和生成数据项的函数,它可以是任何不带参数的函数来创建一个iterable(任何东西都可以被用于 ``for x in iterable`` ):
130+
的确,data reader不必是读取和生成数据项的函数,它可以是任何不带参数的函数来创建一个iterable(任何东西都可以被用于 ``for x in iterable`` ):
131131

132132
.. code-block:: python
133133
@@ -163,7 +163,7 @@ Data Reader Interface
163163

164164
参数:
165165
- **func** - 使用的函数. 函数类型应为(Sample) => Sample
166-
- **readers** - 其输出将用作func参数的读卡器
166+
- **readers** - 其输出将用作func参数的reader
167167

168168
类型:callable
169169

@@ -176,7 +176,7 @@ Data Reader Interface
176176
177177
创建缓冲数据读取器。
178178

179-
缓冲数据读卡器将读取数据条目并将其保存到缓冲区中。只要缓冲区不为空,就将继续从缓冲数据读取器读取数据。
179+
缓冲数据reader将读取数据条目并将其保存到缓冲区中。只要缓冲区不为空,就将继续从缓冲数据读取器读取数据。
180180

181181
参数:
182182
- **reader** (callable) - 要读取的数据读取器
@@ -188,28 +188,28 @@ Data Reader Interface
188188

189189
.. py:function:: paddle.reader.compose(*readers, **kwargs)
190190
191-
创建一个数据读卡器,其输出是输入读卡器的组合
191+
创建一个数据reader,其输出是输入reader的组合
192192

193-
如果输入读卡器输出以下数据项:(1,2)3(4,5),则组合读卡器将输出:(1,2,3,4,5)
193+
如果输入reader输出以下数据项:(1,2)3(4,5),则组合reader将输出:(1,2,3,4,5)
194194

195195
参数:
196-
- **readers** - 将被组合的多个读取器
197-
- **check_alignment** (bool) - 如果为True,将检查输入读卡器是否正确对齐。如果为False,将不检查对齐,将丢弃跟踪输出。默认值True。
196+
- **readers** - 将被组合的多个读取器
197+
- **check_alignment** (bool) - 如果为True,将检查输入reader是否正确对齐。如果为False,将不检查对齐,将丢弃跟踪输出。默认值True。
198198

199199
返回:新的数据读取器
200200

201-
引起异常: ``ComposeNotAligned`` – 读卡器的输出不一致。 当check_alignment设置为False,不会升高。
201+
抛出异常: ``ComposeNotAligned`` – reader的输出不一致。 当check_alignment设置为False,不会升高。
202202

203203

204204

205205
.. py:function:: paddle.reader.chain(*readers)
206206
207-
创建一个数据读卡器,其输出是链接在一起的输入数据读卡器的输出
207+
创建一个数据reader,其输出是链接在一起的输入数据reader的输出
208208

209-
如果输入读卡器输出以下数据条目:[0,0,0][1,1,1][2,2,2],链接读卡器将输出:[0,0,0,1,1,1,2,2,2]
209+
如果输入reader输出以下数据条目:[0,0,0][1,1,1][2,2,2],链接reader将输出:[0,0,0,1,1,1,2,2,2]
210210

211211
参数:
212-
- **readers** – 输入的数据
212+
- **readers** – 输入的数据
213213

214214
返回: 新的数据读取器
215215

@@ -218,29 +218,29 @@ Data Reader Interface
218218

219219
.. py:function:: paddle.reader.shuffle(reader, buf_size)
220220
221-
创建数据读取器,该阅读器的数据输出将被无序排列
221+
创建数据读取器,该reader的数据输出将被无序排列
222222

223-
由原始读卡器创建的迭代器的输出将被缓冲到shuffle缓冲区,然后进行打乱。打乱缓冲区的大小由参数buf_size决定。
223+
由原始reader创建的迭代器的输出将被缓冲到shuffle缓冲区,然后进行打乱。打乱缓冲区的大小由参数buf_size决定。
224224

225225
参数:
226-
- **reader** (callable) – 输出会被打乱的原始读卡器
226+
- **reader** (callable) – 输出会被打乱的原始reader
227227
- **buf_size** (int) – 打乱缓冲器的大小
228228

229-
返回: 输出会被打乱的读卡器
229+
返回: 输出会被打乱的reader
230230

231231
返回类型: callable
232232

233233

234234

235235
.. py:function:: paddle.reader.firstn(reader, n)
236236
237-
限制读卡器可以返回的最大样本数
237+
限制reader可以返回的最大样本数
238238

239239
参数:
240-
- **reader** (callable) – 要读取的数据读取器
241-
- **n** (int) – 返回的最大样本数
240+
- **reader** (callable) – 要读取的数据读取器
241+
- **n** (int) – 返回的最大样本数
242242

243-
返回: 装饰读卡器
243+
返回: 装饰reader
244244

245245
返回类型: callable
246246

@@ -294,11 +294,11 @@ rtype: string
294294

295295
.. py:function:: paddle.reader.multiprocess_reader(readers, use_pipe=True, queue_size=1000)
296296
297-
多进程读卡器使用python多进程从读卡器中读取数据,然后使用multi process.queue或multi process.pipe合并所有数据。进程号等于输入读卡器的编号,每个进程调用一个读卡器
297+
多进程reader使用python多进程从reader中读取数据,然后使用multi process.queue或multi process.pipe合并所有数据。进程号等于输入reader的编号,每个进程调用一个reader
298298

299299
multiprocess.queue需要/dev/shm的rw访问权限,某些平台不支持。
300300

301-
您需要首先创建多个读卡器,这些读卡器应该相互独立,这样每个进程都可以独立工作。
301+
您需要首先创建多个reader,这些reader应该相互独立,这样每个进程都可以独立工作。
302302

303303
**代码示例**
304304

@@ -314,11 +314,11 @@ multiprocess.queue需要/dev/shm的rw访问权限,某些平台不支持。
314314
315315
.. py:class::paddle.reader.Fake
316316
317-
Fake读卡器将缓存它读取的第一个数据,并将其输出data_num次。它用于缓存来自真实阅读器的数据,并将其用于速度测试。
317+
Fakereader将缓存它读取的第一个数据,并将其输出data_num次。它用于缓存来自真实reader的数据,并将其用于速度测试。
318318

319319
参数:
320-
- **reader** – 原始读取器
321-
- **data_num** – 读卡器产生数据的次数
320+
- **reader** – 原始读取器
321+
- **data_num** – reader产生数据的次数 。
322322

323323
返回: 一个Fake读取器
324324

@@ -343,7 +343,7 @@ Creator包包含一些简单的reader creator,可以在用户Program中使用
343343
如果是numpy向量,则创建一个生成x个元素的读取器。或者,如果它是一个numpy矩阵,创建一个生成x行元素的读取器。或由最高维度索引的任何子超平面。
344344

345345
参数:
346-
- **x** – 用于创建读卡器的numpy数组
346+
- **x** – 用于创建reader的numpy数组。
347347

348348
返回: 从x创建的数据读取器
349349

@@ -359,8 +359,8 @@ Creator包包含一些简单的reader creator,可以在用户Program中使用
359359

360360
.. py:function:: paddle.reader.creator.recordio(paths, buf_size=100)
361361
362-
从给定的recordio文件路径创建数据读卡器,用“,”分隔“,支持全局模式。
362+
从给定的recordio文件路径创建数据reader,用“,”分隔“,支持全局模式。
363363

364364
路径:recordio文件的路径,可以是字符串或字符串列表。
365365

366-
返回: recordio文件的数据读取器
366+
返回: recordio文件的数据读取器

doc/fluid/api_cn/data/dataset_cn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ imdb
153153

154154
IMDB数据集。
155155

156-
本模块的数据集从 http://ai.stanford.edu/%7Eamaas/data/sentiment/IMDB 数据集。这个数据集包含了一组25000个用于训练的极性电影评论数据和25000个用于测试的评论数据。此外,该模块还提供了用于构建词典的API。
156+
本模块的数据集从 http://ai.stanford.edu/%7Eamaas/data/sentiment/IMDB 数据集。这个数据集包含了25000条训练用电影评论数据,25000条测试用评论数据,且这些评论带有明显情感倾向。此外,该模块还提供了用于构建词典的API。
157157

158158

159159
.. py:function:: paddle.dataset.imdb.build_dict(pattern, cutoff)

doc/fluid/api_cn/executor_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ feed map为该program提供输入数据。fetch_list提供program训练结束后
144144
global_scope
145145
-------------------------------
146146

147-
.. py:function:: paddle.fluid.global_scope ()
147+
.. py:function:: paddle.fluid.executor.global_scope ()
148148
149149
150150
获取全局/默认作用域实例。很多api使用默认 ``global_scope`` ,例如 ``Executor.run`` 。
@@ -163,7 +163,7 @@ global_scope
163163
scope_guard
164164
-------------------------------
165165

166-
.. py:function:: paddle.fluid.scope_guard (scope)
166+
.. py:function:: paddle.fluid.executor.scope_guard (scope)
167167
168168
169169
修改全局/默认作用域(scope), 运行时中的所有变量都将分配给新的scope。

doc/fluid/api_cn/fluid_cn.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,9 @@ BuildStrategy
162162
163163
str类型。它表明了以graphviz格式向文件中写入SSA图的路径,有利于调试。 默认值为""
164164
165+
.. py:attribute:: enable_sequential_execution
165166
167+
类型是BOOL。 如果设置为True,则ops的执行顺序将与program中的执行顺序相同。 默认为False
166168
167169
168170
.. py:attribute:: fuse_elewise_add_act_ops
@@ -1015,10 +1017,10 @@ feed map为该program提供输入数据。fetch_list提供program训练结束后
10151017
.. code-block:: python
10161018
10171019
1018-
data = layers.data(name='X', shape=[1], dtype='float32')
1019-
hidden = layers.fc(input=data, size=10)
1020+
data = fluid.layers.data(name='X', shape=[1], dtype='float32')
1021+
hidden = fluid.layers.fc(input=data, size=10)
10201022
layers.assign(hidden, out)
1021-
loss = layers.mean(out)
1023+
loss = fluid.layers.mean(out)
10221024
adam = fluid.optimizer.Adam()
10231025
adam.minimize(loss)
10241026
@@ -1183,7 +1185,7 @@ LoDTensorArray
11831185
11841186
.. py:method:: append(self: paddle.fluid.core.LoDTensorArray, tensor: paddle.fluid.core.LoDTensor) → None
11851187
1186-
将LoDensor追加到LoDTensorArray后
1188+
将LoDTensor追加到LoDTensorArray后
11871189
11881190
11891191

doc/fluid/api_cn/initializer_cn.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ force_init_on_cpu
116116
init_on_cpu
117117
-------------------------------
118118

119-
.. py:function:: paddle.fluid.initializer.init_on_cpu(*args, **kwds)
119+
.. py:function:: paddle.fluid.initializer.init_on_cpu()
120120
121121
强制变量在 cpu 上初始化。
122122

@@ -125,7 +125,7 @@ init_on_cpu
125125
.. code-block:: python
126126
127127
with init_on_cpu():
128-
step = layers.create_global_var()
128+
step = fluid.layers.create_global_var()
129129
130130
131131

0 commit comments

Comments
 (0)