mirror of
https://github.com/dmlc/dgl.git
synced 2026-06-05 19:54:25 +08:00
7aa494b3bc
* add more unit tests for mxnet. * fix. * explain the batch dimension. * update doc. * disable unit tests on DFS. * fix graph traversal.
50 lines
1.2 KiB
ReStructuredText
50 lines
1.2 KiB
ReStructuredText
.. _apiudf:
|
|
|
|
User-defined function related data structures
|
|
==================================================
|
|
|
|
.. currentmodule:: dgl.udf
|
|
.. automodule:: dgl.udf
|
|
|
|
There are two types of user-defined functions in DGL:
|
|
|
|
* **Node UDF** of signature ``NodeBatch -> dict``. The argument represents
|
|
a batch of nodes. The returned dictionary should have ``str`` type key and ``tensor``
|
|
type values.
|
|
* **Edge UDF** of signature ``EdgeBatch -> dict``. The argument represents
|
|
a batch of edges. The returned dictionary should have ``str`` type key and ``tensor``
|
|
type values.
|
|
|
|
Note: the size of the batch dimension is determined by the DGL framework
|
|
for good efficiency and small memory footprint. Users should not make
|
|
assumption in the batch dimension.
|
|
|
|
EdgeBatch
|
|
---------
|
|
|
|
The class that can represent a batch of edges.
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
EdgeBatch.src
|
|
EdgeBatch.dst
|
|
EdgeBatch.data
|
|
EdgeBatch.edges
|
|
EdgeBatch.batch_size
|
|
EdgeBatch.__len__
|
|
|
|
NodeBatch
|
|
---------
|
|
|
|
The class that can represent a batch of nodes.
|
|
|
|
.. autosummary::
|
|
:toctree: ../../generated/
|
|
|
|
NodeBatch.data
|
|
NodeBatch.mailbox
|
|
NodeBatch.nodes
|
|
NodeBatch.batch_size
|
|
NodeBatch.__len__
|