dgl.data.rst 5.05 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

RhettYing's avatar
RhettYing committed
21
.. autoclass:: DGLCSVDataset
Mufei Li's avatar
Mufei Li committed
22

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

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

28
29
.. _sstdata:

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

35

36
.. _karateclubdata:
37

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

43
.. _citationdata:
44

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

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

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

56
.. _corafulldata:
57

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

63
.. _rdfdata:
64

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

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

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

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

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

80
.. _amazoncobuydata:
81

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

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

90
.. _coauthordata:
91

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

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

100
.. _ppidata:
101

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

107
.. _redditdata:
108

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

114
.. _sbmdata:
115

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

121
122
123
124
125
126
127
128
129
130
131
132
133
.. _frauddata:

Fraud dataset
``````````````
.. autoclass:: FraudDataset
    :members: __getitem__, __len__

.. autoclass:: FraudYelpDataset
    :members: __getitem__, __len__

.. autoclass:: FraudAmazonDataset
    :members: __getitem__, __len__

134

135
136
Edge Prediction Datasets
---------------------------------------
137

138
DGL hosted datasets for edge classification/regression and link prediction tasks.
139

140
.. _kgdata:
141

142
Knowlege graph dataset
143
144
```````````````````````````````````

145
.. autoclass:: FB15k237Dataset
146
147
    :members: __getitem__, __len__

148
149
.. autoclass:: FB15kDataset
    :members: __getitem__, __len__
150

151
152
.. autoclass:: WN18Dataset
    :members: __getitem__, __len__
153

154
.. _bitcoinotcdata:
155

156
157
158
159
160
161
BitcoinOTC dataset
```````````````````````````````````
.. autoclass:: BitcoinOTCDataset
    :members: __getitem__, __len__

ICEWS18 dataset
162
```````````````````````````````````
163
164
.. autoclass:: ICEWS18Dataset
    :members: __getitem__, __len__
165

166
167
GDELT dataset
```````````````````````````````````
168
.. autoclass:: GDELTDataset
169
170
171
    :members: __getitem__, __len__


172
173
174
175
176
177
178
Graph Prediction Datasets
---------------------------------------

DGL hosted datasets for graph classification/regression tasks.


.. _qm7bdata:
179

180
181
182
183
184
QM7b dataset
```````````````````````````````````
.. autoclass:: QM7bDataset
    :members: __getitem__, __len__

xnouhz's avatar
xnouhz committed
185
186
187
188
189
190
.. _qm9data:

QM9 dataset
```````````````````````````````````
.. autoclass:: QM9Dataset
    :members: __getitem__, __len__
191

192
193
194
195
196
197
198
.. _qm9edgedata:

QM9Edge dataset
```````````````````````````````````
.. autoclass:: QM9EdgeDataset
    :members: __getitem__, __len__

199
.. _minigcdataset:
200

201
202
Mini graph classification dataset
`````````````````````````````````
203
.. autoclass:: MiniGCDataset
204
    :members: __getitem__, __len__
VoVAllen's avatar
VoVAllen committed
205

206
.. _tudata:
207

208
209
TU dataset
``````````
VoVAllen's avatar
VoVAllen committed
210
211
212
.. autoclass:: TUDataset
    :members: __getitem__, __len__

213
214
.. autoclass:: LegacyTUDataset
    :members: __getitem__, __len__
kitaev-chen's avatar
kitaev-chen committed
215

216
.. _gindataset:
217

kitaev-chen's avatar
kitaev-chen committed
218
219
Graph isomorphism network dataset
```````````````````````````````````
Mufei Li's avatar
Mufei Li committed
220

kitaev-chen's avatar
kitaev-chen committed
221
222
223
.. autoclass:: GINDataset
    :members: __getitem__, __len__

224
225
226
227
228
229
230
.. _fakenewsdata:

Fake news dataset
```````````````````````````````````
.. autoclass:: FakeNewsDataset
    :members: __getitem__, __len__

231
232
233
234
235
236
237
Dataset adapters
```````````````````````````````````

.. autoclass:: AsNodePredDataset
    :members: __getitem__, __len__


238
239
240
241
.. autoclass:: AsEdgePredDataset
    :members: __getitem__, __len__


242
243
Utilities
-----------------
244
245
246
247
248
249
250
251
252
253

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

    utils.get_download_dir
    utils.download
    utils.check_sha1
    utils.extract_archive
    utils.split_dataset
    utils.load_labels
254
255
    utils.save_info
    utils.load_info
256
    utils.add_nodepred_split
257
258
259

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