[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]>
rxy007 · Aug 6, 2020 · 967ecb8 · 967ecb8
1 parent 3fa8d75
commit 967ecb8
Show file tree

Hide file tree

Showing 20 changed files with 842 additions and 477 deletions.
diff --git a/.gitignore b/.gitignore
@@ -160,3 +160,4 @@ cscope.*
 
 config.cmake
 .ycm_extra_conf.py
+**.png
diff --git a/docs/source/api/python/data.rst b/docs/source/api/python/data.rst
@@ -5,115 +5,150 @@ dgl.data
 
 .. currentmodule:: dgl.data
 
-Utils
------
+Dataset Classes
+---------------
 
-.. autosummary::
-    :toctree: ../../generated/
+DGL dataset
+```````````
 
-    utils.get_download_dir
-    utils.download
-    utils.check_sha1
-    utils.extract_archive
-    utils.split_dataset
-    utils.save_graphs
-    utils.load_graphs
-    utils.load_labels
+.. autoclass:: DGLDataset
+    :members: download, save, load, process, has_cache, __getitem__, __len__
 
-.. autoclass:: dgl.data.utils.Subset
-    :members: __getitem__, __len__
+DGL builtin dataset
+```````````````````
 
-Dataset Classes
----------------
+.. autoclass:: DGLBuiltinDataset
+    :members: download
 
 Stanford sentiment treebank dataset
 ```````````````````````````````````
 
 For more information about the dataset, see `Sentiment Analysis <https://nlp.stanford.edu/sentiment/index.html>`__.
 
-.. autoclass:: SST
+.. autoclass:: SSTDataset
     :members: __getitem__, __len__
 
 
-Karate Club dataset
+Karate club dataset
 ```````````````````````````````````
 
-.. autoclass:: KarateClub
+.. autoclass:: KarateClubDataset
     :members: __getitem__, __len__
 
 
-Citation Network dataset
+Citation network dataset
 ```````````````````````````````````
 
-.. autoclass:: CitationGraphDataset
+.. autoclass:: CoraGraphDataset
+    :members: __getitem__, __len__
+
+.. autoclass:: CiteseerGraphDataset
     :members: __getitem__, __len__
 
+.. 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__
+
+
 
 CoraFull dataset
 ```````````````````````````````````
 
-.. autoclass:: CoraFull
+.. autoclass:: CoraFullDataset
     :members: __getitem__, __len__
 
 
 Amazon Co-Purchase dataset
 ```````````````````````````````````
 
-.. autoclass:: AmazonCoBuy
+.. autoclass:: AmazonCoBuyComputerDataset
+    :members: __getitem__, __len__
+
+.. autoclass:: AmazonCoBuyPhotoDataset
     :members: __getitem__, __len__
 
 
 Coauthor dataset
 ```````````````````````````````````
 
-.. autoclass:: Coauthor
+.. autoclass:: CoauthorCSDataset
+    :members: __getitem__, __len__
+
+.. autoclass:: CoauthorPhysicsDataset
     :members: __getitem__, __len__
 
 
 BitcoinOTC dataset
 ```````````````````````````````````
 
-.. autoclass:: BitcoinOTC
+.. autoclass:: BitcoinOTCDataset
     :members: __getitem__, __len__
 
 
 ICEWS18 dataset
 ```````````````````````````````````
 
-.. autoclass:: ICEWS18
+.. autoclass:: ICEWS18Dataset
     :members: __getitem__, __len__
 
 
 QM7b dataset
 ```````````````````````````````````
 
-.. autoclass:: QM7b
+.. autoclass:: QM7bDataset
     :members: __getitem__, __len__
 
 
 
 GDELT dataset
 ```````````````````````````````````
 
-.. autoclass:: GDELT
+.. autoclass:: GDELTDataset
     :members: __getitem__, __len__
 
 
 Mini graph classification dataset
 `````````````````````````````````
 
 .. autoclass:: MiniGCDataset
-    :members: __getitem__, __len__, num_classes
-
-
-Graph kernel dataset
-````````````````````
+    :members: __getitem__, __len__
 
-For more information about the dataset, see `Benchmark Data Sets for Graph Kernels <https://ls11-www.cs.tu-dortmund.de/staff/morris/graphkerneldatasets>`__.
+TU dataset
+``````````
 
 .. autoclass:: TUDataset
     :members: __getitem__, __len__
 
+.. autoclass:: LegacyTUDataset
+    :members: __getitem__, __len__
 
 Graph isomorphism network dataset
 ```````````````````````````````````
@@ -129,3 +164,36 @@ Protein-Protein Interaction dataset
 
 .. autoclass:: PPIDataset
     :members: __getitem__, __len__
+
+
+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
+
+.. autoclass:: dgl.data.utils.Subset
+    :members: __getitem__, __len__
+
diff --git a/python/dgl/data/__init__.py b/python/dgl/data/__init__.py
@@ -20,6 +20,8 @@
 from .qm7b import QM7b, QM7bDataset
 from .dgl_dataset import DGLDataset, DGLBuiltinDataset
 from .citation_graph import CoraGraphDataset, CiteseerGraphDataset, PubmedGraphDataset
+from .knowledge_graph import FB15k237Dataset, FB15kDataset, WN18Dataset
+from .rdf import AIFBDataset, MUTAGDataset, BGSDataset, AMDataset
 
 
 def register_data_args(parser):

diff --git a/python/dgl/data/bitcoinotc.py b/python/dgl/data/bitcoinotc.py
@@ -18,13 +18,15 @@ class BitcoinOTCDataset(DGLBuiltinDataset):
     a platform called Bitcoin OTC. Since Bitcoin users are anonymous,
     there is a need to maintain a record of users' reputation to prevent
     transactions with fraudulent and risky users.
-    Offical website: https://snap.stanford.edu/data/soc-sign-bitcoin-otc.html
+
+    Offical website: `<https://snap.stanford.edu/data/soc-sign-bitcoin-otc.html>`_
 
     Bitcoin OTC dataset statistics:
-    Nodes: 5,881
-    Edges: 35,592
-    Range of edge weight: -10 to +10
-    Percentage of positive edges: 89%
+
+    - Nodes: 5,881
+    - Edges: 35,592
+    - Range of edge weight: -10 to +10
+    - Percentage of positive edges: 89%
 
     Parameters
     ----------
@@ -117,7 +119,12 @@ def graphs(self):
         return self._graphs
 
     def __len__(self):
-        r""" Number of graphs in the dataset """
+        r""" Number of graphs in the dataset.
+
+        Return
+        -------
+        int
+        """
         return len(self.graphs)
 
     def __getitem__(self, item):
@@ -130,9 +137,11 @@ def __getitem__(self, item):
 
         Returns
         -------
-        dgl.DGLGraph
-            The graph contains the graph structure and edge weights
-            - edata['h'] : edge weights
+        :class:`dgl.DGLGraph`
+
+            The graph contains:
+
+            - ``edata['h']`` : edge weights
         """
         return self.graphs[item]
Original file line number	Diff line number	Diff line change
Expand Up		@@ -160,3 +160,4 @@ cscope.*

		config.cmake
		.ycm_extra_conf.py
		**.png