Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[automatic repair] update Chinese api_label with new standard #6171

Merged
merged 3 commits into from
Sep 7, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Next Next commit
fix cn_api_label
  • Loading branch information
ooooo-create committed Sep 7, 2023
commit c09023fa914b0e983cc153401bd852a5a5c977f6
2 changes: 1 addition & 1 deletion docs/api/paddle/CPUPlace_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_CPUPlace:
.. _cn_api_paddle_CPUPlace:

CPUPlace
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/CUDAPinnedPlace_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_CUDAPinnedPlace:
.. _cn_api_paddle_CUDAPinnedPlace:

CUDAPinnedPlace
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/CUDAPlace_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_CUDAPlace:
.. _cn_api_paddle_CUDAPlace:

CUDAPlace
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/DataParallel_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_dygraph_DataParallel:
.. _cn_api_paddle_DataParallel:

DataParallel
------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/LazyGuard_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_LazyGuard:
.. _cn_api_paddle_LazyGuard:

LazyGuard
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/Model_cn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ prepare(optimizer=None, loss=None, metrics=None, amp_configs=None)
- **optimizer** (OOptimizer|None,可选) - 当训练模型的,该参数必须被设定。当评估或测试的时候,该参数可以不设定。默认值:None。
- **loss** (Loss|Callable|None,可选) - 当训练模型的,该参数必须被设定。默认值:None。
- **metrics** (Metric|list[Metric]|None,可选) - 当该参数被设定时,所有给定的评估方法会在训练和测试时被运行,并返回对应的指标。默认值:None。
- **amp_configs** (str|dict|None,可选) - 混合精度训练的配置,通常是个 dict,也可以是 str。当使用自动混合精度训练或者纯 float16 训练时,``amp_configs`` 的 key ``level`` 需要被设置为 O1 或者 O2,float32 训练时则默认为 O0。除了 ``level`` ,还可以传入更多的和混合精度 API 一致的参数,例如:``init_loss_scaling``、 ``incr_ratio`` 、 ``decr_ratio``、 ``incr_every_n_steps``、 ``decr_every_n_nan_or_inf``、 ``use_dynamic_loss_scaling``、 ``custom_white_list``、 ``custom_black_list`` ,在静态图下还支持传入 ``custom_black_varnames`` 和 ``use_fp16_guard`` 。详细使用方法可以参考参考混合精度 API 的文档 :ref:`auto_cast <cn_api_amp_auto_cast>` 和 :ref:`GradScaler <cn_api_amp_GradScaler>` 。为了方便起见,当不设置其他的配置参数时,也可以直接传入 ``'O1'`` 、``'O2'`` 。在使用 float32 训练时,该参数可以为 None。默认值:None。
- **amp_configs** (str|dict|None,可选) - 混合精度训练的配置,通常是个 dict,也可以是 str。当使用自动混合精度训练或者纯 float16 训练时,``amp_configs`` 的 key ``level`` 需要被设置为 O1 或者 O2,float32 训练时则默认为 O0。除了 ``level`` ,还可以传入更多的和混合精度 API 一致的参数,例如:``init_loss_scaling``、 ``incr_ratio`` 、 ``decr_ratio``、 ``incr_every_n_steps``、 ``decr_every_n_nan_or_inf``、 ``use_dynamic_loss_scaling``、 ``custom_white_list``、 ``custom_black_list`` ,在静态图下还支持传入 ``custom_black_varnames`` 和 ``use_fp16_guard`` 。详细使用方法可以参考参考混合精度 API 的文档 :ref:`auto_cast <cn_api_paddle_amp_auto_cast>` 和 :ref:`GradScaler <cn_api_paddle_amp_GradScaler>` 。为了方便起见,当不设置其他的配置参数时,也可以直接传入 ``'O1'`` 、``'O2'`` 。在使用 float32 训练时,该参数可以为 None。默认值:None。


fit(train_data=None, eval_data=None, batch_size=1, epochs=1, eval_freq=1, log_freq=10, save_dir=None, save_freq=1, verbose=2, drop_last=False, shuffle=True, num_workers=0, callbacks=None, accumulate_grad_batches=1, num_iters=None)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/paddle/NPUPlace_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_NPUPlace:
.. _cn_api_paddle_NPUPlace:

NPUPlace
-------------------------------
Expand Down
510 changes: 255 additions & 255 deletions docs/api/paddle/Overview_cn.rst

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/api/paddle/ParamAttr_cn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _cn_api_fluid_ParamAttr:
.. _cn_api_paddle_ParamAttr:


ParamAttr
Expand All @@ -10,7 +10,7 @@ ParamAttr

.. note::
该类中的 ``gradient_clip`` 属性在 2.0 版本会废弃,推荐使用 ``need_clip`` 来设置梯度裁剪范围,并在初始化 ``optimizer`` 时设置梯度裁剪。
共有三种裁剪策略: :ref:`cn_api_fluid_clip_ClipGradByGlobalNorm` 、 :ref:`cn_api_fluid_clip_ClipGradByNorm` 、 :ref:`cn_api_fluid_clip_ClipGradByValue` 。
共有三种裁剪策略: :ref:`cn_api_paddle_nn_ClipGradByGlobalNorm` 、 :ref:`cn_api_paddle_nn_ClipGradByNorm` 、 :ref:`cn_api_paddle_nn_ClipGradByValue` 。

创建一个参数属性对象,用户可设置参数的名称、初始化方式、学习率、正则化规则、是否需要训练、梯度裁剪方式、是否做模型平均等属性。

Expand Down
1 change: 0 additions & 1 deletion docs/api/paddle/Tensor/Overview_en.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

.. _en_paddle_Tensor:

paddle.Tensor
Expand Down
Loading