add more docs & comments

InteractivePlanGenFlow.py

@@ -21,6 +21,14 @@ class InteractivePlanGenFlow(SequentialFlow):
     - `plan`
     - `feedback`
     - `temp_plan_file_location`
+
+    *Configuration Parameters*:
+    - `input_interface`: the input interface of the flow.
+    - `output_interface`: the output interface of the flow.
+    - `subflows_config`: the configuration of the subflows.
+    - `early_exit_key`: the key in the state dict that indicates whether the flow should exit early.
+    - `topology`: the topology of the subflows.
+
     """
     REQUIRED_KEYS_CONFIG = ["max_rounds", "early_exit_key", "topology"]
 
@@ -28,10 +36,22 @@ class InteractivePlanGenFlow(SequentialFlow):
             self,
             **kwargs
     ):
+        """
+        This function initializes the flow.
+        :param kwargs: the configuration of the flow.
+        :type kwargs: Dict[str, Any]
+        """
         super().__init__(**kwargs)
 
     @classmethod
     def instantiate_from_config(cls, config):
+        """
+        This function instantiates the flow from a configuration.
+        :param config: the configuration of the flow.
+        :type config: Dict[str, Any]
+        :return: the instantiated flow.
+        :rtype: InteractivePlanGenFlow
+        """
         flow_config = deepcopy(config)
 
         kwargs = {"flow_config": flow_config}
@@ -43,6 +63,13 @@ class InteractivePlanGenFlow(SequentialFlow):
         return cls(**kwargs)
 
     def run(self, input_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        This function runs the flow.
+        :param input_data: the input data of the flow.
+        :type input_data: Dict[str, Any]
+        :return: the output data of the flow.
+        :rtype: Dict[str, Any]
+        """
         # ~~~ sets the input_data in the flow_state dict ~~~
         self._state_update_dict(update_data=input_data)
 

README.md

@@ -1,4 +1,16 @@
-### Structure of InteractivePlanGenFlow
+# Table of Contents
+
+* [Structure of InteractivePlanGenFlow](#structure-of-interactiveplangenflow)
+* [run](#run)
+* [InteractivePlanGenFlow](#InteractivePlanGenFlow)
+  * [InteractivePlanGenFlow](#InteractivePlanGenFlow.InteractivePlanGenFlow)
+    * [\_\_init\_\_](#InteractivePlanGenFlow.InteractivePlanGenFlow.__init__)
+    * [instantiate\_from\_config](#InteractivePlanGenFlow.InteractivePlanGenFlow.instantiate_from_config)
+    * [run](#InteractivePlanGenFlow.InteractivePlanGenFlow.run)
+* [\_\_init\_\_](#__init__)
+
+
+# Structure of InteractivePlanGenFlow
 
 ```
                goal
@@ -7,21 +19,21 @@
                 |
                 v
         +------------------+                     
-        |   PlanGenerator  |  Generates plan given goal. (https://huggingface.co/Tachi67/PlanGeneratorFlowModule)
+        |   PlanGenerator  |  Generates plan given goal. (https://huggingface.co/aiflows/PlanGeneratorFlowModule)
         +------------------+                     
                 |
                 | (plan)
                 |
                 v
         +-------------------+
-        |  PlanFileEdit     | Edit a temp file with the plan generated. (https://huggingface.co/Tachi67/PlanFileEditFlowModule)
+        |  PlanFileEdit     | Edit a temp file with the plan generated. (https://huggingface.co/aiflows/PlanFileEditFlowModule)
         +-------------------+                        
                 |                                
                 |  (temp_plan_file_location)
                 |                                
                 v                                
         +------------------+                     
-        |   ParseFeedback  |  Opens up the temp file until user closes the file, parse for user feedback. (https://huggingface.co/Tachi67/ParseFeedbackFlowModule)
+        |   ParseFeedback  |  Opens up the temp file until user closes the file, parse for user feedback. (https://huggingface.co/aiflows/ParseFeedbackFlowModule)
         +------------------+                     
                 |                                
                 | (plan, feedback)                      
@@ -32,11 +44,10 @@
 ```
 
 
-# Table of Contents
 
-* [InteractivePlanGenFlow](#InteractivePlanGenFlow)
-  * [InteractivePlanGenFlow](#InteractivePlanGenFlow.InteractivePlanGenFlow)
-* [\_\_init\_\_](#__init__)
+<a id="run"></a>
+
+# run
 
 <a id="InteractivePlanGenFlow"></a>
 
@@ -64,6 +75,64 @@ This flow writes code in an interactive manner. It is a sequential flow composed
 - `feedback`
 - `temp_plan_file_location`
 
+*Configuration Parameters*:
+- `input_interface`: the input interface of the flow.
+- `output_interface`: the output interface of the flow.
+- `subflows_config`: the configuration of the subflows.
+- `early_exit_key`: the key in the state dict that indicates whether the flow should exit early.
+- `topology`: the topology of the subflows.
+
+<a id="InteractivePlanGenFlow.InteractivePlanGenFlow.__init__"></a>
+
+#### \_\_init\_\_
+
+```python
+def __init__(**kwargs)
+```
+
+This function initializes the flow.
+
+**Arguments**:
+
+- `kwargs` (`Dict[str, Any]`): the configuration of the flow.
+
+<a id="InteractivePlanGenFlow.InteractivePlanGenFlow.instantiate_from_config"></a>
+
+#### instantiate\_from\_config
+
+```python
+@classmethod
+def instantiate_from_config(cls, config)
+```
+
+This function instantiates the flow from a configuration.
+
+**Arguments**:
+
+- `config` (`Dict[str, Any]`): the configuration of the flow.
+
+**Returns**:
+
+`InteractivePlanGenFlow`: the instantiated flow.
+
+<a id="InteractivePlanGenFlow.InteractivePlanGenFlow.run"></a>
+
+#### run
+
+```python
+def run(input_data: Dict[str, Any]) -> Dict[str, Any]
+```
+
+This function runs the flow.
+
+**Arguments**:
+
+- `input_data` (`Dict[str, Any]`): the input data of the flow.
+
+**Returns**:
+
+`Dict[str, Any]`: the output data of the flow.
+
 <a id="__init__"></a>
 
 # \_\_init\_\_