Skip to content

Commit dd11fe0

Browse files
Add Module,ModuleList,ModuleDict docs (#7656)
1 parent b4ce8a1 commit dd11fe0

File tree

4 files changed

+800
-4
lines changed

4 files changed

+800
-4
lines changed
Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
.. _cn_api_paddle_nn_ModuleDict:
2+
3+
ModuleDict
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.ModuleDict(modules=None)
7+
8+
9+
10+
11+
ModuleDict 用于保存子层到有序字典中,它包含的子层将被正确地注册和添加。列表中的子层可以像常规 python 有序字典一样被访问。
12+
13+
.. note::
14+
``LayerDict`` 是 ``ModuleDict`` 的别名,两者在使用和功能上完全等价。
15+
16+
参数
17+
::::::::::::
18+
19+
- **modules** (ModuleDict|OrderedDict|list[(key, Module)],可选) - 键值对的可迭代对象,值的类型为 `paddle.nn.Module` 。
20+
21+
22+
代码示例
23+
::::::::::::
24+
25+
COPY-FROM: paddle.nn.ModuleDict
26+
27+
方法
28+
::::::::::::
29+
clear()
30+
'''''''''
31+
32+
清除 ModuleDict 中所有的子层。
33+
34+
**参数**
35+
36+
无。
37+
38+
**代码示例**
39+
40+
COPY-FROM: paddle.nn.ModuleDict.clear
41+
42+
pop()
43+
'''''''''
44+
45+
移除 ModuleDict 中的键 并且返回该键对应的子层。
46+
47+
**参数**
48+
49+
- **key** (str) - 要移除的 key。
50+
51+
**代码示例**
52+
53+
COPY-FROM: paddle.nn.ModuleDict.pop
54+
55+
keys()
56+
'''''''''
57+
58+
返回 ModuleDict 中键的可迭代对象。
59+
60+
**参数**
61+
62+
无。
63+
64+
**代码示例**
65+
66+
COPY-FROM: paddle.nn.ModuleDict.keys
67+
68+
items()
69+
'''''''''
70+
71+
返回 ModuleDict 中键/值对的可迭代对象。
72+
73+
**参数**
74+
75+
无。
76+
77+
**代码示例**
78+
79+
COPY-FROM: paddle.nn.ModuleDict.items
80+
81+
82+
values()
83+
'''''''''
84+
85+
返回 ModuleDict 中值的可迭代对象。
86+
87+
**参数**
88+
89+
无。
90+
91+
**代码示例**
92+
93+
COPY-FROM: paddle.nn.ModuleDict.values
94+
95+
96+
update()
97+
'''''''''
98+
99+
更新子层中的键/值对到 ModuleDict 中,会覆盖已经存在的键。
100+
101+
**参数**
102+
103+
- **modules** (ModuleDict|OrderedDict|list[(key, Module)]) - 键值对的可迭代对象,值的类型为 `paddle.nn.Module` 。
104+
105+
**代码示例**
106+
107+
COPY-FROM: paddle.nn.ModuleDict.update
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
.. _cn_api_paddle_nn_ModuleList:
2+
3+
ModuleList
4+
-------------------------------
5+
6+
.. py:class:: paddle.nn.ModuleList(modules=None)
7+
8+
9+
10+
11+
ModuleList 用于保存子层列表,它包含的子层将被正确地注册和添加。列表中的子层可以像常规 python 列表一样被索引。
12+
13+
.. note::
14+
``LayerList`` 是 ``ModuleList`` 的别名,两者在使用和功能上完全等价。
15+
16+
参数
17+
::::::::::::
18+
19+
- **modules** (iterable,可选) - 要保存的子层。
20+
21+
22+
代码示例
23+
::::::::::::
24+
25+
COPY-FROM: paddle.nn.ModuleList
26+
27+
方法
28+
::::::::::::
29+
append()
30+
'''''''''
31+
32+
添加一个子层到整个 list 的最后。
33+
34+
**参数**
35+
36+
- **modules** (Module) - 要添加的子层。
37+
38+
**代码示例**
39+
40+
COPY-FROM: paddle.nn.ModuleList.append
41+
42+
insert()
43+
'''''''''
44+
45+
向 list 中插入一个子层,到给定的 index 前面。
46+
47+
**参数**
48+
49+
- **index** (int) - 要插入的位置。
50+
- **module** (Module) - 要插入的子层。
51+
52+
**代码示例**
53+
54+
COPY-FROM: paddle.nn.ModuleList.insert
55+
56+
extend()
57+
'''''''''
58+
59+
添加多个子层到整个 list 的最后。
60+
61+
**参数**
62+
63+
- **modules** (iterable of Module) - 要添加的所有子层。
64+
65+
**代码示例**
66+
67+
COPY-FROM: paddle.nn.ModuleList.extend

0 commit comments

Comments
 (0)