dgl.data.rst 5.16 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
refine  
RhettYing committed
21
22
23
24
CSV Dataset Class
-----------------

.. autoclass:: CSVDataset
Mufei Li's avatar
Mufei Li committed
25

26
27
Node Prediction Datasets
---------------------------------------
Mufei Li's avatar
Mufei Li committed
28

29
DGL hosted datasets for node classification/regression tasks.
30

31
32
.. _sstdata:

Mufei Li's avatar
Mufei Li committed
33
34
Stanford sentiment treebank dataset
```````````````````````````````````
35
.. autoclass:: SSTDataset
36
37
    :members: __getitem__, __len__

38

39
.. _karateclubdata:
40

41
Karate club dataset
42
```````````````````````````````````
43
.. autoclass:: KarateClubDataset
44
45
    :members: __getitem__, __len__

46
.. _citationdata:
47

48
Citation network dataset
49
```````````````````````````````````
50
51
52
53
.. autoclass:: CoraGraphDataset
    :members: __getitem__, __len__

.. autoclass:: CiteseerGraphDataset
54
55
    :members: __getitem__, __len__

56
57
58
.. autoclass:: PubmedGraphDataset
    :members: __getitem__, __len__

59
.. _corafulldata:
60

61
CoraFull dataset
62
```````````````````````````````````
63
.. autoclass:: CoraFullDataset
64
65
    :members: __getitem__, __len__

66
.. _rdfdata:
67

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
RDF datasets
```````````````````````````````````

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

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

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

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

83
.. _amazoncobuydata:
84

85
86
Amazon Co-Purchase dataset
```````````````````````````````````
87
88
89
90
.. autoclass:: AmazonCoBuyComputerDataset
    :members: __getitem__, __len__

.. autoclass:: AmazonCoBuyPhotoDataset
91
92
    :members: __getitem__, __len__

93
.. _coauthordata:
94

95
96
Coauthor dataset
```````````````````````````````````
97
98
99
100
.. autoclass:: CoauthorCSDataset
    :members: __getitem__, __len__

.. autoclass:: CoauthorPhysicsDataset
101
102
    :members: __getitem__, __len__

103
.. _ppidata:
104

105
Protein-Protein Interaction dataset
106
```````````````````````````````````
107
108
.. autoclass:: PPIDataset
    :members: __getitem__, __len__
109

110
.. _redditdata:
111

112
113
114
Reddit dataset
``````````````
.. autoclass:: RedditDataset
115
116
    :members: __getitem__, __len__

117
.. _sbmdata:
118

119
120
121
122
Symmetric Stochastic Block Model Mixture dataset
````````````````````````````````````````````````
.. autoclass:: SBMMixtureDataset
    :members: __getitem__, __len__, collate_fn
123

124
125
126
127
128
129
130
131
132
133
134
135
136
.. _frauddata:

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

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

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

137

138
139
Edge Prediction Datasets
---------------------------------------
140

141
DGL hosted datasets for edge classification/regression and link prediction tasks.
142

143
.. _kgdata:
144

145
Knowlege graph dataset
146
147
```````````````````````````````````

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

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

154
155
.. autoclass:: WN18Dataset
    :members: __getitem__, __len__
156

157
.. _bitcoinotcdata:
158

159
160
161
162
163
164
BitcoinOTC dataset
```````````````````````````````````
.. autoclass:: BitcoinOTCDataset
    :members: __getitem__, __len__

ICEWS18 dataset
165
```````````````````````````````````
166
167
.. autoclass:: ICEWS18Dataset
    :members: __getitem__, __len__
168

169
170
GDELT dataset
```````````````````````````````````
171
.. autoclass:: GDELTDataset
172
173
174
    :members: __getitem__, __len__


175
176
177
178
179
180
181
Graph Prediction Datasets
---------------------------------------

DGL hosted datasets for graph classification/regression tasks.


.. _qm7bdata:
182

183
184
185
186
187
QM7b dataset
```````````````````````````````````
.. autoclass:: QM7bDataset
    :members: __getitem__, __len__

xnouhz's avatar
xnouhz committed
188
189
190
191
192
193
.. _qm9data:

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

195
196
197
198
199
200
201
.. _qm9edgedata:

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

202
.. _minigcdataset:
203

204
205
Mini graph classification dataset
`````````````````````````````````
206
.. autoclass:: MiniGCDataset
207
    :members: __getitem__, __len__
VoVAllen's avatar
VoVAllen committed
208

209
.. _tudata:
210

211
212
TU dataset
``````````
VoVAllen's avatar
VoVAllen committed
213
214
215
.. autoclass:: TUDataset
    :members: __getitem__, __len__

216
217
.. autoclass:: LegacyTUDataset
    :members: __getitem__, __len__
kitaev-chen's avatar
kitaev-chen committed
218

219
.. _gindataset:
220

kitaev-chen's avatar
kitaev-chen committed
221
222
Graph isomorphism network dataset
```````````````````````````````````
Mufei Li's avatar
Mufei Li committed
223

kitaev-chen's avatar
kitaev-chen committed
224
225
226
.. autoclass:: GINDataset
    :members: __getitem__, __len__

227
228
229
230
231
232
233
.. _fakenewsdata:

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

234
Dataset adapters
235
-------------------
236

237
238
239
Node prediction adapter
```````````````````````

240
241
242
.. autoclass:: AsNodePredDataset
    :members: __getitem__, __len__

243
244
Link prediction adapter
```````````````````````
245

246
.. autoclass:: AsLinkPredDataset
247
248
249
    :members: __getitem__, __len__


250
251
Utilities
-----------------
252
253
254
255
256
257
258
259
260
261

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

    utils.get_download_dir
    utils.download
    utils.check_sha1
    utils.extract_archive
    utils.split_dataset
    utils.load_labels
262
263
    utils.save_info
    utils.load_info
264
    utils.add_nodepred_split
265
266
267

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