Skip to content

GitLab

"git@developer.sourcefind.cn:OpenDAS/vision.git" did not exist on "43df72f1adf0e44e92b8ef498b101b11fc95708c"
Switch branch/tag
Find file Normal viewHistoryPermalink
dgl.data.rst 3.69 KB
Newer Older
Mufei Li's avatar
[Doc] data (#198)  
Mufei Li committed
1
2 
.. _apidata:
Minjie Wang's avatar
[Doc] Re-organize API docs and tutorials (#1222)  
Minjie Wang committed
3
4 
dgl.data
=========
Mufei Li's avatar
[Doc] data (#198)  
Mufei Li committed
5
6
7 

.. currentmodule:: dgl.data
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
8
9 
Dataset Classes
---------------
Mufei Li's avatar
[Doc] data (#198)  
Mufei Li committed
10
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
11
12 
DGL dataset
```````````
Mufei Li's avatar
[Doc] data (#198)  
Mufei Li committed
13
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
14
15 
.. autoclass:: DGLDataset
    :members: download, save, load, process, has_cache, __getitem__, __len__
Mufei Li's avatar
[Model Zoo] Refactor Model Zoo for Chemistry (#839)  
Mufei Li committed
16
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
17
18 
DGL builtin dataset
```````````````````
Mufei Li's avatar
[Doc] data (#198)  
Mufei Li committed
19
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
20
21 
.. autoclass:: DGLBuiltinDataset
    :members: download
Mufei Li's avatar
[Doc] data (#198)  
Mufei Li committed
22
23
24
25
26
27 

Stanford sentiment treebank dataset
```````````````````````````````````

For more information about the dataset, see `Sentiment Analysis <https://nlp.stanford.edu/sentiment/index.html>`__.
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
28 
.. autoclass:: SSTDataset
Minjie Wang's avatar
[Data] Synthetic dataset for graph classificaiton (#364)  
Minjie Wang committed
29
30 
    :members: __getitem__, __len__
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
31
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
32 
Karate club dataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
33
34 
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
35 
.. autoclass:: KarateClubDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
36
37
38 
    :members: __getitem__, __len__
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
39 
Citation network dataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
40
41 
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
42
43
44
45 
.. autoclass:: CoraGraphDataset
    :members: __getitem__, __len__

.. autoclass:: CiteseerGraphDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
46
47 
    :members: __getitem__, __len__
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80 
.. autoclass:: PubmedGraphDataset
    :members: __getitem__, __len__


Knowlege graph dataset
```````````````````````````````````

.. autoclass:: FB15k237Dataset
    :members: __getitem__, __len__

.. autoclass:: FB15kDataset
    :members: __getitem__, __len__

.. autoclass:: WN18Dataset
    :members: __getitem__, __len__


RDF datasets
```````````````````````````````````

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

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

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

.. autoclass:: AMDataset
    :members: __getitem__, __len__
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
81
82
83
84 

CoraFull dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
85 
.. autoclass:: CoraFullDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
86
87
88
89
90
91 
    :members: __getitem__, __len__


Amazon Co-Purchase dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
92
93
94
95 
.. autoclass:: AmazonCoBuyComputerDataset
    :members: __getitem__, __len__

.. autoclass:: AmazonCoBuyPhotoDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
96
97
98
99
100
101 
    :members: __getitem__, __len__


Coauthor dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
102
103
104
105 
.. autoclass:: CoauthorCSDataset
    :members: __getitem__, __len__

.. autoclass:: CoauthorPhysicsDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
106
107
108
109
110
111 
    :members: __getitem__, __len__


BitcoinOTC dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
112 
.. autoclass:: BitcoinOTCDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
113
114
115
116
117
118 
    :members: __getitem__, __len__


ICEWS18 dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
119 
.. autoclass:: ICEWS18Dataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
120
121
122
123
124
125 
    :members: __getitem__, __len__


QM7b dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
126 
.. autoclass:: QM7bDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
127
128
129
130
131
132
133 
    :members: __getitem__, __len__



GDELT dataset
```````````````````````````````````
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
134 
.. autoclass:: GDELTDataset
VoVAllen's avatar
[Dataset] Add CoraFull, Amazon, KarateClub, Coauthor Dataset (#855)  
VoVAllen committed
135
136
137 
    :members: __getitem__, __len__
Minjie Wang's avatar
[Data] Synthetic dataset for graph classificaiton (#364)  
Minjie Wang committed
138
139
140 
Mini graph classification dataset
`````````````````````````````````
Mufei Li's avatar
[Tutorial] Batched Graph Classification (#360)  
Mufei Li committed
141 
.. autoclass:: MiniGCDataset
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
142 
    :members: __getitem__, __len__
VoVAllen's avatar
[Dataset] Add TUDataset (#473)  
VoVAllen committed
143
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
144
145 
TU dataset
``````````
VoVAllen's avatar
[Dataset] Add TUDataset (#473)  
VoVAllen committed
146
147
148
149 

.. autoclass:: TUDataset
    :members: __getitem__, __len__
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
150
151 
.. autoclass:: LegacyTUDataset
    :members: __getitem__, __len__
kitaev-chen's avatar
[Model] Add GIN Model (#471)  
kitaev-chen committed
152
153
154
155
156
157
158
159
160
161 

Graph isomorphism network dataset
```````````````````````````````````

A compact subset of graph kernel dataset

.. autoclass:: GINDataset
    :members: __getitem__, __len__
Hao Zhang's avatar
[Model]PPI dataloader and inductive learning script. (#395)  
Hao Zhang committed
162
163
164
165
166 
Protein-Protein Interaction dataset
```````````````````````````````````

.. autoclass:: PPIDataset
    :members: __getitem__, __len__
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195 


Reddit dataset
``````````````

.. autoclass:: RedditDataset
    :members: __getitem__, __len__


Symmetric Stochastic Block Model Mixture dataset
````````````````````````````````````````````````

.. autoclass:: SBMMixtureDataset
    :members: __getitem__, __len__, collate_fn

Utils
-----

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

    utils.get_download_dir
    utils.download
    utils.check_sha1
    utils.extract_archive
    utils.split_dataset
    utils.save_graphs
    utils.load_graphs
    utils.load_labels
Xiangkun Hu's avatar
[Doc] Dataset api doc add save_info(), load_info() (#1954)  
Xiangkun Hu committed
196
197 
    utils.save_info
    utils.load_info
Tong He's avatar
[Dataset] Fix the docstring format for dgl.data section (#1941)  
Tong He committed
198
199
200
201 

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