Unverified Commit 47898ab6 authored by Rhett Ying's avatar Rhett Ying Committed by GitHub
Browse files

[doc] add docstring for SubgraphSampler::_sample_subgraphs() (#6655)

parent 0a3f6116
...@@ -135,4 +135,20 @@ class SubgraphSampler(MiniBatchTransformer): ...@@ -135,4 +135,20 @@ class SubgraphSampler(MiniBatchTransformer):
) )
def _sample_subgraphs(self, seeds): def _sample_subgraphs(self, seeds):
"""Sample subgraphs from the given seeds.
Any subclass of SubgraphSampler should implement this method.
Parameters
----------
seeds : Union[torch.Tensor, Dict[str, torch.Tensor]]
The seed nodes.
Returns
-------
Union[torch.Tensor, Dict[str, torch.Tensor]]
The input nodes.
SampledSubgraph
The sampled subgraphs.
"""
raise NotImplementedError raise NotImplementedError
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