File size: 8,210 Bytes
8ef71f8 902eb59 8ef71f8 3ce7d7b 8ef71f8 81f100e |
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 |
### Structure of Coder
```
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 |
+-------------------+
/ | | | \
/ | | | \
/ | | | \
/ | | | \
Extend_library ask_user re_plan update_plan run_code
```
Memory files of Coder:
- plan_coder.txt
- logs_coder.txt
- library.py
About the branches:
- [ExtendLibrary](https://huggingface.co/Tachi67/ExtendLibraryFlowModule): Writes and tests code functions in an interactive fashion, finally saves the written function to the code library.
- [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.
- [run_code](https://huggingface.co/Tachi67/RunCodeFlowModule): Runs the code written by the Controller, will first open up a temp file with the code for user confirmation and editing, then the code is passed to the [InterpreterFlow](https://huggingface.co/Tachi67/InterpreterFlowModule).
# Table of Contents
* [CtrlExMem\_CoderFlow](#CtrlExMem_CoderFlow)
* [CtrlExMem\_CoderFlow](#CtrlExMem_CoderFlow.CtrlExMem_CoderFlow)
* [run\_coder](#run_coder)
* [Planner\_CoderFlow](#Planner_CoderFlow)
* [Planner\_CoderFlow](#Planner_CoderFlow.Planner_CoderFlow)
* [Controller\_CoderFlow](#Controller_CoderFlow)
* [Controller\_CoderFlow](#Controller_CoderFlow.Controller_CoderFlow)
* [UpdatePlanAtomicFlow](#UpdatePlanAtomicFlow)
* [UpdatePlanAtomicFlow](#UpdatePlanAtomicFlow.UpdatePlanAtomicFlow)
* [CoderFlow](#CoderFlow)
* [CoderFlow](#CoderFlow.CoderFlow)
* [run](#CoderFlow.CoderFlow.run)
* [\_\_init\_\_](#__init__)
<a id="CtrlExMem_CoderFlow"></a>
# CtrlExMem\_CoderFlow
<a id="CtrlExMem_CoderFlow.CtrlExMem_CoderFlow"></a>
## CtrlExMem\_CoderFlow Objects
```python
class CtrlExMem_CoderFlow(CtrlExMemFlow)
```
This class inherits from the CtrlExMemFlow class from AbstractBossFlowModule.
See: https://huggingface.co/Tachi67/AbstractBossFlowModule/blob/main/CtrlExMemFlow.py
*Input Interface*:
- `plan`
- `logs`
- `code_library`: the signatures and docstring of the functions in the code library.
- `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="run_coder"></a>
# run\_coder
<a id="Planner_CoderFlow"></a>
# Planner\_CoderFlow
<a id="Planner_CoderFlow.Planner_CoderFlow"></a>
## Planner\_CoderFlow Objects
```python
class Planner_CoderFlow(PlanWriterFlow)
```
Planner of the coder flow, it inherits from PlanWriterFlow, see: https://huggingface.co/Tachi67/PlanWriterFlowModule
<a id="Controller_CoderFlow"></a>
# Controller\_CoderFlow
<a id="Controller_CoderFlow.Controller_CoderFlow"></a>
## Controller\_CoderFlow Objects
```python
class Controller_CoderFlow(ChatAtomicFlow)
```
Refer to: https://huggingface.co/Tachi67/JarvisFlowModule/blob/main/Controller_JarvisFlow.py
<a id="UpdatePlanAtomicFlow"></a>
# UpdatePlanAtomicFlow
<a id="UpdatePlanAtomicFlow.UpdatePlanAtomicFlow"></a>
## UpdatePlanAtomicFlow Objects
```python
class UpdatePlanAtomicFlow(AtomicFlow)
```
This flow updates the plan file with the updated plan. The controller should pass the updated plan to this flow.
This design (controller reflect on the existing plan--update plan) is intended to let the controller more aware of the
plan it has. However one setback is that this process in then not deterministic.
*Input Interface*
- `updated_plan`: the updated plan in string format
*Output Interface*
- `result`: the result of the update plan operation
<a id="CoderFlow"></a>
# CoderFlow
<a id="CoderFlow.CoderFlow"></a>
## CoderFlow Objects
```python
class CoderFlow(AbstractBossFlow)
```
Coder flow is one executor branch of the Jarvis flow. At a higher level, it is a flow that
writes and runs code given a goal. In the Jarvis flow, the Coder flow in invoked by the controller,
The Coder flow receives the goal generated by the controller, writes and runs code in an interactive fashion.
The Coder flow has the similar structure as the Jarvis flow (inherited from AbstractBossFlow).
*Input Interface (expected input)*
- `goal` (str): The goal from the caller (source flow, i.e. JarvisFlow)
*Output Interface (expected output)*
- `result` (str): The result of the flow, the result will be returned to the caller (i.e. JarvisFlow).
- `summary` (str): The summary of the flow, the summary will be logged into the logs of the caller flow (i.e. JarvisFlow).
Typical workflow of Coder:
0. JarvisFlow calls Coder with a goal.
1. MemoryReading reads plans, logs and code library.
2. Planner makes plan based on goal.
3. Extend library with the goal given by the controller.
4. Run code with code (possibly calls the newly written function) given by the controller.
5. Finish and give an answer.
<a id="CoderFlow.CoderFlow.run"></a>
#### run
```python
def run(input_data: Dict[str, Any]) -> Dict[str, Any]
```
The run function of the Coder flow.
**Arguments**:
- `input_data` (`Dict[str, Any]`): The input data of the flow.
**Returns**:
`Dict[str, Any]`: The output data of the flow.
<a id="__init__"></a>
# \_\_init\_\_
|