[Doc] API doc string refactor for graphstorm.dataloading (#934)

*Issue #, if available:* *Description of changes:* This PR refactors the API doc string and the API reference rst pages for graphstorm.dataloading module. The rendered readthedoc pages are: 1. API reference index page: https://james4graphstorm.readthedocs.io/en/james_apidoc_dataloading/api/references/index.html 2. graphstorm.dataset and graphstorm.dataloading index page: https://james4graphstorm.readthedocs.io/en/james_apidoc_dataloading/api/references/graphstorm.dataloading.html All rst pages of classes under graphstorm.dataloading module are updated. Back compatibility breaking changes: 1. Rename the `pos_graph_feat_fields` with `pos_graph_edge_feat_fields` to make its meaning clearer. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice. --------- Co-authored-by: Ubuntu <[email protected]> Co-authored-by: Oxfordblue7 <[email protected]> Co-authored-by: xiang song(charlie.song) <[email protected]>
awslabs · Jul 30, 2024 · f4d5785 · f4d5785
1 parent 9e9ea2a
commit f4d5785
Show file tree

Hide file tree

Showing 8 changed files with 515 additions and 432 deletions.
diff --git a/docs/source/_templates/dataloadertemplate.rst b/docs/source/_templates/dataloadertemplate.rst
@@ -7,4 +7,6 @@
 
 .. autoclass:: {{ name }}
     :show-inheritance:
-    :special-members: __iter__, __next__
+    :members:
+    :member-order: bysource
+    :special-members: __iter__, __next__, __len__
diff --git a/docs/source/_templates/datasettemplate.rst b/docs/source/_templates/datasettemplate.rst
@@ -7,4 +7,5 @@
 
 .. autoclass:: {{ name }}
     :show-inheritance:
-    :members: prepare_data, get_node_feats, get_edge_feats, get_labels, get_node_feat_size
+    :members:
+    :member-order: bysource
diff --git a/docs/source/api/references/graphstorm.dataloading.rst b/docs/source/api/references/graphstorm.dataloading.rst
@@ -1,17 +1,34 @@
 .. _apidataloading:
 
-graphstorm.dataloading
-==========================
+graphstorm.dataloading.dataset
+===============================
 
-    GraphStorm dataloading module includes a set of graph DataSets and DataLoaders for different
-    graph machine learning tasks.
-
-    If users would like to customize DataLoaders, please extend those classes in the
-    :ref:`Base DataLoaders <basedataloaders>` section and customize their abstract methods.
+    GraphStorm dataset provides one unified dataset class, i.e., ``GSgnnData``, for all graph
+    machine learning tasks. Users can build a ``GSgnnData`` object by giving the path of
+    the JSON file created by the :ref:`GraphStorm Graph Construction<graph_construction>`
+    operations. The ``GSgnnData`` will load the related graph artifacts specified in the JSON
+    file. It provides a set of APIs for users to extract information of the graph data for
+    model training and inference.
 
 .. currentmodule:: graphstorm.dataloading
 
-.. _basedataloaders:
+.. autosummary::
+    :toctree: ../generated/
+    :nosignatures:
+    :template: datasettemplate.rst
+
+    GSgnnData
+
+graphstorm.dataloading.dataloading
+===================================
+
+    GraphStorm dataloading module includes a set of different DataLoaders for
+    different graph machine learning tasks.
+
+    If users would like to customize DataLoaders, please extend those dataloader base 
+    classes in the **Base DataLoaders** section and customize their abstract functions.
+
+.. currentmodule:: graphstorm.dataloading
 
 Base DataLoaders
 -------------------
@@ -25,16 +42,6 @@ Base DataLoaders
     GSgnnEdgeDataLoaderBase
     GSgnnLinkPredictionDataLoaderBase
 
-DataSets
-------------
-
-.. autosummary::
-    :toctree: ../generated/
-    :nosignatures:
-    :template: datasettemplate.rst
-
-    GSgnnData
-
 DataLoaders
 ------------
 
@@ -44,5 +51,8 @@ DataLoaders
     :template: dataloadertemplate.rst
 
     GSgnnNodeDataLoader
+    GSgnnNodeSemiSupDataLoader
     GSgnnEdgeDataLoader
     GSgnnLinkPredictionDataLoader
+    GSgnnLinkPredictionTestDataLoader
+    GSgnnLinkPredictionPredefinedTestDataLoader
diff --git a/docs/source/graph-construction/index.rst b/docs/source/graph-construction/index.rst
@@ -1,3 +1,5 @@
+.. _graph_construction:
+
 ==================
 Graph Construction
 ==================