[GraphBolt] Update the docstring of `ItemSet` (#6943)

80f36134 · Mingbang Wang · GitHub · 40816f6e · 80f36134
Unverified Commit 80f36134 authored Jan 16, 2024 by Mingbang Wang Committed by GitHub Jan 16, 2024
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 1 deletion

python/dgl/graphbolt/itemset.py python/dgl/graphbolt/itemset.py +4 -1

No files found.
--- a/python/dgl/graphbolt/itemset.py
+++ b/python/dgl/graphbolt/itemset.py
@@ -25,7 +25,10 @@ class ItemSet:
        items.
    names: Union[str, Tuple[str]], optional
        The names of the items. If it is a tuple, each name corresponds to an
-        item in the tuple.
+        item in the tuple. The naming is arbitrary, but in general practice,
+        the names should be chosen from ['seed_nodes', 'node_pairs', 'labels',
+        'negative_srcs', 'negative_dsts'] to align with the attributes of
+        class `dgl.graphbolt.MiniBatch`.
    Examples
    --------