Tachi67 commited on
Commit
188fdea
1 Parent(s): c33a68a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +49 -0
README.md CHANGED
@@ -1,3 +1,52 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  # Table of Contents
2
 
3
  * [run\_replanning](#run_replanning)
 
1
+ ### Structure of ReplanningFlow
2
+
3
+ ```
4
+ goal (info on the old plan), plan (old plan), plan_file_location
5
+ |
6
+ v
7
+ +---------------+
8
+ | Controller | --------<<<<-----------+
9
+ +---------------+ |
10
+ | |
11
+ | (command, command args) |
12
+ | |
13
+ v |
14
+ +------------------+ |
15
+ | Executor | Each branch is an |
16
+ | (Tree Structure) | executor |
17
+ +------------------+ |
18
+ | ^
19
+ | (summary) |
20
+ | |
21
+ v |
22
+ | |
23
+ +-> goes back to the Controller>-+
24
+
25
+ ```
26
+
27
+ Structure of the Executors:
28
+ ```
29
+ +-------------------+
30
+ | Branching |
31
+ | Executor |
32
+ +-------------------+
33
+ / \
34
+ / \
35
+ / \
36
+ / \
37
+ write_plan ask_user
38
+
39
+ ```
40
+
41
+ About the branches:
42
+ - [ask_user](https://huggingface.co/Tachi67/PlanWriterFlowModule/blob/main/PlanWriterAskUserFlow.py): Ask user for info / confirmation, etc.
43
+ - [write_plan](https://huggingface.co/Tachi67/InteractivePlanGenFlowModule): Generates plan (user edit is allowed) and fetches user feedback.
44
+ - The PlanGenerator of write_plan is replaced with [NewPlanGenFlow](https://huggingface.co/Tachi67/ReplanningFlowModule/blob/main/NewPlanGenFlow.py) to re-plan instead of write plan.
45
+
46
+ How it works:
47
+ Controller calls write_plan until user is satisfied in the feedback, finish.
48
+
49
+
50
  # Table of Contents
51
 
52
  * [run\_replanning](#run_replanning)