Skip to content

Refine API set_state_dict cn doc of Layer #2535

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
saxon-zh merged 1 commit into from
Sep 3, 2020
Merged

Refine API set_state_dict cn doc of Layer #2535

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 13 additions & 32 deletions doc/paddle/api/paddle/fluid/dygraph/layers/Layer_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,50 +391,31 @@ buffer是一个非参数类型的变量，不会被优化器更新，但在评
state_dict = emb.state_dict()
fluid.save_dygraph(state_dict, "paddle_dy")

.. py:method:: set_dict(stat_dict, include_sublayers=True)
.. py:method:: set_state_dict(state_dict, include_sublayers=True, use_structured_name=True)

根据传入的 ``stat_dict`` 设置参数和可持久性buffers。 所有参数和buffers将由 ``stat_dict`` 中的 ``Tensor`` 设置。
根据传入的 ``state_dict`` 设置参数和可持久性buffers。 所有参数和buffers将由 ``state_dict`` 中的 ``Tensor`` 设置。

参数：
- **state_dict** (dict) - 包含所有参数和可持久性buffers的dict。
- **include_sublayers** (bool, 可选) - 如果设置为True，则还包括子层的参数和buffers。 默认值：True。
- **use_structured_name** (bool, 可选) - 如果设置为True，将使用Layer的结构性变量名作为dict的key，否则将使用Parameter或者Buffer的变量名作为key。默认值：True。

返回：None

**代码示例**

.. code-block:: python

import paddle.fluid as fluid
with fluid.dygraph.guard():
emb = fluid.dygraph.Embedding([10, 10])
state_dict = emb.state_dict()
fluid.save_dygraph(state_dict, "paddle_dy")
para_state_dict, _ = fluid.load_dygraph("paddle_dy")
emb.set_dict(para_state_dict)

.. py:method:: load_dict(stat_dict, include_sublayers=True)

.. warning::
该函数将被弃用。请使用set_dict函数。

根据传入的 ``stat_dict`` 设置参数和可持久性buffers。 所有参数和buffers将由 ``stat_dict`` 中的 ``Tensor`` 设置。

参数：
- **state_dict** (dict) - 包含所有参数和可持久性buffers的dict。
- **include_sublayers** (bool, 可选) - 如果设置为True，则还包括子层的参数和buffers。 默认值：True。

返回：None
import paddle

paddle.disable_static()

emb = paddle.nn.Embedding([10, 10])

**代码示例**

.. code-block:: python
state_dict = emb.state_dict()
paddle.save(state_dict, "paddle_dy")

para_state_dict, _ = paddle.load("paddle_dy")

import paddle.fluid as fluid
with fluid.dygraph.guard():
emb = fluid.dygraph.Embedding([10, 10])
state_dict = emb.state_dict()
fluid.save_dygraph(state_dict, "paddle_dy")
para_state_dict, _ = fluid.load_dygraph("paddle_dy")
emb.load_dict(para_state_dict)
emb.set_state_dict(para_state_dict)