Skip to content

Commit

Permalink
[Doc] Fix the doc of NeighborSampler. (dmlc#1236)
Browse files Browse the repository at this point in the history
* fix.

* fix.
  • Loading branch information
zheng-da authored Jan 31, 2020
1 parent a9dabcc commit c167373
Showing 1 changed file with 1 addition and 7 deletions.
8 changes: 1 addition & 7 deletions python/dgl/contrib/sampling/sampler.py
Original file line number Diff line number Diff line change
Expand Up @@ -240,14 +240,8 @@ class NeighborSampler(NodeFlowSampler):
The DGLGraph where we sample NodeFlows.
batch_size : int
The batch size (i.e, the number of nodes in the last layer)
expand_factor : int, float, str
expand_factor : int
The number of neighbors sampled from the neighbor list of a vertex.
The value of this parameter can be:
* int: indicates the number of neighbors sampled from a neighbor list.
* float: indicates the ratio of the sampled neighbors in a neighbor list.
* str: indicates some common ways of calculating the number of sampled neighbors,
e.g., ``sqrt(deg)``.
Note that no matter how large the expand_factor, the max number of sampled neighbors
is the neighborhood size.
Expand Down

0 comments on commit c167373

Please sign in to comment.