Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
nn.rst 4.6 KB
Newer Older
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
1
2 
.. _apinn:
Minjie Wang's avatar
[Doc] Re-organize API docs and tutorials (#1222)  
Minjie Wang committed
3 
dgl.nn
VoVAllen's avatar
[Docs] Adjust doc (#808)  
VoVAllen committed
4 
==========
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
5
Mufei Li's avatar
[Transform] [Doc] Rename transform to transforms and update doc (#3765)  
Mufei Li committed
6
7 
PyTorch
----------------------------------------
Minjie Wang's avatar
[Doc] doc page for builtin functions (#642)  
Minjie Wang committed
8
Mufei Li's avatar
[Transform] [Doc] Rename transform to transforms and update doc (#3765)  
Mufei Li committed
9
10 
Conv Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Minjie Wang's avatar
[WIP] [NN] Refactor NN package (#406)  
Minjie Wang committed
11
Mufei Li's avatar
[Transform] [Doc] Rename transform to transforms and update doc (#3765)  
Mufei Li committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257 
.. currentmodule:: dgl.nn.pytorch.conv
.. automodule:: dgl.nn.pytorch.conv

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    GraphConv
    EdgeWeightNorm
    RelGraphConv
    TAGConv
    GATConv
    GATv2Conv
    EGATConv
    EdgeConv
    SAGEConv
    SGConv
    APPNPConv
    GINConv
    GatedGraphConv
    GMMConv
    ChebConv
    AGNNConv
    NNConv
    AtomicConv
    CFConv
    DotGatConv
    TWIRLSConv
    TWIRLSUnfoldingAndAttention
    GCN2Conv

Dense Conv Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    DenseGraphConv
    DenseSAGEConv
    DenseChebConv

Global Pooling Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.pytorch.glob
.. automodule:: dgl.nn.pytorch.glob

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    SumPooling
    AvgPooling
    MaxPooling
    SortPooling
    WeightAndSum
    GlobalAttentionPooling
    Set2Set
    SetTransformerEncoder
    SetTransformerDecoder

Score Modules for Link Prediction and Knowledge Graph Completion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.pytorch.link
.. automodule:: dgl.nn.pytorch.link

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    EdgePredictor
    TransE
    TransR

Heterogeneous Learning Modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.pytorch
.. automodule:: dgl.nn.pytorch

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    HeteroGraphConv
    HeteroLinear
    HeteroEmbedding
    TypedLinear

Utility Modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    ~utils.Sequential
    ~utils.WeightBasis
    ~factory.KNNGraph
    ~factory.SegmentedKNNGraph
    ~utils.JumpingKnowledge
    ~sparse_emb.NodeEmbedding
    ~explain.GNNExplainer

TensorFlow
----------------------------------------

Conv Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.tensorflow.conv
.. automodule:: dgl.nn.tensorflow.conv

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    GraphConv
    RelGraphConv
    GATConv
    SAGEConv
    ChebConv
    SGConv
    APPNPConv
    GINConv

Global Pooling Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.tensorflow.glob
.. automodule:: dgl.nn.tensorflow.glob

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    SumPooling
    AvgPooling
    MaxPooling
    SortPooling
    GlobalAttentionPooling

Heterogeneous Learning Modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.tensorflow
.. automodule:: dgl.nn.tensorflow

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    HeteroGraphConv

MXNet
----------------------------------------

Conv Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.mxnet.conv
.. automodule:: dgl.nn.mxnet.conv

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    GraphConv
    RelGraphConv
    TAGConv
    GATConv
    EdgeConv
    SAGEConv
    SGConv
    APPNPConv
    GINConv
    GatedGraphConv
    GMMConv
    ChebConv
    AGNNConv
    NNConv

Dense Conv Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    DenseGraphConv
    DenseSAGEConv
    DenseChebConv

Global Pooling Layers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.mxnet.glob
.. automodule:: dgl.nn.mxnet.glob

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    SumPooling
    AvgPooling
    MaxPooling
    SortPooling
    GlobalAttentionPooling
    Set2Set

Heterogeneous Learning Modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. currentmodule:: dgl.nn.mxnet
.. automodule:: dgl.nn.mxnet

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    HeteroGraphConv

Utility Modules
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    ~utils.Sequential