Update README.md
Browse files
README.md
CHANGED
|
@@ -1,3 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# Table of Contents
|
| 2 |
|
| 3 |
* [run\_codewriter](#run_codewriter)
|
|
|
|
| 1 |
+
### Structure of CodeWriterFlow
|
| 2 |
+
|
| 3 |
+
```
|
| 4 |
+
goal
|
| 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_code ask_user test
|
| 38 |
+
|
| 39 |
+
```
|
| 40 |
+
|
| 41 |
+
About the branches:
|
| 42 |
+
- [ask_user](https://huggingface.co/Tachi67/CodeWriterFlowModule/blob/main/CodeWriterAskUserFlow.py): Ask user for info / confirmation, etc.
|
| 43 |
+
- [write_code](https://huggingface.co/Tachi67/InteractiveCodeGenFlowModule): Generates code (user edit is allowed) and fetches user feedback.
|
| 44 |
+
- [test](https://huggingface.co/Tachi67/TestCodeFlowModule): Test the code, user can provide test suites, if nothing is provided, syntax of the code is checked.
|
| 45 |
+
|
| 46 |
+
How it works:
|
| 47 |
+
Controller calls write_code until user is satisfied in the feedback, then controller calls test to test the code, if test passes, finish.
|
| 48 |
+
|
| 49 |
# Table of Contents
|
| 50 |
|
| 51 |
* [run\_codewriter](#run_codewriter)
|