Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
dgl.graphbolt.rst 1.25 KB
Newer Older
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24 
.. _apibackend:

🆕 dgl.graphbolt
=================================

.. currentmodule:: dgl.graphbolt

`dgl.graphbolt` is a dataloading framework for GNN that provides well-defined APIs for each stage of the data pipeline and multiple standard implementations.

APIs
-------------------------

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    Dataset
    Task
    ItemSet
    ItemSetDict
    ItemSampler
    NegativeSampler
    SubgraphSampler
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
25
26 
    SampledSubgraph
    exclude_edges
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
27 
    Feature
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
28
29 
    Feature.read
    Feature.update
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
30 
    FeatureStore
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
31
32 
    FeatureStore.read
    FeatureStore.update
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
33
34
35
36
37
38
39
40
41
42
43
44
45 
    FeatureFetcher
    CopyTo

DataLoaders
-----------

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    SingleProcessDataLoader
    MultiProcessDataLoader
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66 

Standard Implementations
-------------------------

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
    :template: classtemplate.rst

    OnDiskDataset
    OnDiskTask
    OnDiskMetaData
    CSCSamplingGraph
    UniformNegativeSampler
    NeighborSampler
    LayerNeighborSampler
    SampledSubgraphImpl
    BasicFeatureStore
    TorchBasedFeature
    TorchBasedFeatureStore
    GPUCachedFeature