add docs and comments

PlanGeneratorAtomicFlow.py

@@ -14,8 +14,24 @@ class PlanGeneratorAtomicFlow(ChatAtomicFlow):
 
     *Output Interface*:
     - `plan`
+
+    *Configuration Parameters*:
+    - Also refer to ChatAtomicFlow (https://huggingface.co/aiflows/ChatFlowModule/blob/main/ChatAtomicFlow.py)
+    - `input_interface_non_initialized`: The input interface when the conversation is not initialized.
+    - `input_interface_initialized`: The input interface when the conversation is initialized.
+    - `output_interface`: The output interface.
+    - `backend`: The backend to use for the Chat API.
+    - `system_message_prompt_template`: The template for the system message prompt.
+    - `human_message_prompt_template`: The template for the human message prompt.
+    - `init_human_message_prompt_template`: The initial human message prompt.
+
     """
     def __init__(self, **kwargs):
+        """
+        This function instantiates the class.
+        :param kwargs: The configuration parameters.
+        :type kwargs: Dict[str, Any]
+        """
         super().__init__(**kwargs)
         self.hint_for_model = """
         Make sure your response is in the following format:
@@ -27,6 +43,13 @@ class PlanGeneratorAtomicFlow(ChatAtomicFlow):
 
     @classmethod
     def instantiate_from_config(cls, config):
+        """
+        This function instantiates the class from a configuration.
+        :param config: The configuration.
+        :type config: Dict[str, Any]
+        :return: The instantiated class.
+        :rtype: ChatAtomicFlow
+        """
         flow_config = deepcopy(config)
 
         kwargs = {"flow_config": flow_config}
@@ -41,10 +64,24 @@ class PlanGeneratorAtomicFlow(ChatAtomicFlow):
         return cls(**kwargs)
 
     def _update_prompts_and_input(self, input_data: Dict[str, Any]):
+        """
+        This function updates the prompts and input data.
+        :param input_data: The input data.
+        :type input_data: Dict[str, Any]
+        :return: None
+        :rtype: None
+        """
         if 'goal' in input_data:
             input_data['goal'] += self.hint_for_model
 
     def run(self, input_data: Dict[str, Any]) -> Dict[str, Any]:
+        """
+        This function runs the flow.
+        :param input_data: The input data.
+        :type input_data: Dict[str, Any]
+        :return: The output data.
+        :rtype: Dict[str, Any]
+        """
         self._update_prompts_and_input(input_data)
         while True:
             api_output = super().run(input_data)["api_output"].strip()

README.md

@@ -2,6 +2,10 @@
 
 * [PlanGeneratorAtomicFlow](#PlanGeneratorAtomicFlow)
   * [PlanGeneratorAtomicFlow](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow)
+    * [\_\_init\_\_](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.__init__)
+    * [instantiate\_from\_config](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.instantiate_from_config)
+    * [run](#PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.run)
+* [run](#run)
 * [\_\_init\_\_](#__init__)
 
 <a id="PlanGeneratorAtomicFlow"></a>
@@ -27,6 +31,71 @@ This class wraps around the Chat API to generate plan from a goal.
 *Output Interface*:
 - `plan`
 
+*Configuration Parameters*:
+- Also refer to ChatAtomicFlow (https://huggingface.co/aiflows/ChatFlowModule/blob/main/ChatAtomicFlow.py)
+- `input_interface_non_initialized`: The input interface when the conversation is not initialized.
+- `input_interface_initialized`: The input interface when the conversation is initialized.
+- `output_interface`: The output interface.
+- `backend`: The backend to use for the Chat API.
+- `system_message_prompt_template`: The template for the system message prompt.
+- `human_message_prompt_template`: The template for the human message prompt.
+- `init_human_message_prompt_template`: The initial human message prompt.
+
+<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.__init__"></a>
+
+#### \_\_init\_\_
+
+```python
+def __init__(**kwargs)
+```
+
+This function instantiates the class.
+
+**Arguments**:
+
+- `kwargs` (`Dict[str, Any]`): The configuration parameters.
+
+<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.instantiate_from_config"></a>
+
+#### instantiate\_from\_config
+
+```python
+@classmethod
+def instantiate_from_config(cls, config)
+```
+
+This function instantiates the class from a configuration.
+
+**Arguments**:
+
+- `config` (`Dict[str, Any]`): The configuration.
+
+**Returns**:
+
+`ChatAtomicFlow`: The instantiated class.
+
+<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow.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.
+
+**Returns**:
+
+`Dict[str, Any]`: The output data.
+
+<a id="run"></a>
+
+# run
+
 <a id="__init__"></a>
 
 # \_\_init\_\_