Skip to content

GitLab

Switch branch/tag
Find file Normal viewHistoryPermalink
dgl.graphbolt.rst 1.29 KB
Newer Older
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
1
2
3
4
5
6
7 
.. _apibackend:

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

.. currentmodule:: dgl.graphbolt
Rhett Ying's avatar
[GraphBolt][Doc] update top level APIs (#6415)  
Rhett Ying committed
8 
**dgl.graphbolt** is a dataloading framework for GNN that provides well-defined APIs for each stage of the data pipeline and multiple standard implementations.
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
9
10
11
12
13
14
15 

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

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
Rhett Ying's avatar
[GraphBolt][Doc] update examples and display methods on page (#6426)  
Rhett Ying committed
16 
    :template: graphbolt_classtemplate.rst
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
17
18
19
20
21
22 

    Dataset
    Task
    ItemSet
    ItemSetDict
    ItemSampler
Rhett Ying's avatar
[GraphBolt][Doc] update top level APIs (#6415)  
Rhett Ying committed
23 
    DistributedItemSampler
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
24
25 
    NegativeSampler
    SubgraphSampler
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
26 
    SampledSubgraph
Rhett Ying's avatar
[GraphBolt][Doc] update top level APIs (#6415)  
Rhett Ying committed
27
28
29
30
31 
    SamplingGraph
    MiniBatch
    MiniBatchTransformer
    DGLMiniBatch
    DGLMiniBatchConverter
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
32
33
34
35
36 
    Feature
    FeatureStore
    FeatureFetcher
    CopyTo
Rhett Ying's avatar
[GraphBolt][Doc] update top level APIs (#6415)  
Rhett Ying committed
37
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
38
39
40
41
42
43 
DataLoaders
-----------

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
Rhett Ying's avatar
[GraphBolt][Doc] update examples and display methods on page (#6426)  
Rhett Ying committed
44 
    :template: graphbolt_classtemplate.rst
Hongzhi (Steve), Chen's avatar
[Graphbolt] Introduce graphbolt doc. (#6292)  
Hongzhi (Steve), Chen committed
45
46
47 

    SingleProcessDataLoader
    MultiProcessDataLoader
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
48
49
50
51
52
53
54 

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

.. autosummary::
    :toctree: ../../generated/
    :nosignatures:
Rhett Ying's avatar
[GraphBolt][Doc] update examples and display methods on page (#6426)  
Rhett Ying committed
55 
    :template: graphbolt_classtemplate.rst
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
56
57 

    OnDiskDataset
Rhett Ying's avatar
[GraphBolt] add BuiltinDataset into doc page (#6355)  
Rhett Ying committed
58 
    BuiltinDataset
Hongzhi (Steve), Chen's avatar
[Graphbolt] Add more class and ops to graphbolt doc. (#6307)  
Hongzhi (Steve), Chen committed
59
60
61
62
63
64
65
66
67 
    CSCSamplingGraph
    UniformNegativeSampler
    NeighborSampler
    LayerNeighborSampler
    SampledSubgraphImpl
    BasicFeatureStore
    TorchBasedFeature
    TorchBasedFeatureStore
    GPUCachedFeature