Files
dgl/docs/source/api/python/nn.mxnet.rst
Zihao Ye 9a0511c8e9 [NN] nn modules & examples update (#890)
* upd

* damn it

* fuck

* fuck pylint

* fudge

* remove some comments about MXNet

* upd

* upd

* damn it

* damn it

* fuck

* fuck

* upd

* upd

* pylint bastard

* upd

* upd

* upd

* upd

* upd

* upd

* upd

* upd

* upd
2019-11-03 17:29:42 -05:00

198 lines
4.0 KiB
ReStructuredText

.. _apinn-mxnet:
NN Modules (MXNet)
===================
.. contents:: Contents
:local:
We welcome your contribution! If you want a model to be implemented in DGL as a NN module,
please `create an issue <https://github.com/dmlc/dgl/issues>`_ started with "[Feature Request] NN Module XXXModel".
If you want to contribute a NN module, please `create a pull request <https://github.com/dmlc/dgl/pulls>`_ started
with "[NN] XXXModel in MXNet NN Modules" and our team member would review this PR.
Conv Layers
----------------------------------------
.. automodule:: dgl.nn.mxnet.conv
GraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.conv.GraphConv
:members: weight, bias, forward
:show-inheritance:
RelGraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.conv.RelGraphConv
:members: forward
:show-inheritance:
TAGConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.conv.TAGConv
:members: forward
:show-inheritance:
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:
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
:show-inheritance
Dense Conv Layers
----------------------------------------
DenseGraphConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.conv.DenseGraphConv
:members: forward
:show-inheritance:
DenseSAGEConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.conv.DenseSAGEConv
:members: forward
:show-inheritance
DenseChebConv
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.pytorch.conv.DenseChebConv
:members: forward
:show-inheritance:
Global Pooling Layers
----------------------------------------
.. automodule:: dgl.nn.mxnet.glob
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
:members:
:show-inheritance:
GlobalAttentionPooling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.glob.GlobalAttentionPooling
:members:
:show-inheritance:
Set2Set
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autoclass:: dgl.nn.mxnet.glob.Set2Set
:members:
:show-inheritance:
Utility Modules
----------------------------------------
Edge Softmax
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: dgl.nn.mxnet.softmax
:members: edge_softmax