From 6f880c06cefc1d177f9876c3b11bfc98432637e1 Mon Sep 17 00:00:00 2001 From: Muhammed Fatih Balin Date: Thu, 1 Feb 2024 09:08:29 +0300 Subject: [PATCH] Talk about `sampling_stages` in the SubgraphSampler API. --- python/dgl/graphbolt/subgraph_sampler.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/python/dgl/graphbolt/subgraph_sampler.py b/python/dgl/graphbolt/subgraph_sampler.py index 968af9775a04..d35dcb9aaff4 100644 --- a/python/dgl/graphbolt/subgraph_sampler.py +++ b/python/dgl/graphbolt/subgraph_sampler.py @@ -22,7 +22,10 @@ class SubgraphSampler(MiniBatchTransformer): Functional name: :obj:`sample_subgraph`. This class is the base class of all subgraph samplers. Any subclass of - SubgraphSampler should implement the :meth:`sample_subgraphs` method. + SubgraphSampler should implement either the :meth:`sample_subgraphs` method + or the :meth:`sampling_stages` method to define the fine-grained sampling + stages to take advantage of optimizations provided by the GraphBolt + DataLoader. Parameters ----------