[Transform] [Doc] Rename transform to transforms and update doc (#3765)

* Update * Update * Update * Fix * Update * Update * Update * Fix
dmlc · Feb 24, 2022 · 6d9433b · 6d9433b
1 parent ccaa0bf
commit 6d9433b
Show file tree

Hide file tree

Showing 103 changed files with 659 additions and 1,618 deletions.
diff --git a/apps/kg/partition.py b/apps/kg/partition.py
@@ -97,7 +97,7 @@ def main():
 
     print('partition graph...')
 
-    part_dict = dgl.transform.metis_partition(g, num_parts, 1)
+    part_dict = dgl.transforms.metis_partition(g, num_parts, 1)
 
     tot_num_inner_edges = 0
     for part_id in part_dict:

diff --git a/benchmarks/benchmarks/api/bench_metis_partition.py b/benchmarks/benchmarks/api/bench_metis_partition.py
@@ -15,11 +15,11 @@ def track_time(graph_name, k):
     data = utils.process_data(graph_name)
     graph = data[0]
     # dry run
-    gg = dgl.transform.metis_partition(graph, k)
+    gg = dgl.transforms.metis_partition(graph, k)
 
     # timing
     with utils.Timer() as t:
         for i in range(3):
-            gg = dgl.transform.metis_partition(graph, k)
+            gg = dgl.transforms.metis_partition(graph, k)
 
-    return t.elapsed_secs / 3 
+    return t.elapsed_secs / 3
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -0,0 +1,23 @@
+.wy-table-responsive table td,
+.wy-table-responsive table th {
+  white-space: normal;
+}
+
+.wy-table-bordered-all,
+.rst-content table.docutils {
+  border: none;
+}
+
+.wy-table-bordered-all td,
+.rst-content table.docutils td {
+  border: none;
+}
+
+.wy-table td,
+.rst-content table.docutils td,
+.rst-content table.field-list td,
+.wy-table th,
+.rst-content table.docutils th,
+.rst-content table.field-list th {
+  padding: 14px;
+}
diff --git a/docs/source/_templates/classtemplate.rst b/docs/source/_templates/classtemplate.rst
@@ -0,0 +1,10 @@
+.. role:: hidden
+    :class: hidden-section
+.. currentmodule:: {{ module }}
+
+
+{{ name | underline}}
+
+.. autoclass:: {{ name }}
+    :show-inheritance:
+    :members: __getitem__, __len__, collate_fn, forward, reset_parameters, rel_emb, rel_project, explain_node, explain_graph
diff --git a/docs/source/api/python/dgl.data.rst b/docs/source/api/python/dgl.data.rst
@@ -6,252 +6,104 @@ dgl.data
 .. currentmodule:: dgl.data
 .. automodule:: dgl.data
 
-Quick links:
-
-* `Node Prediction Datasets`_
-* `Edge Prediction Datasets`_
-* `Graph Prediction Datasets`_
-
-Base Dataset Class
----------------------------
-
-.. autoclass:: DGLDataset
-    :members: download, save, load, process, has_cache, __getitem__, __len__
+Base Class
+---------------------------------------
 
-CSV Dataset Class
------------------
+.. autosummary::
+    :toctree: ../../generated/
+    :nosignatures:
+    :template: classtemplate.rst
 
-.. autoclass:: CSVDataset
+    DGLDataset
+    CSVDataset
 
 Node Prediction Datasets
 ---------------------------------------
 
-DGL hosted datasets for node classification/regression tasks.
-
-.. _sstdata:
-
-Stanford sentiment treebank dataset
-```````````````````````````````````
-.. autoclass:: SSTDataset
-    :members: __getitem__, __len__
-
-
-.. _karateclubdata:
-
-Karate club dataset
-```````````````````````````````````
-.. autoclass:: KarateClubDataset
-    :members: __getitem__, __len__
-
-.. _citationdata:
-
-Citation network dataset
-```````````````````````````````````
-.. autoclass:: CoraGraphDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: CiteseerGraphDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: PubmedGraphDataset
-    :members: __getitem__, __len__
-
-.. _corafulldata:
-
-CoraFull dataset
-```````````````````````````````````
-.. autoclass:: CoraFullDataset
-    :members: __getitem__, __len__
-
-.. _rdfdata:
-
-RDF datasets
-```````````````````````````````````
-
-.. autoclass:: AIFBDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: MUTAGDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: BGSDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: AMDataset
-    :members: __getitem__, __len__
-
-.. _amazoncobuydata:
-
-Amazon Co-Purchase dataset
-```````````````````````````````````
-.. autoclass:: AmazonCoBuyComputerDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: AmazonCoBuyPhotoDataset
-    :members: __getitem__, __len__
-
-.. _coauthordata:
-
-Coauthor dataset
-```````````````````````````````````
-.. autoclass:: CoauthorCSDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: CoauthorPhysicsDataset
-    :members: __getitem__, __len__
-
-.. _ppidata:
-
-Protein-Protein Interaction dataset
-```````````````````````````````````
-.. autoclass:: PPIDataset
-    :members: __getitem__, __len__
-
-.. _redditdata:
-
-Reddit dataset
-``````````````
-.. autoclass:: RedditDataset
-    :members: __getitem__, __len__
-
-.. _sbmdata:
-
-Symmetric Stochastic Block Model Mixture dataset
-````````````````````````````````````````````````
-.. autoclass:: SBMMixtureDataset
-    :members: __getitem__, __len__, collate_fn
-
-.. _frauddata:
-
-Fraud dataset
-``````````````
-.. autoclass:: FraudDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: FraudYelpDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: FraudAmazonDataset
-    :members: __getitem__, __len__
+Datasets for node classification/regression tasks
 
+.. autosummary::
+    :toctree: ../../generated/
+    :nosignatures:
+    :template: classtemplate.rst
+
+    SSTDataset
+    KarateClubDataset
+    CoraGraphDataset
+    CiteseerGraphDataset
+    PubmedGraphDataset
+    CoraFullDataset
+    AIFBDataset
+    MUTAGDataset
+    BGSDataset
+    AMDataset
+    AmazonCoBuyComputerDataset
+    AmazonCoBuyPhotoDataset
+    CoauthorCSDataset
+    CoauthorPhysicsDataset
+    PPIDataset
+    RedditDataset
+    SBMMixtureDataset
+    FraudDataset
+    FraudYelpDataset
+    FraudAmazonDataset
 
 Edge Prediction Datasets
 ---------------------------------------
 
-DGL hosted datasets for edge classification/regression and link prediction tasks.
-
-.. _kgdata:
-
-Knowlege graph dataset
-```````````````````````````````````
-
-.. autoclass:: FB15k237Dataset
-    :members: __getitem__, __len__
-
-.. autoclass:: FB15kDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: WN18Dataset
-    :members: __getitem__, __len__
-
-.. _bitcoinotcdata:
+Datasets for edge classification/regression and link prediction
 
-BitcoinOTC dataset
-```````````````````````````````````
-.. autoclass:: BitcoinOTCDataset
-    :members: __getitem__, __len__
-
-ICEWS18 dataset
-```````````````````````````````````
-.. autoclass:: ICEWS18Dataset
-    :members: __getitem__, __len__
-
-GDELT dataset
-```````````````````````````````````
-.. autoclass:: GDELTDataset
-    :members: __getitem__, __len__
+.. autosummary::
+    :toctree: ../../generated/
+    :nosignatures:
+    :template: classtemplate.rst
 
+    FB15k237Dataset
+    FB15kDataset
+    WN18Dataset
+    BitcoinOTCDataset
+    ICEWS18Dataset
+    GDELTDataset
 
 Graph Prediction Datasets
 ---------------------------------------
 
-DGL hosted datasets for graph classification/regression tasks.
-
-
-.. _qm7bdata:
-
-QM7b dataset
-```````````````````````````````````
-.. autoclass:: QM7bDataset
-    :members: __getitem__, __len__
-
-.. _qm9data:
-
-QM9 dataset
-```````````````````````````````````
-.. autoclass:: QM9Dataset
-    :members: __getitem__, __len__
+Datasets for graph classification/regression tasks
 
-.. _qm9edgedata:
-
-QM9Edge dataset
-```````````````````````````````````
-.. autoclass:: QM9EdgeDataset
-    :members: __getitem__, __len__
-
-.. _minigcdataset:
-
-Mini graph classification dataset
-`````````````````````````````````
-.. autoclass:: MiniGCDataset
-    :members: __getitem__, __len__
-
-.. _tudata:
-
-TU dataset
-``````````
-.. autoclass:: TUDataset
-    :members: __getitem__, __len__
-
-.. autoclass:: LegacyTUDataset
-    :members: __getitem__, __len__
-
-.. _gindataset:
-
-Graph isomorphism network dataset
-```````````````````````````````````
-
-.. autoclass:: GINDataset
-    :members: __getitem__, __len__
-
-.. _fakenewsdata:
-
-Fake news dataset
-```````````````````````````````````
-.. autoclass:: FakeNewsDataset
-    :members: __getitem__, __len__
+.. autosummary::
+    :toctree: ../../generated/
+    :nosignatures:
+    :template: classtemplate.rst
+
+    QM7bDataset
+    QM9Dataset
+    QM9EdgeDataset
+    MiniGCDataset
+    TUDataset
+    LegacyTUDataset
+    GINDataset
+    FakeNewsDataset
+    AsNodePredDataset
+    AsEdgePredDataset
 
 Dataset adapters
 -------------------
 
-Node prediction adapter
-```````````````````````
-
-.. autoclass:: AsNodePredDataset
-    :members: __getitem__, __len__
-
-Link prediction adapter
-```````````````````````
-
-.. autoclass:: AsLinkPredDataset
-    :members: __getitem__, __len__
+.. autosummary::
+    :toctree: ../../generated/
+    :nosignatures:
+    :template: classtemplate.rst
 
+    AsNodePredDataset
+    AsLinkPredDataset
 
 Utilities
 -----------------
 
 .. autosummary::
     :toctree: ../../generated/
+    :nosignatures:
+    :template: classtemplate.rst
 
     utils.get_download_dir
     utils.download
@@ -262,6 +114,4 @@ Utilities
     utils.save_info
     utils.load_info
     utils.add_nodepred_split
-
-.. autoclass:: dgl.data.utils.Subset
-    :members: __getitem__, __len__
+    utils.Subset
diff --git a/docs/source/api/python/index.rst b/docs/source/api/python/index.rst
@@ -15,4 +15,4 @@ API Reference
    dgl.sampling
    dgl.contrib.UnifiedTensor
    udf
-   transform
+   transforms