dgl.data.rst 4.17 KB
Newer Older
Mufei Li's avatar
Mufei Li committed
1
2
.. _apidata:

3
4
dgl.data
=========
Mufei Li's avatar
Mufei Li committed
5
6

.. currentmodule:: dgl.data
7
.. automodule:: dgl.data
Mufei Li's avatar
Mufei Li committed
8

9
Quick links:
Mufei Li's avatar
Mufei Li committed
10

11
12
13
14
15
16
* `Node Prediction Datasets`_
* `Edge Prediction Datasets`_
* `Graph Prediction Datasets`_

Base Dataset Class
---------------------------
Mufei Li's avatar
Mufei Li committed
17

18
19
.. autoclass:: DGLDataset
    :members: download, save, load, process, has_cache, __getitem__, __len__
20

Mufei Li's avatar
Mufei Li committed
21

22
23
Node Prediction Datasets
---------------------------------------
Mufei Li's avatar
Mufei Li committed
24

25
DGL hosted datasets for node classification/regression tasks.
26

27
28
.. _sstdata:

Mufei Li's avatar
Mufei Li committed
29
30
Stanford sentiment treebank dataset
```````````````````````````````````
31
.. autoclass:: SSTDataset
32
33
    :members: __getitem__, __len__

34

35
.. _karateclubdata:
36

37
Karate club dataset
38
```````````````````````````````````
39
.. autoclass:: KarateClubDataset
40
41
    :members: __getitem__, __len__

42
.. _citationdata:
43

44
Citation network dataset
45
```````````````````````````````````
46
47
48
49
.. autoclass:: CoraGraphDataset
    :members: __getitem__, __len__

.. autoclass:: CiteseerGraphDataset
50
51
    :members: __getitem__, __len__

52
53
54
.. autoclass:: PubmedGraphDataset
    :members: __getitem__, __len__

55
.. _corafulldata:
56

57
CoraFull dataset
58
```````````````````````````````````
59
.. autoclass:: CoraFullDataset
60
61
    :members: __getitem__, __len__

62
.. _rdfdata:
63

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
RDF datasets
```````````````````````````````````

.. autoclass:: AIFBDataset
    :members: __getitem__, __len__

.. autoclass:: MUTAGDataset
    :members: __getitem__, __len__

.. autoclass:: BGSDataset
    :members: __getitem__, __len__

.. autoclass:: AMDataset
    :members: __getitem__, __len__

79
.. _amazoncobuydata:
80

81
82
Amazon Co-Purchase dataset
```````````````````````````````````
83
84
85
86
.. autoclass:: AmazonCoBuyComputerDataset
    :members: __getitem__, __len__

.. autoclass:: AmazonCoBuyPhotoDataset
87
88
    :members: __getitem__, __len__

89
.. _coauthordata:
90

91
92
Coauthor dataset
```````````````````````````````````
93
94
95
96
.. autoclass:: CoauthorCSDataset
    :members: __getitem__, __len__

.. autoclass:: CoauthorPhysicsDataset
97
98
    :members: __getitem__, __len__

99
.. _ppidata:
100

101
Protein-Protein Interaction dataset
102
```````````````````````````````````
103
104
.. autoclass:: PPIDataset
    :members: __getitem__, __len__
105

106
.. _redditdata:
107

108
109
110
Reddit dataset
``````````````
.. autoclass:: RedditDataset
111
112
    :members: __getitem__, __len__

113
.. _sbmdata:
114

115
116
117
118
Symmetric Stochastic Block Model Mixture dataset
````````````````````````````````````````````````
.. autoclass:: SBMMixtureDataset
    :members: __getitem__, __len__, collate_fn
119
120


121
122
Edge Prediction Datasets
---------------------------------------
123

124
DGL hosted datasets for edge classification/regression and link prediction tasks.
125

126
.. _kgdata:
127

128
Knowlege graph dataset
129
130
```````````````````````````````````

131
.. autoclass:: FB15k237Dataset
132
133
    :members: __getitem__, __len__

134
135
.. autoclass:: FB15kDataset
    :members: __getitem__, __len__
136

137
138
.. autoclass:: WN18Dataset
    :members: __getitem__, __len__
139

140
.. _bitcoinotcdata:
141

142
143
144
145
146
147
BitcoinOTC dataset
```````````````````````````````````
.. autoclass:: BitcoinOTCDataset
    :members: __getitem__, __len__

ICEWS18 dataset
148
```````````````````````````````````
149
150
.. autoclass:: ICEWS18Dataset
    :members: __getitem__, __len__
151

152
153
GDELT dataset
```````````````````````````````````
154
.. autoclass:: GDELTDataset
155
156
157
    :members: __getitem__, __len__


158
159
160
161
162
163
164
Graph Prediction Datasets
---------------------------------------

DGL hosted datasets for graph classification/regression tasks.


.. _qm7bdata:
165

166
167
168
169
170
171
172
QM7b dataset
```````````````````````````````````
.. autoclass:: QM7bDataset
    :members: __getitem__, __len__


.. _minigcdataset:
173

174
175
Mini graph classification dataset
`````````````````````````````````
176
.. autoclass:: MiniGCDataset
177
    :members: __getitem__, __len__
VoVAllen's avatar
VoVAllen committed
178

179
.. _tudata:
180

181
182
TU dataset
``````````
VoVAllen's avatar
VoVAllen committed
183
184
185
.. autoclass:: TUDataset
    :members: __getitem__, __len__

186
187
.. autoclass:: LegacyTUDataset
    :members: __getitem__, __len__
kitaev-chen's avatar
kitaev-chen committed
188

189
.. _gindataset:
190

kitaev-chen's avatar
kitaev-chen committed
191
192
Graph isomorphism network dataset
```````````````````````````````````
Mufei Li's avatar
Mufei Li committed
193

kitaev-chen's avatar
kitaev-chen committed
194
195
196
.. autoclass:: GINDataset
    :members: __getitem__, __len__

197
198
Utilities
-----------------
199
200
201
202
203
204
205
206
207
208

.. autosummary::
    :toctree: ../../generated/

    utils.get_download_dir
    utils.download
    utils.check_sha1
    utils.extract_archive
    utils.split_dataset
    utils.load_labels
209
210
    utils.save_info
    utils.load_info
211
212
213

.. autoclass:: dgl.data.utils.Subset
    :members: __getitem__, __len__