add more comments & docs; link change

NewPlanGenFlow.py

@@ -1,11 +1,33 @@
-import json
-from copy import deepcopy
-from typing import Any, Dict
 from flow_modules.aiflows.PlanGeneratorFlowModule import PlanGeneratorAtomicFlow
 
 
 class NewPlanGenFlow(PlanGeneratorAtomicFlow):
+    """
+    This flow module is responsible for generating a new plan based on the previous plan and the given requirements.
+    This flow is inherited from PlanGeneratorAtomicFlow. (https://huggingface.co/aiflows/PlanGeneratorFlowModule)
+
+    *Input Interface Non Initialized*:
+    - `goal`
+    - `old_plan`
+
+    *Input Interface Initialized*:
+    - `goal`
+    - `old_plan`
+
+    *Output Interface*:
+    - `new_plan`
+
+    *Configuration Parameters*:
+    - `system_message_prompt_template`: The template of the system message.
+    - `init_human_message_prompt_template`: The template of the init user message.
+    - `human_message_prompt_template`: The template of the user message.
+
+    """
     def __init__(self, **kwargs):
+        """
+        Initialization of the flow module.
+        :param kwargs: The configuration parameters of the flow module.
+        """
         super().__init__(**kwargs)
         self.hint_for_model = """
         Make sure your response is in the following format:

README.md

@@ -1,4 +1,21 @@
-### Structure of ReplanningFlow
+# Table of Contents
+
+* [Structure of ReplanningFlow](#Structure-of-ReplanningFlow)
+* [run\_replanning](#run_replanning)
+* [ReplanningAskUserFlow](#ReplanningAskUserFlow)
+  * [ReplanningAskUserFlow](#ReplanningAskUserFlow.ReplanningAskUserFlow)
+    * [run](#ReplanningAskUserFlow.ReplanningAskUserFlow.run)
+* [NewPlanGenFlow](#NewPlanGenFlow)
+  * [NewPlanGenFlow](#NewPlanGenFlow.NewPlanGenFlow)
+    * [\_\_init\_\_](#NewPlanGenFlow.NewPlanGenFlow.__init__)
+* [ReplanningFlow](#ReplanningFlow)
+  * [ReplanningFlow](#ReplanningFlow.ReplanningFlow)
+    * [detect\_finish\_or\_continue](#ReplanningFlow.ReplanningFlow.detect_finish_or_continue)
+* [\_\_init\_\_](#__init__)
+
+
+
+# Structure of ReplanningFlow
 
 ```
 goal (info on the old plan), plan (old plan), plan_file_location
@@ -39,23 +56,15 @@ write_plan                    ask_user
 ```
 
 About the branches:
-- [ask_user](https://huggingface.co/Tachi67/PlanWriterFlowModule/blob/main/PlanWriterAskUserFlow.py): Ask user for info / confirmation, etc.
-- [write_plan](https://huggingface.co/Tachi67/InteractivePlanGenFlowModule): Generates plan (user edit is allowed) and fetches user feedback.
-  - The PlanGenerator of write_plan is replaced with [NewPlanGenFlow](https://huggingface.co/Tachi67/ReplanningFlowModule/blob/main/NewPlanGenFlow.py) to re-plan instead of write plan.
+- [ask_user](https://huggingface.co/aiflows/PlanWriterFlowModule/blob/main/PlanWriterAskUserFlow.py): Ask user for info / confirmation, etc.
+- [write_plan](https://huggingface.co/aiflows/InteractivePlanGenFlowModule): Generates plan (user edit is allowed) and fetches user feedback.
+  - The PlanGenerator of write_plan is replaced with [NewPlanGenFlow](https://huggingface.co/aiflows/ReplanningFlowModule/blob/main/NewPlanGenFlow.py) to re-plan instead of write plan.
 
 How it works:
 Controller calls write_plan until user is satisfied in the feedback, finish.
 
 
-# Table of Contents
 
-* [run\_replanning](#run_replanning)
-* [ReplanningAskUserFlow](#ReplanningAskUserFlow)
-  * [ReplanningAskUserFlow](#ReplanningAskUserFlow.ReplanningAskUserFlow)
-* [NewPlanGenFlow](#NewPlanGenFlow)
-* [ReplanningFlow](#ReplanningFlow)
-  * [ReplanningFlow](#ReplanningFlow.ReplanningFlow)
-* [\_\_init\_\_](#__init__)
 
 <a id="run_replanning"></a>
 
@@ -73,12 +82,83 @@ Controller calls write_plan until user is satisfied in the feedback, finish.
 class ReplanningAskUserFlow(HumanStandardInputFlow)
 ```
 
-Refer to: https://huggingface.co/Tachi67/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py
+Refer to: https://huggingface.co/aiflows/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py
+
+*Input Interface*:
+- `question`
+
+*Output Interface*:
+- `feedback`
+- `new_plan`
+
+*Configuration Parameters*:
+- `request_multi_line_input_flag`: if True, the user can input multiple lines of text. Default: False
+- `end_of_input_string`: the string that the user can input to indicate that the input is finished. Default: EOI
+- `query_message_prompt_template`: the template of the message that is sent to the user to ask for input.
+
+<a id="ReplanningAskUserFlow.ReplanningAskUserFlow.run"></a>
+
+#### run
+
+```python
+def run(input_data: Dict[str, Any]) -> Dict[str, Any]
+```
+
+Run the flow module.
+
+**Arguments**:
+
+- `input_data`: the input data
+
+**Returns**:
+
+the output data
 
 <a id="NewPlanGenFlow"></a>
 
 # NewPlanGenFlow
 
+<a id="NewPlanGenFlow.NewPlanGenFlow"></a>
+
+## NewPlanGenFlow Objects
+
+```python
+class NewPlanGenFlow(PlanGeneratorAtomicFlow)
+```
+
+This flow module is responsible for generating a new plan based on the previous plan and the given requirements.
+This flow is inherited from PlanGeneratorAtomicFlow. (https://huggingface.co/aiflows/PlanGeneratorFlowModule)
+
+*Input Interface Non Initialized*:
+- `goal`
+- `old_plan`
+
+*Input Interface Initialized*:
+- `goal`
+- `old_plan`
+
+*Output Interface*:
+- `new_plan`
+
+*Configuration Parameters*:
+- `system_message_prompt_template`: The template of the system message.
+- `init_human_message_prompt_template`: The template of the init user message.
+- `human_message_prompt_template`: The template of the user message.
+
+<a id="NewPlanGenFlow.NewPlanGenFlow.__init__"></a>
+
+#### \_\_init\_\_
+
+```python
+def __init__(**kwargs)
+```
+
+Initialization of the flow module.
+
+**Arguments**:
+
+- `kwargs`: The configuration parameters of the flow module.
+
 <a id="ReplanningFlow"></a>
 
 # ReplanningFlow
@@ -105,6 +185,29 @@ This flow inherits from PlanWriterFlow.
 - `summary` (str): summary of the flow, will be written to the log file of the caller flow.
 - `result` (str): result of the flow, will be passed to the controller of the caller flow.
 
+<a id="ReplanningFlow.ReplanningFlow.detect_finish_or_continue"></a>
+
+#### detect\_finish\_or\_continue
+
+```python
+@CircularFlow.output_msg_payload_processor
+def detect_finish_or_continue(output_payload: Dict[str, Any],
+                              src_flow) -> Dict[str, Any]
+```
+
+This function is called when the replanning flow receives a message from the PlanGenerator.
+
+It checks the command in the message and decides whether to finish the flow or continue the flow.
+
+**Arguments**:
+
+- `output_payload`: the message received from the PlanGenerator
+- `src_flow`: the PlanGenerator
+
+**Returns**:
+
+the message to be sent to the controller of the caller flow
+
 <a id="__init__"></a>
 
 # \_\_init\_\_

ReplanningAskUserFlow.py

@@ -10,9 +10,27 @@ log = logging.get_logger(f"aiflows.{__name__}")
 
 
 class ReplanningAskUserFlow(HumanStandardInputFlow):
-    """Refer to: https://huggingface.co/Tachi67/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py"""
+    """Refer to: https://huggingface.co/aiflows/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py
+
+    *Input Interface*:
+    - `question`
+
+    *Output Interface*:
+    - `feedback`
+    - `new_plan`
+
+    *Configuration Parameters*:
+    - `request_multi_line_input_flag`: if True, the user can input multiple lines of text. Default: False
+    - `end_of_input_string`: the string that the user can input to indicate that the input is finished. Default: EOI
+    - `query_message_prompt_template`: the template of the message that is sent to the user to ask for input.
+
+    """
     def run(self,
             input_data: Dict[str, Any]) -> Dict[str, Any]:
+        """Run the flow module.
+        :param input_data: the input data
+        :return: the output data
+        """
 
         query_message = self._get_message(self.query_message_prompt_template, input_data)
         state_update_message = UpdateMessage_Generic(

ReplanningFlow.py

@@ -19,6 +19,7 @@ class ReplanningFlow(PlanWriterFlow):
     - `result` (str): result of the flow, will be passed to the controller of the caller flow.
     """
     def _on_reach_max_round(self):
+        """This function is called when the replanning flow reaches the maximum amount of rounds."""
         self._state_update_dict({
             "plan": "The maximum amount of rounds was reached before the model generated the plan.",
             "status": "unfinished",
@@ -28,6 +29,12 @@ class ReplanningFlow(PlanWriterFlow):
 
     @CircularFlow.output_msg_payload_processor
     def detect_finish_or_continue(self, output_payload: Dict[str, Any], src_flow) -> Dict[str, Any]:
+        """This function is called when the replanning flow receives a message from the PlanGenerator.
+        It checks the command in the message and decides whether to finish the flow or continue the flow.
+        :param output_payload: the message received from the PlanGenerator
+        :param src_flow: the PlanGenerator
+        :return: the message to be sent to the controller of the caller flow
+        """
         command = output_payload["command"]
         if command == "finish":
             # ~~~ fetch temp file location, plan content, memory file (of upper level flow e.g. ExtLib) from flow state

temp.md

@@ -0,0 +1,48 @@
+# Structure of ReplanningFlow
+
+```
+goal (info on the old plan), plan (old plan), plan_file_location
+                |
+                v
+        +---------------+
+        |  Controller   | --------<<<<-----------+
+        +---------------+                        |
+                |                                |
+                | (command, command args)        |
+                |                                |
+                v                                |
+        +------------------+                     |
+        |   Executor       |  Each branch is an  |
+        | (Tree Structure) |  executor           |
+        +------------------+                     |
+                |                                ^
+                | (summary)                      |
+                |                                |
+                v                                |             
+                |                                |
+                +-> goes back to the Controller>-+
+
+```
+
+Structure of the Executors:
+```
+         +-------------------+
+         |   Branching       |
+         |    Executor       |
+         +-------------------+
+        /                    \
+       /                      \
+      /                        \
+     /                          \
+write_plan                    ask_user
+
+```
+
+About the branches:
+- [ask_user](https://huggingface.co/aiflows/PlanWriterFlowModule/blob/main/PlanWriterAskUserFlow.py): Ask user for info / confirmation, etc.
+- [write_plan](https://huggingface.co/aiflows/InteractivePlanGenFlowModule): Generates plan (user edit is allowed) and fetches user feedback.
+  - The PlanGenerator of write_plan is replaced with [NewPlanGenFlow](https://huggingface.co/aiflows/ReplanningFlowModule/blob/main/NewPlanGenFlow.py) to re-plan instead of write plan.
+
+How it works:
+Controller calls write_plan until user is satisfied in the feedback, finish.
+