README.md

### Structure of InteractivePlanGenFlow

```
               goal
                |
                |
                |
                v
        +------------------+                     
        |   PlanGenerator  |  Generates plan given goal. (https://huggingface.co/Tachi67/PlanGeneratorFlowModule)
        +------------------+                     
                |
                | (plan)
                |
                v
        +-------------------+
        |  PlanFileEdit     | Edit a temp file with the plan generated. (https://huggingface.co/Tachi67/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)
        +------------------+                     
                |                                
                | (plan, feedback)                      
                |                                
                v                                            
             plan, feedback     

```


# Table of Contents

* [InteractivePlanGenFlow](#InteractivePlanGenFlow)
  * [InteractivePlanGenFlow](#InteractivePlanGenFlow.InteractivePlanGenFlow)
* [\_\_init\_\_](#__init__)

<a id="InteractivePlanGenFlow"></a>

# InteractivePlanGenFlow

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

## InteractivePlanGenFlow Objects

```python
class InteractivePlanGenFlow(SequentialFlow)
```

This flow writes code in an interactive manner. It is a sequential flow composed of:
1. PlanGenerator: generates plan based on the goal.
2. PlanFileEditor: writes the generated plan to a temp file for the user to see, edit and provide feedback.
3. ParseFeedback: opens up the temp file with vscode and parses the feedback from the user.

*Input Interface*:
- `goal`
- `plan_file_location`

*Output Interface*:
- `plan`
- `feedback`
- `temp_plan_file_location`

<a id="__init__"></a>

# \_\_init\_\_