Skip to content

GitLab

Unverified Commit 80f36134 authored by Mingbang Wang's avatar Mingbang Wang Committed by GitHub
Browse files

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

parent 40816f6e
Show whitespace changes
Inline Side-by-side
Showing with 4 additions and 1 deletion
python/dgl/graphbolt/itemset.py
View file @ 80f36134
...@@ -25,7 +25,10 @@ class ItemSet: ...@@ -25,7 +25,10 @@ class ItemSet:
items. items.
names: Union[str, Tuple[str]], optional names: Union[str, Tuple[str]], optional
The names of the items. If it is a tuple, each name corresponds to an 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 Examples
-------- --------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment