Skip to content

Latest commit

 

History

History
49 lines (36 loc) · 1.19 KB

udf.rst

File metadata and controls

49 lines (36 loc) · 1.19 KB
Raw

User-defined function related data structures

dgl.udf

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.

EdgeBatch.src EdgeBatch.dst EdgeBatch.data EdgeBatch.edges EdgeBatch.batch_size EdgeBatch.__len__

NodeBatch

The class that can represent a batch of nodes.

NodeBatch.data NodeBatch.mailbox NodeBatch.nodes NodeBatch.batch_size NodeBatch.__len__