Tachi67 commited on
Commit
dfefde4
·
1 Parent(s): 0f6f613

Update CoderFlow.py

Browse files
Files changed (1) hide show
  1. CoderFlow.py +13 -0
CoderFlow.py CHANGED
@@ -5,6 +5,19 @@ log = logging.get_logger(__name__)
5
  from flow_modules.Tachi67.AbstractBossFlowModule import AbstractBossFlow
6
 
7
  class CoderFlow(AbstractBossFlow):
 
 
 
 
 
 
 
 
 
 
 
 
 
8
  def run(self, input_data: Dict[str, Any]) -> Dict[str, Any]:
9
  # ~~~ sets the input_data in the flow_state dict ~~~
10
  self._state_update_dict(update_data=input_data)
 
5
  from flow_modules.Tachi67.AbstractBossFlowModule import AbstractBossFlow
6
 
7
  class CoderFlow(AbstractBossFlow):
8
+ """Coder flow is one executor branch of the Jarvis flow. At a higher level, it is a flow that
9
+ writes and runs code given a goal. In the Jarvis flow, the Coder flow in invoked by the controller,
10
+ The Coder flow receives the goal generated by the controller, writes and runs code in an interactive fashion.
11
+
12
+ The Coder flow has the similar structure as the Jarvis flow (inherited from AbstractBossFlow).
13
+
14
+
15
+ *Input Interface (expected input)*
16
+ - `goal` (str): The goal from the caller (source flow, i.e. JarvisFlow)
17
+ *Output Interface (expected output)*
18
+ - `result` (str): The result of the flow, the result will be returned to the caller (i.e. JarvisFlow).
19
+ - `summary` (str): The summary of the flow, the summary will be logged into the logs of the caller flow (i.e. JarvisFlow).
20
+ """
21
  def run(self, input_data: Dict[str, Any]) -> Dict[str, Any]:
22
  # ~~~ sets the input_data in the flow_state dict ~~~
23
  self._state_update_dict(update_data=input_data)