📝 Added docstrings for StaticGraph

However, there are few methods yet to be documented. Kept them as TODO.

Author: nithinmanoj10

stgraph/graph/STGraphBase.py

@@ -11,15 +11,6 @@ class STGraphBase(ABC):
     Attributes
     ----------
 
-    _ndata : dict
-        Dictionary that stores node related data
-
-    _forward_graph
-        The forward graph object used for forward propagation
-
-    _backward_graph
-        The backward graph object used for backward propagation
-
     fwd_row_offset_ptr
         Pointer to the forward graphs row offset array
 

stgraph/graph/static/StaticGraph.py

@@ -12,37 +12,66 @@
 
 from stgraph.graph.static.csr import CSR
 
+
 class StaticGraph(STGraphBase):
-    def __init__(self, edge_list, edge_weights, num_nodes):    
+    r"""An abstract base class used to represent static graphs in STGraph.
+
+    This abstract class outlines the interface for defining a static graphs
+    used in STGraph. As of now the static graph is implemented using the
+    Compressed Sparse Row (CSR) format.
+
+    Example
+    -------
+
+    .. code-block:: python
+
+        from stgraph.graph import StaticGraph
+        from stgraph.dataset import HungaryCPDataLoader
+
+        hungary = HungaryCPDataLoader()
+
+        graph = StaticGraph(
+            edge_list = hungary.get_edges(),
+            edge_weights = hungary.get_edge_weights(),
+            num_nodes = hungary.gdata["num_nodes"]
+        )
+
+    """
+
+    def __init__(self, edge_list, edge_weights, num_nodes):
+        """An abstract base class used to represent static graphs in STGraph."""
         super().__init__()
         self._num_nodes = num_nodes
         self._num_edges = len(set(edge_list))
-        
-        # console.log("Building forward edge list")
+
         self._prepare_edge_lst_fwd(edge_list)
-        # console.log("Creating forward graph")
-        self._forward_graph = CSR(self.fwd_edge_list, edge_weights, self._num_nodes, is_edge_reverse=True)
-        
-        # console.log("Building backward edge list")
+        self._forward_graph = CSR(
+            self.fwd_edge_list, edge_weights, self._num_nodes, is_edge_reverse=True
+        )
+
         self._prepare_edge_lst_bwd(self.fwd_edge_list)
-        # console.log("Creating backward graph")
         self._backward_graph = CSR(self.bwd_edge_list, edge_weights, self._num_nodes)
-        
-        # console.log("Getting CSR ptrs")
+
         self._get_graph_csr_ptrs()
-    
-    def _prepare_edge_lst_fwd(self, edge_list):    
+
+    def _prepare_edge_lst_fwd(self, edge_list):
+        r"""TODO:"""
         edge_list_for_t = edge_list
-        edge_list_for_t.sort(key = lambda x: (x[1],x[0]))
-        edge_list_for_t = [(edge_list_for_t[j][0],edge_list_for_t[j][1],j) for j in range(len(edge_list_for_t))]
+        edge_list_for_t.sort(key=lambda x: (x[1], x[0]))
+        edge_list_for_t = [
+            (edge_list_for_t[j][0], edge_list_for_t[j][1], j)
+            for j in range(len(edge_list_for_t))
+        ]
         self.fwd_edge_list = edge_list_for_t
-    
-    def _prepare_edge_lst_bwd(self, edge_list):    
+
+    def _prepare_edge_lst_bwd(self, edge_list):
+        r"""TODO:"""
         edge_list_for_t = copy.deepcopy(edge_list)
         edge_list_for_t.sort()
         self.bwd_edge_list = edge_list_for_t
-        
+
     def _get_graph_csr_ptrs(self):
+        r"""TODO:"""
         self.fwd_row_offset_ptr = self._forward_graph.row_offset_ptr
         self.fwd_column_indices_ptr = self._forward_graph.column_indices_ptr
         self.fwd_eids_ptr = self._forward_graph.eids_ptr
@@ -52,31 +81,38 @@ def _get_graph_csr_ptrs(self):
         self.bwd_column_indices_ptr = self._backward_graph.column_indices_ptr
         self.bwd_eids_ptr = self._backward_graph.eids_ptr
         self.bwd_node_ids_ptr = self._backward_graph.node_ids_ptr
-            
+
     def get_num_nodes(self):
+        r"""Return the number of nodes in the static graph."""
         return self._num_nodes
-    
+
     def get_num_edges(self):
+        r"""Return the number of edges in the static graph."""
         return self._num_edges
-    
+
     def get_ndata(self, field):
+        r"""Returns the graph metadata."""
         if field in self._ndata:
             return self._ndata[field]
         else:
             return None
 
     def set_ndata(self, field, val):
+        r"""Sets the graph metadata."""
         self._ndata[field] = val
-        
+
     def graph_type(self):
-        # return "csr"
+        r"""Returns the graph type."""
         return "csr_unsorted"
-    
+
     def in_degrees(self):
-        return np.array(self._forward_graph.out_degrees, dtype='int32')
-    
+        r"""Returns the graph inwards node degree array."""
+        return np.array(self._forward_graph.out_degrees, dtype="int32")
+
     def out_degrees(self):
-        return np.array(self._forward_graph.in_degrees, dtype='int32')
-    
+        r"""Returns the graph outwards node degree array."""
+        return np.array(self._forward_graph.in_degrees, dtype="int32")
+
     def weighted_in_degrees(self):
-        return np.array(self._forward_graph.weighted_out_degrees, dtype='int32')
+        r"""TODO:"""
+        return np.array(self._forward_graph.weighted_out_degrees, dtype="int32")