Upload README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,36 @@
|
|
| 1 |
-
|
| 2 |
-
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Table of Contents
|
| 2 |
+
|
| 3 |
+
* [InteractivePlanGenFlow](#InteractivePlanGenFlow)
|
| 4 |
+
* [InteractivePlanGenFlow](#InteractivePlanGenFlow.InteractivePlanGenFlow)
|
| 5 |
+
* [\_\_init\_\_](#__init__)
|
| 6 |
+
|
| 7 |
+
<a id="InteractivePlanGenFlow"></a>
|
| 8 |
+
|
| 9 |
+
# InteractivePlanGenFlow
|
| 10 |
+
|
| 11 |
+
<a id="InteractivePlanGenFlow.InteractivePlanGenFlow"></a>
|
| 12 |
+
|
| 13 |
+
## InteractivePlanGenFlow Objects
|
| 14 |
+
|
| 15 |
+
```python
|
| 16 |
+
class InteractivePlanGenFlow(SequentialFlow)
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
This flow writes code in an interactive manner. It is a sequential flow composed of:
|
| 20 |
+
1. PlanGenerator: generates plan based on the goal.
|
| 21 |
+
2. PlanFileEditor: writes the generated plan to a temp file for the user to see, edit and provide feedback.
|
| 22 |
+
3. ParseFeedback: opens up the temp file with vscode and parses the feedback from the user.
|
| 23 |
+
|
| 24 |
+
*Input Interface*:
|
| 25 |
+
- `goal`
|
| 26 |
+
- `plan_file_location`
|
| 27 |
+
|
| 28 |
+
*Output Interface*:
|
| 29 |
+
- `plan`
|
| 30 |
+
- `feedback`
|
| 31 |
+
- `temp_plan_file_location`
|
| 32 |
+
|
| 33 |
+
<a id="__init__"></a>
|
| 34 |
+
|
| 35 |
+
# \_\_init\_\_
|
| 36 |
+
|