Skip to content

[Docathon][Fix note No.15-16] #7162

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Mar 31, 2025
Merged

[Docathon][Fix note No.15-16] #7162

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd08e8c
修复api文档optimizer_Adam_cn 与 optimizer_Adamax_cn 中缩进与标题下划线问题
Mar 25, 2025
876b94a
Merge branch 'develop' of https://github.com/PaddlePaddle/docs into f…
Mar 25, 2025
5a44671
sign CLA and recommit
Haroldlhl Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/api/paddle/optimizer/Adam_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ step()
'''''''''

.. note::
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

执行一次优化器并进行参数更新。

Expand All @@ -74,7 +74,7 @@ step()
COPY-FROM: paddle.optimizer.Adam.step

append_regularization_ops(parameters_and_grads, regularization=None)
'''''''''
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
创建并添加反向正则化算子，该操作将正则化函数的梯度添加到参数的梯度中并返回修改后的梯度。

**参数**
Expand All @@ -91,7 +91,7 @@ append_regularization_ops(parameters_and_grads, regularization=None)
list[(Variable, Variable)]

minimize(loss, startup_program=None, parameters=None, no_grad_set=None)
'''''''''
''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

为网络添加反向计算过程，并根据反向计算所得的梯度，更新 parameters 中的 Parameters，最小化网络损失值 loss。

Expand All @@ -112,10 +112,10 @@ minimize(loss, startup_program=None, parameters=None, no_grad_set=None)
COPY-FROM: paddle.optimizer.Adam.minimize

clear_grad()
'''''''''
''''''''''''''''''

.. note::
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。


清除需要优化的参数的梯度。
Expand All @@ -125,11 +125,11 @@ clear_grad()
COPY-FROM: paddle.optimizer.Adam.clear_grad

set_lr(value)
'''''''''
''''''''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

手动设置当前 ``optimizer`` 的学习率。当使用_LRScheduler 时，无法使用该 API 手动设置学习率，因为这将导致冲突。

Expand All @@ -146,11 +146,11 @@ set_lr(value)
COPY-FROM: paddle.optimizer.Adam.set_lr

set_lr_scheduler(scheduler)
'''''''''
''''''''''''''''''''''''''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

手动设置当前 ``optimizer`` 的学习率为 LRScheduler 类。

Expand All @@ -170,7 +170,7 @@ get_lr()
'''''''''

.. note::
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

获取当前步骤的学习率。当不使用_LRScheduler 时，每次调用的返回值都相同，否则返回当前步骤的学习率。

Expand All @@ -184,7 +184,7 @@ float，当前步骤的学习率。
COPY-FROM: paddle.optimizer.Adam.get_lr

set_state_dict(state_dict)
'''''''''
''''''''''''''''''''''''''''''''''''

加载优化器状态词典，对于 Adam 优化器，包含 beta1，beta2，momentum 等。如果使用 LRScheduler，global_step 将会改变。

Expand All @@ -201,7 +201,7 @@ set_state_dict(state_dict)
COPY-FROM: paddle.optimizer.Adam.set_state_dict

state_dict(state_dict)
'''''''''
'''''''''''''''''''''''''''

从优化器中获取 state_dict 信息，其中包含所有优化器所需的值，对于 Adam 优化器，包含 beta1，beta2，momentum 等。
如果使用 LRScheduler，global_step 将被包含在 state_dict 内。如果优化器未被调用 minimize 函数，state_dict 将为空。
Expand Down
22 changes: 11 additions & 11 deletions docs/api/paddle/optimizer/Adamax_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ COPY-FROM: paddle.optimizer.Adamax
方法
::::::::::::
step()
'''''''''
''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

执行一次优化器并进行参数更新。

Expand All @@ -71,7 +71,7 @@ step()
COPY-FROM: paddle.optimizer.Adamax.step

minimize(loss, startup_program=None, parameters=None, no_grad_set=None)
'''''''''
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''

为网络添加反向计算过程，并根据反向计算所得的梯度，更新 parameters 中的 Parameters，最小化网络损失值 loss。

Expand All @@ -92,11 +92,11 @@ COPY-FROM: paddle.optimizer.Adamax.minimize


clear_grad()
'''''''''
''''''''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。


清除需要优化的参数的梯度。
Expand All @@ -106,11 +106,11 @@ clear_grad()
COPY-FROM: paddle.optimizer.Adamax.clear_grad

set_lr(value)
'''''''''
''''''''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

手动设置当前 ``optimizer`` 的学习率。当使用_LRScheduler 时，无法使用该 API 手动设置学习率，因为这将导致冲突。

Expand All @@ -127,11 +127,11 @@ set_lr(value)
COPY-FROM: paddle.optimizer.Adamax.set_lr

set_lr_scheduler(scheduler)
'''''''''
''''''''''''''''''''''''''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

手动设置当前 ``optimizer`` 的学习率为 LRScheduler 类。

Expand All @@ -148,11 +148,11 @@ set_lr_scheduler(scheduler)
COPY-FROM: paddle.optimizer.Adamax.set_lr_scheduler

get_lr()
'''''''''
'''''''''''''

.. note::

该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。
该 API 只在 `Dygraph <../../user_guides/howto/dygraph/DyGraph.html>`_ 模式下生效。

获取当前步骤的学习率。当不使用_LRScheduler 时，每次调用的返回值都相同，否则返回当前步骤的学习率。

Expand Down