[Doc] update neighbor sampler doc. (dmlc#287)

locussam · Dec 11, 2018 · 18ed786 · 18ed786
1 parent 597ac7f
commit 18ed786
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/python/dgl/contrib/sampling/sampler.py b/python/dgl/contrib/sampling/sampler.py
@@ -130,8 +130,9 @@ def NeighborSampler(g, batch_size, expand_factor, num_hops=1,
     
     Returns
     -------
-    A subgraph loader that returns a list of batched subgraphs and a dictionary of
-        additional information about the subgraphs.
+    A subgraph iterator
+        The iterator returns a list of batched subgraphs and a dictionary of additional
+        information about the subgraphs.
     '''
     return NSSubgraphLoader(g, batch_size, expand_factor, num_hops, neighbor_type, node_prob,
                             seed_nodes, shuffle, num_workers, max_subgraph_size, return_seed_id)