diff --git a/docs/source/api/python/dgl.graphbolt.rst b/docs/source/api/python/dgl.graphbolt.rst index 0da3febc939a..9f2220f10d85 100644 --- a/docs/source/api/python/dgl.graphbolt.rst +++ b/docs/source/api/python/dgl.graphbolt.rst @@ -5,7 +5,7 @@ .. currentmodule:: dgl.graphbolt -**dgl.graphbolt** is a dataloading framework for GNN that provides well-defined +**dgl.graphbolt** is a dataloading framework for GNNs that provides well-defined APIs for each stage of the data pipeline and multiple standard implementations. Dataset @@ -55,6 +55,8 @@ collection of features. BasicFeatureStore TorchBasedFeature TorchBasedFeatureStore + DiskBasedFeature + CPUCachedFeature GPUCachedFeature diff --git a/python/dgl/graphbolt/impl/gpu_cached_feature.py b/python/dgl/graphbolt/impl/gpu_cached_feature.py index 7a86965e6888..d8fb36add1da 100644 --- a/python/dgl/graphbolt/impl/gpu_cached_feature.py +++ b/python/dgl/graphbolt/impl/gpu_cached_feature.py @@ -89,7 +89,7 @@ def read(self, ids: torch.Tensor = None): return values def read_async(self, ids: torch.Tensor): - """Read the feature by index asynchronously. + r"""Read the feature by index asynchronously. Parameters ---------- @@ -104,7 +104,7 @@ def read_async(self, ids: torch.Tensor): can be accessed by calling `.wait()`. on the returned future object. It is undefined behavior to call `.wait()` more than once. - Example Usage + Examples -------- >>> import dgl.graphbolt as gb >>> feature = gb.Feature(...)