Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
nn.mxnet.rst 3.73 KB
Newer Older
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
1
2 
.. _apinn-mxnet:
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
3
4 
NN Modules (MXNet)
===================
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
5
Tianjun Xiao's avatar
[NN] [Doc] Fix nn api doc (#2047)  
Tianjun Xiao committed
6 
Conv Layers
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
7 
----------------------------------------
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
8
9
10 

.. automodule:: dgl.nn.mxnet.conv
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
11
12
13 
GraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
14
15
16 
.. autoclass:: dgl.nn.mxnet.conv.GraphConv
    :members: weight, bias, forward
    :show-inheritance:
Zihao Ye's avatar
[Feature] DGL Pooling modules (#669)  
Zihao Ye committed
17
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
18
19
20 
RelGraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Minjie Wang's avatar
[NN] RGCN modules (#744)  
Minjie Wang committed
21
22
23
24 
.. autoclass:: dgl.nn.mxnet.conv.RelGraphConv
    :members: forward
    :show-inheritance:
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
25
26
27 
TAGConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
xiang song(charlie.song)'s avatar
[NN] Add MXNet impl for TAGCN module. (#799)  
xiang song(charlie.song) committed
28
29
30
31 
.. autoclass:: dgl.nn.mxnet.conv.TAGConv
    :members: forward
    :show-inheritance:
Zihao Ye's avatar
[NN] nn modules & examples update (#890)  
Zihao Ye committed
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86 
GATConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.GATConv
    :members: forward
    :show-inheritance:

EdgeConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.EdgeConv
    :members: forward
    :show-inheritance:

SAGEConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.SAGEConv
    :members: forward
    :show-inheritance:

SGConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.SGConv
    :members: forward
    :show-inheritance:

APPNPConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.APPNPConv
    :members: forward
    :show-inheritance:

GINConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.GINConv
    :members: forward
    :show-inheritance:

GatedGraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.GatedGraphConv
    :members: forward
    :show-inheritance:

GMMConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.GMMConv
    :members: forward
    :show-inheritance:
Tianjun Xiao's avatar
[NN] [Doc] Fix nn api doc (#2047)  
Tianjun Xiao committed
87
Zihao Ye's avatar
[NN] nn modules & examples update (#890)  
Zihao Ye committed
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106 
ChebConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.ChebConv
    :members: forward
    :show-inheritance:

AGNNConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.AGNNConv
    :members: forward
    :show-inheritance:

NNConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.NNConv
    :members: forward
Tianjun Xiao's avatar
[NN] [Doc] Fix nn api doc (#2047)  
Tianjun Xiao committed
107 
    :show-inheritance:
Zihao Ye's avatar
[NN] nn modules & examples update (#890)  
Zihao Ye committed
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123 

Dense Conv Layers
----------------------------------------

DenseGraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.DenseGraphConv
    :members: forward
    :show-inheritance:

DenseSAGEConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.conv.DenseSAGEConv
    :members: forward
Tianjun Xiao's avatar
[NN] [Doc] Fix nn api doc (#2047)  
Tianjun Xiao committed
124 
    :show-inheritance:
Zihao Ye's avatar
[NN] nn modules & examples update (#890)  
Zihao Ye committed
125
126
127
128 

DenseChebConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Tianjun Xiao's avatar
[NN] [Doc] Fix nn api doc (#2047)  
Tianjun Xiao committed
129 
.. autoclass:: dgl.nn.mxnet.conv.DenseChebConv
Zihao Ye's avatar
[NN] nn modules & examples update (#890)  
Zihao Ye committed
130
131 
    :members: forward
    :show-inheritance:
xiang song(charlie.song)'s avatar
[Kernel][Perf] Message builtin with broadcasting performance optimization (#815)  
xiang song(charlie.song) committed
132
Da Zheng's avatar
[KG][Model] Knowledge graph embeddings (#888)  
Da Zheng committed
133 
Global Pooling Layers
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
134 
----------------------------------------
Zihao Ye's avatar
[Feature] DGL Pooling modules (#669)  
Zihao Ye committed
135
136 

.. automodule:: dgl.nn.mxnet.glob
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162 

SumPooling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.glob.SumPooling
    :members:
    :show-inheritance:

AvgPooling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.glob.AvgPooling
    :members:
    :show-inheritance:

MaxPooling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.glob.MaxPooling
    :members:
    :show-inheritance:

SortPooling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.glob.SortPooling
Zihao Ye's avatar
[Feature] DGL Pooling modules (#669)  
Zihao Ye committed
163 
    :members:
Zihao Ye's avatar
upd (#741)  
Zihao Ye committed
164 
    :show-inheritance:
Zihao Ye's avatar
[Feature] DGL Pooling modules (#669)  
Zihao Ye committed
165
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
166
167
168
169
170
171
172
173
174
175
176
177
178
179 
GlobalAttentionPooling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.glob.GlobalAttentionPooling
    :members:
    :show-inheritance:

Set2Set
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.glob.Set2Set
    :members:
    :show-inheritance:
Quan (Andy) Gan's avatar
[Doc] User guide section 5 and 6 (#2029)  
Quan (Andy) Gan committed
180
181
182
183
184
185
186
187
188 
Heterogeneous Graph Convolution Module
----------------------------------------

HeteroGraphConv
~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.HeteroGraphConv
   :members:
   :show-inheritance:
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
189
190
191
192 

Utility Modules
----------------------------------------
Zihao Ye's avatar
[Feature] Add dgl.nn.*.Sequential for usability (#1166)  
Zihao Ye committed
193
194
195
196
197
198 
Sequential
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: dgl.nn.mxnet.utils.Sequential
    :members:
    :show-inheritance: