Skip to content

Commit

Permalink
Merge branch 'master' into datapipe
Browse files Browse the repository at this point in the history
  • Loading branch information
frozenbugs committed Aug 2, 2024
2 parents 96270e7 + f1c28d3 commit 865f073
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion docs/source/api/python/dgl.graphbolt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -55,6 +55,8 @@ collection of features.
BasicFeatureStore
TorchBasedFeature
TorchBasedFeatureStore
DiskBasedFeature
CPUCachedFeature
GPUCachedFeature


Expand Down
4 changes: 2 additions & 2 deletions python/dgl/graphbolt/impl/gpu_cached_feature.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------
Expand All @@ -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(...)
Expand Down

0 comments on commit 865f073

Please sign in to comment.