File size: 8,413 Bytes
b367123
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
8c77957
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
### Structure of ExtendLibraryFlow

```
     goal, memory_files (dict)
             |
             v
    +-------------------+
    |  MemoryReading    |  Reads in the content of the memory files
    |    Flow           |
    +-------------------+
             |
             | (memory_content)
             |
             v
    +-------------------+
    |    PlanWriter     |  Writes a step-by-step plan to achieve the goal
    +-------------------+
             |
             | (plan)
             |
             v
    +-------------------+
    |   CtrlExMemFlow   |  Illustrated below. Carries out the plan in an controller-executor fashion,
    |                   |  with memory management mechanisms.
    +-------------------+
             |
    (summary, result)

```

Here is the structure of the `CtrlExMemFlow`:
```
    plan, memory_files, memory_content, goal
                |
                v
        +---------------+
        |  Controller   | --------<<<<-----------+
        +---------------+                        |
                |                                |
                | (command, command args)        |
                |                                |
                v                                |
        +------------------+                     |
        |   Executor       |  Each branch is an  |
        | (Tree Structure) |  executor           |
        +------------------+                     |
                |                                ^
                | (execution results)            ^
                |                                ^
                v                                ^
        +---------------+                        ^
        | MemWriteFlow  |  Updates memory files  ^
        +---------------+                        ^
                |                                ^
                | (summary)                      |
                |                                |
                v                                |
        +---------------+                        |
        | MemReadFlow   |  Reads updated memory  |
        +---------------+                        |
                |                                |
                | (updated memory content)       |
                |                                |
                +-> goes back to the Controller>-+

```
Structure of the Executors:
```
                 +-------------------+
                 |   Branching       |
                 |    Executor       |
                 +-------------------+
        /          |     |          |      \
       /           |     |          |       \
      /            |     |          |        \
     /             |     |          |         \
write_code    ask_user re_plan update_plan   save_code

```

Memory files of ExtendLibraryFlow:
- plan_extlib.txt
- logs_extlib.txt
- library.py

About the branches:
- [write_code](https://huggingface.co/Tachi67/CodeWriterFlowModule): Generates code in an interactive way, the user is able to edit or provide feedback during the process of writing code.
- [ask_user](https://huggingface.co/Tachi67/ExtendLibraryFlowModule/blob/main/ExtLibAskUserFlow.py): Ask user for info / confirmation, etc.
- [re_plan](https://huggingface.co/Tachi67/ReplanningFlowModule): One branch of the executors, when something goes wrong, re-draft the plan.
- [update_plan](https://huggingface.co/Tachi67/JarvisFlowModule/blob/main/UpdatePlanAtomicFlow.py): One branch of the executors, when the controller realizes that one (or some, depending on the LLM's response) step of the plan is (are) done, it generates a new plan that marks the step(s) as done.
- [save_code](https://huggingface.co/Tachi67/ExtendLibraryFlowModule/blob/main/SaveCodeAtomicFlow.py): Writes the wriiten & tested code to the code library.


# Table of Contents

* [SaveCodeAtomicFlow](#SaveCodeAtomicFlow)
  * [SaveCodeAtomicFlow](#SaveCodeAtomicFlow.SaveCodeAtomicFlow)
    * [run](#SaveCodeAtomicFlow.SaveCodeAtomicFlow.run)
* [ExtLibAskUserFlow](#ExtLibAskUserFlow)
  * [ExtLibAskUserFlow](#ExtLibAskUserFlow.ExtLibAskUserFlow)
* [ExtendLibraryFlow](#ExtendLibraryFlow)
  * [ExtendLibraryFlow](#ExtendLibraryFlow.ExtendLibraryFlow)
* [UpdatePlanAtomicFlow](#UpdatePlanAtomicFlow)
  * [UpdatePlanAtomicFlow](#UpdatePlanAtomicFlow.UpdatePlanAtomicFlow)
* [run\_ExtendLibrary](#run_ExtendLibrary)
* [CtrlExMem\_ExtLib](#CtrlExMem_ExtLib)
  * [CtrlExMem\_ExtLib](#CtrlExMem_ExtLib.CtrlExMem_ExtLib)
* [ControllerFlow\_ExtLib](#ControllerFlow_ExtLib)
  * [ControllerFlow\_ExtLib](#ControllerFlow_ExtLib.ControllerFlow_ExtLib)
* [\_\_init\_\_](#__init__)

<a id="SaveCodeAtomicFlow"></a>

# SaveCodeAtomicFlow

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

## SaveCodeAtomicFlow Objects

```python
class SaveCodeAtomicFlow(AtomicFlow)
```

This flow appends the code to the code library file.
*Input Interface*:
- `code` (str): the code to be appended to the code library
- `memory_files` (dict): the dictionary of memory files

*Output Interface*:
- `result` (str): the result of the flow, to be returned to the controller of the caller
- `summary` (str): the summary of the flow, to be appended to logs

<a id="SaveCodeAtomicFlow.SaveCodeAtomicFlow.run"></a>

#### run

```python
def run(input_data: Dict[str, Any])
```

Run the flow

**Arguments**:

- `input_data`: the input data

**Returns**:

the output data

<a id="ExtLibAskUserFlow"></a>

# ExtLibAskUserFlow

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

## ExtLibAskUserFlow Objects

```python
class ExtLibAskUserFlow(HumanStandardInputFlow)
```

This class is used to ask for user feedback whenever the controller is unsure of something, or need confirmation, etc.

*Expected Input*:
- `question`: The question asked by the controller

*Expected Behaviour*:
- The question is displayed, and the user gives feedback by inputing string.

*Expected Ouput*:
- `result`: The input of the user.
- `summary`: The summary that will be written by the caller.

<a id="ExtendLibraryFlow"></a>

# ExtendLibraryFlow

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

## ExtendLibraryFlow Objects

```python
class ExtendLibraryFlow(AbstractBossFlow)
```

ExtendLibraryFlow is one branch executor of CoderFlow. At a higher level, it takes the goal
from the Coder, writes functions in an interactive way, test the code and append the newly written function to
the code library.

Workflow of ExtendLibrary:
0. Coder calls ExtendLibrary with a goal.
1. MemoryReading reads logs, plan, and code library.
2. Planner makes a plan based on the goal.
3. Write code in an interactive fashion.
4. Test code.
5. Finish, writes code to the library.
Step 3-5 is done via prompting the controller.

*Input Interface (expected input)*
- `goal` (str): The goal from the caller (source flow, i.e. CoderFlow)
*Output Interface (expected output)*
- `result` (str): The result of the flow, the result will be returned to the caller (i.e. CoderFlow).
- `summary` (str): The summary of the flow, the summary will be logged into the logs of the caller flow (i.e. CoderFlow).

<a id="UpdatePlanAtomicFlow"></a>

# UpdatePlanAtomicFlow

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

## UpdatePlanAtomicFlow Objects

```python
class UpdatePlanAtomicFlow(AtomicFlow)
```

Refer to: https://huggingface.co/Tachi67/CoderFlowModule/blob/main/UpdatePlanAtomicFlow.py

<a id="run_ExtendLibrary"></a>

# run\_ExtendLibrary

<a id="CtrlExMem_ExtLib"></a>

# CtrlExMem\_ExtLib

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

## CtrlExMem\_ExtLib Objects

```python
class CtrlExMem_ExtLib(CtrlExMemFlow)
```

This class inherits from the CtrlExMemFlow class from AbstractBossFlowModule.
See: https://huggingface.co/Tachi67/AbstractBossFlowModule/blob/main/CtrlExMemFlow.py
*Input Interface*:
- `plan`
- `logs`
- `memory_files`
- `goal`
*Output Interface*
- `result` (str): The result of the flow, the result will be returned to the caller.
- `summary` (str): The summary of the flow, the summary will be logged into the logs of the caller flow.

<a id="ControllerFlow_ExtLib"></a>

# ControllerFlow\_ExtLib

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

## ControllerFlow\_ExtLib Objects

```python
class ControllerFlow_ExtLib(ChatAtomicFlow)
```

Refer to: https://huggingface.co/Tachi67/JarvisFlowModule/blob/main/Controller_JarvisFlow.py

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

# \_\_init\_\_