added functionality to not save graph attributes to rule trace making it more memory efficient

Author: dyumanaditya

pyreason/pyreason.py

@@ -29,6 +29,7 @@ def __init__(self):
         self.__memory_profile = False
         self.__reverse_digraph = False
         self.__atom_trace = False
+        self.__save_graph_attributes_to_trace = False
 
     @property
     def verbose(self) -> bool:
@@ -94,7 +95,16 @@ def atom_trace(self) -> bool:
 
         :return: bool
         """
-        return self.__atom_trace        
+        return self.__atom_trace   
+
+    @property
+    def save_graph_attributes_to_trace(self) -> bool:
+        """Returns whether to save the graph attribute facts to the rule trace. Graphs are large and turning this on can result in more memory usage.
+        NOTE: Turning this on may increase memory usage
+
+        :return: bool
+        """
+        return self.__save_graph_attributes_to_trace        
 
     @verbose.setter
     def verbose(self, value: bool) -> None:
@@ -137,7 +147,7 @@ def output_file_name(self, file_name: str) -> None:
     def graph_attribute_parsing(self, value: bool) -> None:
         """Whether to parse graphml file for attributes. Default is True
 
-        :param file_name: Whether to parse graphml or not
+        :param value: Whether to parse graphml or not
         :raises TypeError: If not bool raise error
         """
         if not isinstance(value, bool):
@@ -149,7 +159,7 @@ def graph_attribute_parsing(self, value: bool) -> None:
     def abort_on_inconsistency(self, value: bool) -> None:
         """Whether to abort program if inconsistency is found. Default is False
 
-        :param file_name: Whether to abort on inconsistency or not
+        :param value: Whether to abort on inconsistency or not
         :raises TypeError: If not bool raise error
         """
         if not isinstance(value, bool):
@@ -161,7 +171,7 @@ def abort_on_inconsistency(self, value: bool) -> None:
     def memory_profile(self, value: bool) -> None:
         """Whether to profile the program's memory usage. Default is False
 
-        :param file_name: Whether to profile program's memory usage or not
+        :param value: Whether to profile program's memory usage or not
         :raises TypeError: If not bool raise error
         """
         if not isinstance(value, bool):
@@ -174,7 +184,7 @@ def reverse_digraph(self, value: bool) -> None:
         """Whether to reverse the digraph. if the graphml contains an edge: a->b
         setting reverse as true will make the edge b->a. Default is False
 
-        :param file_name: Whether to reverse graphml edges or not
+        :param value: Whether to reverse graphml edges or not
         :raises TypeError: If not bool raise error
         """
         if not isinstance(value, bool):
@@ -187,13 +197,26 @@ def atom_trace(self, value: bool) -> None:
         """Whether to save all atoms that were responsible for the firing of a rule.
         NOTE: this can be very memory heavy. Default is False
 
-        :param file_name: Whether to save all atoms or not
+        :param value: Whether to save all atoms or not
         :raises TypeError: If not bool raise error
         """
         if not isinstance(value, bool):
             raise TypeError('value has to be a bool')
         else:
             self.__atom_trace = value
+    
+    @save_graph_attributes_to_trace.setter
+    def save_graph_attributes_to_trace(self, value: bool) -> None:
+        """Whether to save all graph attribute facts. Graphs are large so turning this on can be memory heavy
+        NOTE: this can be very memory heavy. Default is False
+
+        :param value: Whether to save all graph attribute facts in the trace or not
+        :raises TypeError: If not bool raise error
+        """
+        if not isinstance(value, bool):
+            raise TypeError('value has to be a bool')
+        else:
+            self.__save_graph_attributes_to_trace = value
 
 # VARIABLES
 __graph = None
@@ -339,7 +362,7 @@ def _reason(timesteps, convergence_threshold, convergence_bound_threshold):
     __edge_facts.extend(__non_fluent_graph_facts_edge)   
 
     # Setup logical program
-    program = Program(__graph, timesteps, __node_facts, __edge_facts, __rules, __ipl, settings.reverse_digraph, settings.atom_trace)
+    program = Program(__graph, timesteps, __node_facts, __edge_facts, __rules, __ipl, settings.reverse_digraph, settings.atom_trace, settings.save_graph_attributes_to_trace)
     program.available_labels_node = __node_labels
     program.available_labels_edge = __edge_labels
     program.specific_node_labels = __specific_node_labels

pyreason/scripts/args.py

@@ -38,6 +38,8 @@ def argparser():
     # Rule trace with ground atoms (not done)
     parser.add_argument("--atom_trace", dest='atom_trace', action='store_true', help='Option to track the ground atoms which lead to a rule firing. This could be very memory heavy. Default is off')
     parser.set_defaults(atom_trace=False)
+    parser.add_argument("--save_graph_attributes_to_trace", dest='save_graph_attributes_to_trace', action='store_true', help='Option to save graph attributes to trace. Graphs are big and turning this on can be very memory heavy. Graph attributes are represented as facts. Default is off')
+    parser.set_defaults(save_graph_attributes_to_trace=False)
     # Convergence options
     parser.add_argument("--convergence_threshold", type=int, default=-1, help='Number of interpretations that have changed between timesteps or fixed point operations until considered convergent. Program will end at convergence. -1 => Perfect convergence. This option is default')
     parser.add_argument("--convergence_bound_threshold", type=float, default=-1, help='Max change in any interpretation between timesteps or fixed point operations until considered convergent. Program will end at convergence. --convergence_threshold is default')

pyreason/scripts/diffuse.py

@@ -60,7 +60,7 @@ def main(args):
     ipl = yaml_parser.parse_ipl(args.ipl_yaml_path)
 
     # Program comes here
-    program = Program(graph, tmax, facts_node, facts_edge, rules, ipl, args.reverse_digraph, args.atom_trace)
+    program = Program(graph, tmax, facts_node, facts_edge, rules, ipl, args.reverse_digraph, args.atom_trace, args.save_graph_attributes_to_trace)
     program.available_labels_node = node_labels
     program.available_labels_edge = edge_labels
     program.specific_node_labels = specific_node_labels