cugraph_pyg.sampler.sampler.SampleIterator

class cugraph_pyg.sampler.sampler.SampleIterator(

data: Tuple[FeatureStore, GraphStore],

output_iter: Iterator[HeteroSamplerOutput | SamplerOutput],

)

Iterator that combines output graphs with their features to produce final output minibatches that can be fed into a GNN model.

__init__(

data: Tuple[FeatureStore, GraphStore],

output_iter: Iterator[HeteroSamplerOutput | SamplerOutput],

)

Constructs a new SampleIterator

Parameters:

data: Tuple[torch_geometric.data.FeatureStore, torch_geometric.data.GraphStore]

The original graph that samples were generated from, as a FeatureStore/GraphStore tuple.

output_iter: Iterator[Union[“torch_geometric.sampler.HeteroSamplerOutput”,

“torch_geometric.sampler.SamplerOutput”]]

An iterator over outputted sampling results.

Methods

__init__(data, output_iter)

Constructs a new SampleIterator