@@ -99,14 +99,18 @@ train_batch(inputs, labels=None)
9999
100100在一个批次的数据上进行训练。
101101
102- 参数:
102+ **参数 **
103+
103104 - **inputs ** (list) - 1维列表,每个元素都是一批次的输入数据,数据类型为 ``numpy.ndarray ``。
104105 - **labels ** (list) - 1维列表,每个元素都是一批次的输入标签,数据类型为 ``numpy.ndarray `` 。默认值:None。
105106
106- 返回:如果没有定义评估函数,则返回包含了训练损失函数的值的列表;如果定义了评估函数,则返回一个元组(损失函数的列表,评估指标的列表)。
107+ **返回 **
108+
109+ 如果没有定义评估函数,则返回包含了训练损失函数的值的列表;如果定义了评估函数,则返回一个元组(损失函数的列表,评估指标的列表)。
107110
108111
109- **代码示例 **:
112+ **代码示例 **
113+
110114
111115.. code-block :: python
112116
@@ -138,15 +142,18 @@ eval_batch(inputs, labels=None)
138142
139143在一个批次的数据上进行评估。
140144
141- 参数:
145+ **参数 **
146+
147+
142148 - **inputs ** (list) - 1维列表,每个元素都是一批次的输入数据,数据类型为 ``numpy.ndarray `` 。
143149 - **labels ** (list) - 1维列表,每个元素都是一批次的输入标签,数据类型为 ``numpy.ndarray `` 。默认值:None。
144150
145- 返回:如果没有定义评估函数,则返回包含了预测损失函数的值的列表;如果定义了评估函数,则返回一个元组(损失函数的列表,评估指标的列表)。
151+ **返回 **
152+
153+ list,如果没有定义评估函数,则返回包含了预测损失函数的值的列表;如果定义了评估函数,则返回一个元组(损失函数的列表,评估指标的列表)。
146154
147- 返回类型:list
148155
149- **代码示例 **:
156+ **代码示例 **
150157
151158.. code-block :: python
152159
@@ -179,14 +186,17 @@ predict_batch(inputs)
179186
180187在一个批次的数据上进行测试。
181188
182- 参数:
189+ **参数 **
190+
191+
183192 - **inputs ** (list) - 1维列表,每个元素都是一批次的输入数据,数据类型为 ``numpy.ndarray `` 。
184193
185- 返回:一个列表,包含了模型的输出。
194+ **返回 **
195+
196+ 一个列表,包含了模型的输出。
186197
187- 返回类型:list
198+ ** 代码示例 **
188199
189- **代码示例 **:
190200
191201.. code-block :: python
192202
@@ -219,13 +229,17 @@ save(path, training=True)
219229将模型的参数和训练过程中优化器的信息保存到指定的路径,以及推理所需的参数与文件。如果training=True,所有的模型参数都会保存到一个后缀为 ``.pdparams `` 的文件中。
220230所有的优化器信息和相关参数,比如 ``Adam `` 优化器中的 ``beta1 `` , ``beta2 `` ,``momentum `` 等,都会被保存到后缀为 ``.pdopt ``。如果优化器比如SGD没有参数,则该不会产生该文件。如果training=False,则不会保存上述说的文件。只会保存推理需要的参数文件和模型文件。
221231
222- 参数:
232+ **参数 **
233+
234+
223235 - **path ** (str) - 保存的文件名前缀。格式如 ``dirname/file_prefix `` 或者 ``file_prefix `` 。
224236 - **training ** (bool,可选) - 是否保存训练的状态,包括模型参数和优化器参数等。如果为False,则只保存推理所需的参数与文件。默认值:True。
225237
226- 返回:None
238+ **返回 **
239+
240+ None
227241
228- **代码示例 **:
242+ **代码示例 **
229243
230244.. code-block :: python
231245
@@ -275,14 +289,19 @@ load(path, skip_mismatch=False, reset_optimizer=False)
275289
276290从指定的文件中载入模型参数和优化器参数,如果不想恢复优化器参数信息,优化器信息文件可以不存在。需要注意的是:参数名称的检索是根据保存模型时结构化的名字,当想要载入参数进行迁移学习时要保证预训练模型和当前的模型的参数有一样结构化的名字。
277291
278- 参数:
292+ **参数 **
293+
294+
279295 - **path ** (str) - 保存参数或优化器信息的文件前缀。格式如 ``path.pdparams `` 或者 ``path.pdopt `` ,后者是非必要的,如果不想恢复优化器信息。
280296 - **skip_mismatch ** (bool) - 是否需要跳过保存的模型文件中形状或名称不匹配的参数,设置为 ``False `` 时,当遇到不匹配的参数会抛出一个错误。默认值:False。
281297 - **reset_optimizer ** (bool) - 设置为 ``True `` 时,会忽略提供的优化器信息文件。否则会载入提供的优化器信息。默认值:False。
282298
283- 返回:None
299+ **返回 **
300+
301+ None
302+
303+ **代码示例 **
284304
285- **代码示例 **:
286305
287306.. code-block :: python
288307
@@ -309,9 +328,11 @@ parameters(*args, **kwargs)
309328
310329返回一个包含模型所有参数的列表。
311330
312- 返回:在静态图中返回一个包含 ``Parameter `` 的列表,在动态图中返回一个包含 ``ParamBase `` 的列表。
331+ **返回 **
332+
333+ 在静态图中返回一个包含 ``Parameter `` 的列表,在动态图中返回一个包含 ``ParamBase `` 的列表。
313334
314- **代码示例 **:
335+ **代码示例 **
315336
316337.. code-block :: python
317338
@@ -332,7 +353,8 @@ prepare(optimizer=None, loss=None, metrics=None, amp_configs=None)
332353
333354配置模型所需的部件,比如优化器、损失函数和评价指标。
334355
335- 参数:
356+ **参数 **
357+
336358 - **optimizer ** (Optimizer) - 当训练模型的,该参数必须被设定。当评估或测试的时候,该参数可以不设定。默认值:None。
337359 - **loss ** (Loss) - 当训练模型的,该参数必须被设定。默认值:None。
338360 - **metrics ** (Metric|list[Metric]) - 当该参数被设定时,所有给定的评估方法会在训练和测试时被运行,并返回对应的指标。默认值:None。
@@ -344,7 +366,8 @@ fit(train_data=None, eval_data=None, batch_size=1, epochs=1, eval_freq=1, log_fr
344366
345367训练模型。当 ``eval_data `` 给定时,会在 ``eval_freq `` 个 ``epoch `` 后进行一次评估。
346368
347- 参数:
369+ **参数 **
370+
348371 - **train_data ** (Dataset|DataLoader) - 一个可迭代的数据源,推荐给定一个 ``paddle paddle.io.Dataset `` 或 ``paddle.io.Dataloader `` 的实例。默认值:None。
349372 - **eval_data ** (Dataset|DataLoader) - 一个可迭代的数据源,推荐给定一个 ``paddle paddle.io.Dataset `` 或 ``paddle.io.Dataloader `` 的实例。当给定时,会在每个 ``epoch `` 后都会进行评估。默认值:None。
350373 - **batch_size ** (int) - 训练数据或评估数据的批大小,当 ``train_data `` 或 ``eval_data `` 为 ``DataLoader `` 的实例时,该参数会被忽略。默认值:1。
@@ -359,9 +382,11 @@ fit(train_data=None, eval_data=None, batch_size=1, epochs=1, eval_freq=1, log_fr
359382 - **num_workers ** (int) - 启动子进程用于读取数据的数量。当 ``train_data `` 和 ``eval_data `` 都为 ``DataLoader `` 的实例时,该参数会被忽略。默认值:0。
360383 - **callbacks ** (Callback|list[Callback]|None) - ``Callback `` 的一个实例或实例列表。该参数不给定时,默认会插入 ``ProgBarLogger `` 和 ``ModelCheckpoint `` 这两个实例。默认值:None。
361384
362- 返回:None
385+ **返回 **
386+
387+ None
363388
364- **代码示例 **:
389+ **代码示例 **
365390
366391 1. 使用Dataset训练,并设置batch_size的例子。
367392
@@ -447,17 +472,20 @@ evaluate(eval_data, batch_size=1, log_freq=10, verbose=2, num_workers=0, callbac
447472
448473在输入数据上,评估模型的损失函数值和评估指标。
449474
450- 参数:
475+ **参数 **
476+
451477 - **eval_data ** (Dataset|DataLoader) - 一个可迭代的数据源,推荐给定一个 ``paddle paddle.io.Dataset `` 或 ``paddle.io.Dataloader `` 的实例。默认值:None。
452478 - **batch_size ** (int) - 训练数据或评估数据的批大小,当 ``eval_data `` 为 ``DataLoader `` 的实例时,该参数会被忽略。默认值:1。
453479 - **log_freq ** (int) - 日志打印的频率,多少个 ``step `` 打印一次日志。默认值:1。
454480 - **verbose ** (int) - 可视化的模型,必须为0,1,2。当设定为0时,不打印日志,设定为1时,使用进度条的方式打印日志,设定为2时,一行一行地打印日志。默认值:2。
455481 - **num_workers ** (int) - 启动子进程用于读取数据的数量。当 ``eval_data `` 为 ``DataLoader `` 的实例时,该参数会被忽略。默认值:True。
456482 - **callbacks ** (Callback|list[Callback]|None) - ``Callback `` 的一个实例或实例列表。该参数不给定时,默认会插入 ``ProgBarLogger `` 和 ``ModelCheckpoint `` 这两个实例。默认值:None。
457483
458- 返回:dict, key是 ``prepare `` 时Metric的的名称,value是该Metric的值。
484+ **返回 **
485+
486+ dict, key是 ``prepare `` 时Metric的的名称,value是该Metric的值。
459487
460- **代码示例 **:
488+ **代码示例 **
461489
462490.. code-block :: python
463491
@@ -484,16 +512,19 @@ predict(test_data, batch_size=1, num_workers=0, stack_outputs=False, callbacks=N
484512
485513在输入数据上,预测模型的输出。
486514
487- 参数:
515+ **参数 **
516+
488517 - **test_data ** (Dataset|DataLoader) - 一个可迭代的数据源,推荐给定一个 ``paddle paddle.io.Dataset `` 或 ``paddle.io.Dataloader `` 的实例。默认值:None。
489518 - **batch_size ** (int) - 训练数据或评估数据的批大小,当 ``eval_data `` 为 ``DataLoader `` 的实例时,该参数会被忽略。默认值:1。
490519 - **num_workers ** (int) - 启动子进程用于读取数据的数量。当 ``eval_data `` 为 ``DataLoader `` 的实例时,该参数会被忽略。默认值:True。
491520 - **stack_outputs ** (bool) - 是否将输出进行堆叠。默认值:False。
492521 - **callbacks ** (Callback|list[Callback]|None) - ``Callback `` 的一个实例或实例列表。默认值:None。
493522
494- 返回:模型的输出。
523+ ** 返回 **
495524
496- **代码示例 **:
525+ 模型的输出。
526+
527+ **代码示例 **
497528
498529.. code-block :: python
499530
@@ -539,14 +570,17 @@ summary(input_size=None, batch_size=None, dtype=None)
539570
540571打印网络的基础结构和参数信息。
541572
542- 参数:
573+ **参数 **
574+
543575 - **input_size ** (tuple|InputSpec|list[tuple|InputSpec,可选) - 输入张量的大小。如果网络只有一个输入,那么该值需要设定为tuple或InputSpec。如果模型有多个输入。那么该值需要设定为list[tuple|InputSpec],包含每个输入的shape。如果该值没有设置,会将 ``self._inputs `` 作为输入。默认值:None。
544576 - **batch_size ** (int,可选) - 输入张量的批大小。默认值:None。
545577 - **dtypes ** (str,可选) - 输入张量的数据类型,如果没有给定,默认使用 ``float32 `` 类型。默认值:None。
546578
547- 返回:字典:包含网络全部参数的大小和全部可训练参数的大小。
579+ **返回 **
580+
581+ 字典:包含网络全部参数的大小和全部可训练参数的大小。
548582
549- **代码示例 **:
583+ **代码示例 **
550584
551585.. code-block :: python
552586
0 commit comments