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.

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

[Docathon] Add paddle.incubate.ampdecorate and paddle.incubate.amp.prune_model API CN Doc #6222

Merged
merged 15 commits into from
Oct 16, 2023
Merged

[Docathon] Add paddle.incubate.ampdecorate and paddle.incubate.amp.prune_model API CN Doc #6222

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a37334e
add incubate_amp_decorate and prune_model
ooooo-create Oct 9, 2023
f53b096
fix copy from
ooooo-create Oct 10, 2023
a97b648
update_name_clearly
ooooo-create Oct 10, 2023
a95614d
rename
ooooo-create Oct 10, 2023
15c276a
fix language
ooooo-create Oct 10, 2023
c72c883
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
8843386
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
09c9d8f
Update docs/api/paddle/incubate/asp/decorate_cn.rst
ooooo-create Oct 11, 2023
5313fc5
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
ec63520
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
e7ef60c
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
fd126fd
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
8514ad5
Update docs/api/paddle/incubate/asp/prune_model_cn.rst
ooooo-create Oct 11, 2023
7227040
fix spell
ooooo-create Oct 11, 2023
cc5af4f
fix
ooooo-create Oct 12, 2023
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
Prev Previous commit
Next Next commit
rename
  • Loading branch information
@ooooo-create
ooooo-create committed Oct 10, 2023
commit a95614d4ce9ed9e427a8a8311eabbcf2359f0b77
8 changes: 4 additions & 4 deletions docs/api/paddle/incubate/amp/decorate_cn.rst → docs/api/paddle/incubate/asp/decorate_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _cn_api_paddle_incubate_amp_decorate:
.. _cn_api_paddle_incubate_asp_decorate:

decorate
-------------------------------

.. py:function:: paddle.incubate.amp.decorate(optimizer)
.. py:function:: paddle.incubate.asp.decorate(optimizer)


将给定的优化器包装为 `OptimizerWithSparsityGuarantee`。如果在动态图模式下运行，装饰时 ASP 会为支持的参数创建掩码变量。如果在静态图模式下运行，ASP 会在调用 minimize() 时创建掩码变量并插入必要的掩码操作。
ooooo-create marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -24,8 +24,8 @@ decorate

1. 动态图模式

COPY-FROM: paddle.incubate.amp.decorate:dynamic_graph
COPY-FROM: paddle.incubate.asp.decorate:dynamic_graph

2. 静态图模式

COPY-FROM: paddle.incubate.amp.decorate:static_graph
COPY-FROM: paddle.incubate.asp.decorate:static_graph
10 changes: 5 additions & 5 deletions ...pi/paddle/incubate/amp/prune_model_cn.rst → ...pi/paddle/incubate/asp/prune_model_cn.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. _cn_api_paddle_incubate_amp_prune_model:
.. _cn_api_paddle_incubate_asp_prune_model:

prune_model
-------------------------------

.. py:function:: paddle.incubate.amp.prune_model(model, n=2, m=4, mask_algo='mask_1d', with_mask=True)
.. py:function:: paddle.incubate.asp.prune_model(model, n=2, m=4, mask_algo='mask_1d', with_mask=True)


使用 mask_algo 指定的掩码生成函数修剪 model 中支持 ASP 的子层参数。使用 with_mask 来控制模型训练和推理，如果 with_mask 是 True ，还有修剪参数相关的 ASP 掩码变量，如果是 False，仅仅裁剪参数。
ooooo-create marked this conversation as resolved.
Show resolved Hide resolved
Expand All @@ -19,7 +19,7 @@ prune_model
- **n** (int, optional) - n:m 稀疏中的 n
- **m** (int, optional) - n:m 稀疏中的 m
- **mask_algo** (string, optional) - 生成掩码的函数名。默认值为 mask_1d。有效输入应为 mask_1d ， mask_2d_greedy 和 mask_2d_best 之一。
- **with_mask** (bool, optional) - 选择是否裁剪参数相关的 AMP 掩码变量，True 是要裁剪，False 就是不裁剪。默认是 True。
- **with_mask** (bool, optional) - 选择是否裁剪参数相关的 ASP 掩码变量，True 是要裁剪，False 就是不裁剪。默认是 True。

返回
:::::::::
Expand All @@ -31,8 +31,8 @@ prune_model

1. 动态图模式

COPY-FROM: paddle.incubate.amp.prune_model:dynamic_graph
COPY-FROM: paddle.incubate.asp.prune_model:dynamic_graph

2. 静态图模式

COPY-FROM: paddle.incubate.amp.prune_model:static_graph
COPY-FROM: paddle.incubate.asp.prune_model:static_graph