Skip to content

Commit 967ecb8

Browse files
hetong007HuXiangkunUbuntuclassicsong
authored
[Dataset] Fix the docstring format for dgl.data section (dmlc#1941)
* PPIDataset * Revert "PPIDataset" This reverts commit 264bd0c. * update data rst * update data doc and docstring * API doc rst for dataset * docstring * update api doc * add url format * update docstring * update citation graph * update knowledge graph * update gc datasets * fix index * Rst fix (dmlc#3) * Fix syntax * syntax * update docstring * update doc (dmlc#4) * final update * fix rdflib * fix rdf Co-authored-by: HuXiangkun <[email protected]> Co-authored-by: Ubuntu <[email protected]> Co-authored-by: xiang song(charlie.song) <[email protected]>
1 parent 3fa8d75 commit 967ecb8

20 files changed

+842
-477
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -160,3 +160,4 @@ cscope.*
160160

161161
config.cmake
162162
.ycm_extra_conf.py
163+
**.png

‎docs/source/api/python/data.rst

+102-34
Original file line numberDiff line numberDiff line change
@@ -5,115 +5,150 @@ dgl.data
55

66
.. currentmodule:: dgl.data
77

8-
Utils
9-
-----
8+
Dataset Classes
9+
---------------
1010

11-
.. autosummary::
12-
:toctree: ../../generated/
11+
DGL dataset
12+
```````````
1313

14-
utils.get_download_dir
15-
utils.download
16-
utils.check_sha1
17-
utils.extract_archive
18-
utils.split_dataset
19-
utils.save_graphs
20-
utils.load_graphs
21-
utils.load_labels
14+
.. autoclass:: DGLDataset
15+
:members: download, save, load, process, has_cache, __getitem__, __len__
2216

23-
.. autoclass:: dgl.data.utils.Subset
24-
:members: __getitem__, __len__
17+
DGL builtin dataset
18+
```````````````````
2519

26-
Dataset Classes
27-
---------------
20+
.. autoclass:: DGLBuiltinDataset
21+
:members: download
2822

2923
Stanford sentiment treebank dataset
3024
```````````````````````````````````
3125

3226
For more information about the dataset, see `Sentiment Analysis <https://nlp.stanford.edu/sentiment/index.html>`__.
3327

34-
.. autoclass:: SST
28+
.. autoclass:: SSTDataset
3529
:members: __getitem__, __len__
3630

3731

38-
Karate Club dataset
32+
Karate club dataset
3933
```````````````````````````````````
4034

41-
.. autoclass:: KarateClub
35+
.. autoclass:: KarateClubDataset
4236
:members: __getitem__, __len__
4337

4438

45-
Citation Network dataset
39+
Citation network dataset
4640
```````````````````````````````````
4741

48-
.. autoclass:: CitationGraphDataset
42+
.. autoclass:: CoraGraphDataset
43+
:members: __getitem__, __len__
44+
45+
.. autoclass:: CiteseerGraphDataset
4946
:members: __getitem__, __len__
5047

48+
.. autoclass:: PubmedGraphDataset
49+
:members: __getitem__, __len__
50+
51+
52+
Knowlege graph dataset
53+
```````````````````````````````````
54+
55+
.. autoclass:: FB15k237Dataset
56+
:members: __getitem__, __len__
57+
58+
.. autoclass:: FB15kDataset
59+
:members: __getitem__, __len__
60+
61+
.. autoclass:: WN18Dataset
62+
:members: __getitem__, __len__
63+
64+
65+
RDF datasets
66+
```````````````````````````````````
67+
68+
.. autoclass:: AIFBDataset
69+
:members: __getitem__, __len__
70+
71+
.. autoclass:: MUTAGDataset
72+
:members: __getitem__, __len__
73+
74+
.. autoclass:: BGSDataset
75+
:members: __getitem__, __len__
76+
77+
.. autoclass:: AMDataset
78+
:members: __getitem__, __len__
79+
80+
5181

5282
CoraFull dataset
5383
```````````````````````````````````
5484

55-
.. autoclass:: CoraFull
85+
.. autoclass:: CoraFullDataset
5686
:members: __getitem__, __len__
5787

5888

5989
Amazon Co-Purchase dataset
6090
```````````````````````````````````
6191

62-
.. autoclass:: AmazonCoBuy
92+
.. autoclass:: AmazonCoBuyComputerDataset
93+
:members: __getitem__, __len__
94+
95+
.. autoclass:: AmazonCoBuyPhotoDataset
6396
:members: __getitem__, __len__
6497

6598

6699
Coauthor dataset
67100
```````````````````````````````````
68101

69-
.. autoclass:: Coauthor
102+
.. autoclass:: CoauthorCSDataset
103+
:members: __getitem__, __len__
104+
105+
.. autoclass:: CoauthorPhysicsDataset
70106
:members: __getitem__, __len__
71107

72108

73109
BitcoinOTC dataset
74110
```````````````````````````````````
75111

76-
.. autoclass:: BitcoinOTC
112+
.. autoclass:: BitcoinOTCDataset
77113
:members: __getitem__, __len__
78114

79115

80116
ICEWS18 dataset
81117
```````````````````````````````````
82118

83-
.. autoclass:: ICEWS18
119+
.. autoclass:: ICEWS18Dataset
84120
:members: __getitem__, __len__
85121

86122

87123
QM7b dataset
88124
```````````````````````````````````
89125

90-
.. autoclass:: QM7b
126+
.. autoclass:: QM7bDataset
91127
:members: __getitem__, __len__
92128

93129

94130

95131
GDELT dataset
96132
```````````````````````````````````
97133

98-
.. autoclass:: GDELT
134+
.. autoclass:: GDELTDataset
99135
:members: __getitem__, __len__
100136

101137

102138
Mini graph classification dataset
103139
`````````````````````````````````
104140

105141
.. autoclass:: MiniGCDataset
106-
:members: __getitem__, __len__, num_classes
107-
108-
109-
Graph kernel dataset
110-
````````````````````
142+
:members: __getitem__, __len__
111143

112-
For more information about the dataset, see `Benchmark Data Sets for Graph Kernels <https://ls11-www.cs.tu-dortmund.de/staff/morris/graphkerneldatasets>`__.
144+
TU dataset
145+
``````````
113146

114147
.. autoclass:: TUDataset
115148
:members: __getitem__, __len__
116149

150+
.. autoclass:: LegacyTUDataset
151+
:members: __getitem__, __len__
117152

118153
Graph isomorphism network dataset
119154
```````````````````````````````````
@@ -129,3 +164,36 @@ Protein-Protein Interaction dataset
129164

130165
.. autoclass:: PPIDataset
131166
:members: __getitem__, __len__
167+
168+
169+
Reddit dataset
170+
``````````````
171+
172+
.. autoclass:: RedditDataset
173+
:members: __getitem__, __len__
174+
175+
176+
Symmetric Stochastic Block Model Mixture dataset
177+
````````````````````````````````````````````````
178+
179+
.. autoclass:: SBMMixtureDataset
180+
:members: __getitem__, __len__, collate_fn
181+
182+
Utils
183+
-----
184+
185+
.. autosummary::
186+
:toctree: ../../generated/
187+
188+
utils.get_download_dir
189+
utils.download
190+
utils.check_sha1
191+
utils.extract_archive
192+
utils.split_dataset
193+
utils.save_graphs
194+
utils.load_graphs
195+
utils.load_labels
196+
197+
.. autoclass:: dgl.data.utils.Subset
198+
:members: __getitem__, __len__
199+

‎python/dgl/data/__init__.py

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
from .qm7b import QM7b, QM7bDataset
2121
from .dgl_dataset import DGLDataset, DGLBuiltinDataset
2222
from .citation_graph import CoraGraphDataset, CiteseerGraphDataset, PubmedGraphDataset
23+
from .knowledge_graph import FB15k237Dataset, FB15kDataset, WN18Dataset
24+
from .rdf import AIFBDataset, MUTAGDataset, BGSDataset, AMDataset
2325

2426

2527
def register_data_args(parser):

‎python/dgl/data/bitcoinotc.py

+18-9
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ class BitcoinOTCDataset(DGLBuiltinDataset):
1818
a platform called Bitcoin OTC. Since Bitcoin users are anonymous,
1919
there is a need to maintain a record of users' reputation to prevent
2020
transactions with fraudulent and risky users.
21-
Offical website: https://snap.stanford.edu/data/soc-sign-bitcoin-otc.html
21+
22+
Offical website: `<https://snap.stanford.edu/data/soc-sign-bitcoin-otc.html>`_
2223
2324
Bitcoin OTC dataset statistics:
24-
Nodes: 5,881
25-
Edges: 35,592
26-
Range of edge weight: -10 to +10
27-
Percentage of positive edges: 89%
25+
26+
- Nodes: 5,881
27+
- Edges: 35,592
28+
- Range of edge weight: -10 to +10
29+
- Percentage of positive edges: 89%
2830
2931
Parameters
3032
----------
@@ -117,7 +119,12 @@ def graphs(self):
117119
return self._graphs
118120

119121
def __len__(self):
120-
r""" Number of graphs in the dataset """
122+
r""" Number of graphs in the dataset.
123+
124+
Return
125+
-------
126+
int
127+
"""
121128
return len(self.graphs)
122129

123130
def __getitem__(self, item):
@@ -130,9 +137,11 @@ def __getitem__(self, item):
130137
131138
Returns
132139
-------
133-
dgl.DGLGraph
134-
The graph contains the graph structure and edge weights
135-
- edata['h'] : edge weights
140+
:class:`dgl.DGLGraph`
141+
142+
The graph contains:
143+
144+
- ``edata['h']`` : edge weights
136145
"""
137146
return self.graphs[item]
138147

0 commit comments

Comments
 (0)