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: Generates code in an interactive way, the user is able to edit or provide feedback during the process of writing code.
- ask_user: Ask user for info / confirmation, etc.
- re_plan: One branch of the executors, when something goes wrong, re-draft the plan.
- update_plan: 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: Writes the wriiten & tested code to the code library.
Table of Contents
- SaveCodeAtomicFlow
- ExtLibAskUserFlow
- ExtendLibraryFlow
- UpdatePlanAtomicFlow
- run_ExtendLibrary
- CtrlExMem_ExtLib
- ControllerFlow_ExtLib
- __init__
SaveCodeAtomicFlow
SaveCodeAtomicFlow Objects
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 librarymemory_files
(dict): the dictionary of memory files
Output Interface:
result
(str): the result of the flow, to be returned to the controller of the callersummary
(str): the summary of the flow, to be appended to logs
run
def run(input_data: Dict[str, Any])
Run the flow
Arguments:
input_data
: the input data
Returns:
the output data
ExtLibAskUserFlow
ExtLibAskUserFlow Objects
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.
ExtendLibraryFlow
ExtendLibraryFlow Objects
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.
- MemoryReading reads logs, plan, and code library.
- Planner makes a plan based on the goal.
- Write code in an interactive fashion.
- Test code.
- 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).
UpdatePlanAtomicFlow
UpdatePlanAtomicFlow Objects
class UpdatePlanAtomicFlow(AtomicFlow)
Refer to: https://huggingface.co/Tachi67/CoderFlowModule/blob/main/UpdatePlanAtomicFlow.py
run_ExtendLibrary
CtrlExMem_ExtLib
CtrlExMem_ExtLib Objects
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 Interfaceresult
(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.
ControllerFlow_ExtLib
ControllerFlow_ExtLib Objects
class ControllerFlow_ExtLib(ChatAtomicFlow)
Refer to: https://huggingface.co/Tachi67/JarvisFlowModule/blob/main/Controller_JarvisFlow.py