Fix discrepancy in dgl.dataloading.EdgeDataLoader (dmlc#2819)

* fix discrepancy * address comments
feixian15 · Apr 7, 2021 · 48b9ecd · 48b9ecd
1 parent 2afa359
commit 48b9ecd
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/python/dgl/dataloading/dataloader.py b/python/dgl/dataloading/dataloader.py
@@ -453,7 +453,11 @@ class EdgeCollator(Collator):
 
         If ``g_sampling`` is given, ``exclude`` is ignored and will be always ``None``.
     reverse_eids : Tensor or dict[etype, Tensor], optional
-        The mapping from original edge ID to its reverse edge ID.
+        A tensor of reverse edge ID mapping.  The i-th element indicates the ID of
+        the i-th edge's reverse edge.
+
+        If the graph is heterogeneous, this argument requires a dictionary of edge
+        types and the reverse edge ID mapping tensors.
 
         Required and only used when ``exclude`` is set to ``reverse_id``.
 

diff --git a/python/dgl/dataloading/pytorch/__init__.py b/python/dgl/dataloading/pytorch/__init__.py
@@ -317,8 +317,12 @@ class EdgeDataLoader:
 
         See the description of the argument with the same name in the docstring of
         :class:`~dgl.dataloading.EdgeCollator` for more details.
-    reverse_edge_ids : Tensor or dict[etype, Tensor], optional
-        The mapping from the original edge IDs to the ID of their reverse edges.
+    reverse_eids : Tensor or dict[etype, Tensor], optional
+        A tensor of reverse edge ID mapping.  The i-th element indicates the ID of
+        the i-th edge's reverse edge.
+
+        If the graph is heterogeneous, this argument requires a dictionary of edge
+        types and the reverse edge ID mapping tensors.
 
         See the description of the argument with the same name in the docstring of
         :class:`~dgl.dataloading.EdgeCollator` for more details.