Skip to content

Commit 1e2abc9

Browse files
VoVAllenyzh119
VoVAllen
authored and
yzh119
committed
[Docs] Adjust doc (dmlc#808)
* fix doc * poke ci * poke ci * upd * fix doc * upd * add title for all nn * upd
1 parent 8844246 commit 1e2abc9

File tree

8 files changed

+209
-27
lines changed

8 files changed

+209
-27
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ It'll be great if relevant reviewers can be assigned as well.-->
44

55
## Checklist
66
Please feel free to remove inapplicable items for your PR.
7-
- [ ] The PR title starts with [$CATEGORY] (such as [Model], [Doc], [Feature]])
7+
- [ ] The PR title starts with [$CATEGORY] (such as [NN], [Model], [Doc], [Feature]])
88
- [ ] Changes are complete (i.e. I finished coding on this PR)
99
- [ ] All changes have test coverage
1010
- [ ] Code is well-documented

‎docs/source/api/python/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ API Reference
1818
subgraph
1919
graph_store
2020
nodeflow
21+
random

‎docs/source/api/python/nn.mxnet.rst

+70-8
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,96 @@
11
.. _apinn-mxnet:
22

3-
dgl.nn.mxnet
4-
============
3+
NN Modules (MXNet)
4+
===================
55

6-
dgl.nn.mxnet.conv
7-
-----------------
6+
.. contents:: Contents
7+
:local:
8+
9+
We welcome your contribution! If you want a model to be implemented in DGL as a NN module,
10+
please `create an issue <https://github.com/dmlc/dgl/issues>`_ started with "[Feature Request] NN Module XXXModel".
11+
12+
If you want to contribute a NN module, please `create a pull request <https://github.com/dmlc/dgl/pulls>`_ started
13+
with "[NN] XXXModel in MXNet NN Modules" and our team member would review this PR.
14+
15+
Conv Layers
16+
----------------------------------------
817

918
.. automodule:: dgl.nn.mxnet.conv
1019

20+
GraphConv
21+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22+
1123
.. autoclass:: dgl.nn.mxnet.conv.GraphConv
1224
:members: weight, bias, forward
1325
:show-inheritance:
1426

27+
RelGraphConv
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
29+
1530
.. autoclass:: dgl.nn.mxnet.conv.RelGraphConv
1631
:members: forward
1732
:show-inheritance:
1833

34+
TAGConv
35+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
36+
1937
.. autoclass:: dgl.nn.mxnet.conv.TAGConv
2038
:members: forward
2139
:show-inheritance:
2240

23-
dgl.nn.mxnet.glob
24-
-----------------
41+
Global Pooling Layers
42+
----------------------------------------
2543

2644
.. automodule:: dgl.nn.mxnet.glob
45+
46+
SumPooling
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
49+
.. autoclass:: dgl.nn.mxnet.glob.SumPooling
50+
:members:
51+
:show-inheritance:
52+
53+
AvgPooling
54+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
55+
56+
.. autoclass:: dgl.nn.mxnet.glob.AvgPooling
57+
:members:
58+
:show-inheritance:
59+
60+
MaxPooling
61+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62+
63+
.. autoclass:: dgl.nn.mxnet.glob.MaxPooling
64+
:members:
65+
:show-inheritance:
66+
67+
SortPooling
68+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
69+
70+
.. autoclass:: dgl.nn.mxnet.glob.SortPooling
2771
:members:
2872
:show-inheritance:
2973

30-
dgl.nn.mxnet.softmax
31-
--------------------
74+
GlobalAttentionPooling
75+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
76+
77+
.. autoclass:: dgl.nn.mxnet.glob.GlobalAttentionPooling
78+
:members:
79+
:show-inheritance:
80+
81+
Set2Set
82+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83+
84+
.. autoclass:: dgl.nn.mxnet.glob.Set2Set
85+
:members:
86+
:show-inheritance:
87+
88+
89+
Utility Modules
90+
----------------------------------------
91+
92+
Edge Softmax
93+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3294

3395
.. automodule:: dgl.nn.mxnet.softmax
3496
:members: edge_softmax

‎docs/source/api/python/nn.pytorch.rst

+110-16
Original file line numberDiff line numberDiff line change
@@ -1,132 +1,226 @@
11
.. _apinn-pytorch:
22

3-
dgl.nn.pytorch
4-
==============
3+
NN Modules (PyTorch)
4+
====================
55

6-
dgl.nn.pytorch.conv
7-
-------------------
6+
.. contents:: Contents
7+
:local:
8+
9+
We welcome your contribution! If you want a model to be implemented in DGL as a NN module,
10+
please `create an issue <https://github.com/dmlc/dgl/issues>`_ started with "[Feature Request] NN Module XXXModel".
11+
12+
If you want to contribute a NN module, please `create a pull request <https://github.com/dmlc/dgl/pulls>`_ started
13+
with "[NN] XXXModel in PyTorch NN Modules" and our team member would review this PR.
14+
15+
Conv Layers
16+
----------------------------------------
817

918
.. automodule:: dgl.nn.pytorch.conv
1019

20+
GraphConv
21+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22+
1123
.. autoclass:: dgl.nn.pytorch.conv.GraphConv
1224
:members: weight, bias, forward, reset_parameters
1325
:show-inheritance:
26+
27+
RelGraphConv
28+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1429

1530
.. autoclass:: dgl.nn.pytorch.conv.RelGraphConv
1631
:members: forward
1732
:show-inheritance:
33+
34+
TAGConv
35+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1836

1937
.. autoclass:: dgl.nn.pytorch.conv.TAGConv
2038
:members: forward
2139
:show-inheritance:
40+
41+
GATConv
42+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2243

2344
.. autoclass:: dgl.nn.pytorch.conv.GATConv
2445
:members: forward
2546
:show-inheritance:
47+
48+
EdgeConv
49+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2650

2751
.. autoclass:: dgl.nn.pytorch.conv.EdgeConv
2852
:members: forward
2953
:show-inheritance:
54+
55+
SAGEConv
56+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3057

3158
.. autoclass:: dgl.nn.pytorch.conv.SAGEConv
3259
:members: forward
3360
:show-inheritance:
61+
62+
SGConv
63+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3464

3565
.. autoclass:: dgl.nn.pytorch.conv.SGConv
3666
:members: forward
3767
:show-inheritance:
68+
69+
APPNPConv
70+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3871

3972
.. autoclass:: dgl.nn.pytorch.conv.APPNPConv
4073
:members: forward
4174
:show-inheritance:
75+
76+
GINConv
77+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4278

4379
.. autoclass:: dgl.nn.pytorch.conv.GINConv
4480
:members: forward
4581
:show-inheritance:
82+
83+
GatedGraphConv
84+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4685

4786
.. autoclass:: dgl.nn.pytorch.conv.GatedGraphConv
4887
:members: forward
4988
:show-inheritance:
89+
90+
GMMConv
91+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5092

5193
.. autoclass:: dgl.nn.pytorch.conv.GMMConv
5294
:members: forward
5395
:show-inheritance:
96+
97+
ChebConv
98+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5499

55100
.. autoclass:: dgl.nn.pytorch.conv.ChebConv
56101
:members: forward
57102
:show-inheritance:
103+
104+
AGNNConv
105+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58106

59107
.. autoclass:: dgl.nn.pytorch.conv.AGNNConv
60108
:members: forward
61109
:show-inheritance:
110+
111+
NNConv
112+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
62113

63114
.. autoclass:: dgl.nn.pytorch.conv.NNConv
64115
:members: forward
65116
:show-inheritance:
117+
118+
Dense Conv Layers
119+
----------------------------------------
120+
121+
DenseGraphConv
122+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66123

67124
.. autoclass:: dgl.nn.pytorch.conv.DenseGraphConv
68125
:members: forward
69126
:show-inheritance:
127+
128+
DenseSAGEConv
129+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
70130

71131
.. autoclass:: dgl.nn.pytorch.conv.DenseSAGEConv
72132
:members: forward
73133
:show-inheritance:
134+
135+
DenseChebConv
136+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74137

75138
.. autoclass:: dgl.nn.pytorch.conv.DenseChebConv
76139
:members: forward
77140
:show-inheritance:
141+
142+
Global Pooling Layers
143+
----------------------------------------
78144

79-
dgl.nn.pytorch.glob
80-
-------------------
81145
.. automodule:: dgl.nn.pytorch.glob
82146

147+
SumPooling
148+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
149+
83150
.. autoclass:: dgl.nn.pytorch.glob.SumPooling
84151
:members:
85152
:show-inheritance:
153+
154+
AvgPooling
155+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
86156

87157
.. autoclass:: dgl.nn.pytorch.glob.AvgPooling
88158
:members:
89159
:show-inheritance:
160+
161+
MaxPooling
162+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90163

91164
.. autoclass:: dgl.nn.pytorch.glob.MaxPooling
92165
:members:
93166
:show-inheritance:
167+
168+
SortPooling
169+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
94170

95171
.. autoclass:: dgl.nn.pytorch.glob.SortPooling
96172
:members:
97173
:show-inheritance:
174+
175+
GlobalAttentionPooling
176+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98177

99178
.. autoclass:: dgl.nn.pytorch.glob.GlobalAttentionPooling
100179
:members:
101180
:show-inheritance:
181+
182+
Set2Set
183+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
102184

103185
.. autoclass:: dgl.nn.pytorch.glob.Set2Set
104186
:members: forward
105187
:show-inheritance:
188+
189+
SetTransformerEncoder
190+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
106191

107192
.. autoclass:: dgl.nn.pytorch.glob.SetTransformerEncoder
108193
:members:
109194
:show-inheritance:
195+
196+
SetTransformerDecoder
197+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
110198

111199
.. autoclass:: dgl.nn.pytorch.glob.SetTransformerDecoder
112200
:members:
113201
:show-inheritance:
202+
203+
Utility Modules
204+
----------------------------------------
114205

115-
dgl.nn.pytorch.softmax
116-
----------------------
117-
118-
.. automodule:: dgl.nn.pytorch.softmax
119-
:members: edge_softmax
120-
121-
dgl.nn.pytorch.factory
122-
----------------------
123-
124-
.. automodule:: dgl.nn.pytorch.conv
206+
KNNGraph
207+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
125208

126209
.. autoclass:: dgl.nn.pytorch.factory.KNNGraph
127210
:members:
128211
:show-inheritance:
212+
213+
SegmentedKNNGraph
214+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129215

130216
.. autoclass:: dgl.nn.pytorch.factory.SegmentedKNNGraph
131217
:members:
132218
:show-inheritance:
219+
220+
Edge Softmax
221+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
222+
223+
.. automodule:: dgl.nn.pytorch.softmax
224+
:members: edge_softmax
225+
226+

‎docs/source/api/python/nn.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _apinn:
22

3-
dgl.nn
4-
======
3+
NN Modules
4+
==========
55

66
.. automodule:: dgl.nn
77

‎docs/source/contribute.rst

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ General development process
1010
A non-inclusive list of types of contribution is as follows:
1111

1212
* New features and enhancements (`example <https://github.com/dmlc/dgl/pull/331>`__).
13+
* New NN Modules (`example <https://github.com/dmlc/dgl/pull/788>`__).
1314
* Bugfix (`example <https://github.com/dmlc/dgl/pull/247>`__).
1415
* Document improvement (`example <https://github.com/dmlc/dgl/pull/263>`__).
1516
* New models and examples (`example <https://github.com/dmlc/dgl/pull/279>`__).

0 commit comments

Comments
 (0)