README.md

# Table of Contents

* [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>

# PlanGeneratorAtomicFlow

<a id="PlanGeneratorAtomicFlow.PlanGeneratorAtomicFlow"></a>

## PlanGeneratorAtomicFlow Objects

```python
class PlanGeneratorAtomicFlow(ChatAtomicFlow)
```

This class wraps around the Chat API to generate plan from a goal.

*Input Interface Non Initialized*:
- `goal`

*Input Interface Initialized*:
- `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\_\_