update readme
This commit is contained in:
parent
52097651de
commit
9ceec8ee36
14
README.md
14
README.md
|
|
@ -87,9 +87,17 @@ Pocket Flow is also a *learning resource*, as current frameworks abstract too mu
|
||||||
|
|
||||||
## How Does it Work?
|
## How Does it Work?
|
||||||
|
|
||||||
The [100 lines](pocketflow/__init__.py) capture what we see as the core abstraction of most LLM frameworks: a **Nested Directed Graph** that breaks down tasks into multiple (LLM) steps, with branching and recursion for agent-like decision-making. From there, it’s easy to layer on more complex features.
|
The [100 lines](pocketflow/__init__.py) capture what we see as the core abstraction of most LLM frameworks: **Nested Directed Graph** that breaks down tasks into multiple (LLM) steps, with branching and recursion for agent-like decision-making.
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="./assets/abstraction.png" width="500"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
From there, it’s easy to layer on more complex features.
|
||||||
|
|
||||||
|
<div align="center">
|
||||||
|
<img src="./assets/paradigm.png" width="500"/>
|
||||||
|
</div>
|
||||||
|
|
||||||
- To learn more details, please check out documentation: https://the-pocket.github.io/PocketFlow/
|
- To learn more details, please check out documentation: https://the-pocket.github.io/PocketFlow/
|
||||||
|
|
||||||
|
|
@ -99,6 +107,4 @@ The [100 lines](pocketflow/__init__.py) capture what we see as the core abstract
|
||||||
|
|
||||||
- More coming soon ... Let us know you’d love to see!
|
- More coming soon ... Let us know you’d love to see!
|
||||||
|
|
||||||
<div align="center">
|
|
||||||
<img src="./assets/graph.png" width="500"/>
|
|
||||||
</div>
|
|
||||||
|
|
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 236 KiB |
BIN
assets/graph.png
BIN
assets/graph.png
Binary file not shown.
|
Before Width: | Height: | Size: 256 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 252 KiB |
|
|
@ -10,8 +10,29 @@ nav_order: 1
|
||||||
{: .important }
|
{: .important }
|
||||||
> Use LLMs to help with system design and implementation wherever possible.
|
> Use LLMs to help with system design and implementation wherever possible.
|
||||||
|
|
||||||
|
## Recommended LLM Project Structure:
|
||||||
|
|
||||||
|
```
|
||||||
|
my_project/
|
||||||
|
├── utils/
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── call_llm.py
|
||||||
|
│ └── search_web.py
|
||||||
|
├── tests/
|
||||||
|
│ ├── __init__.py
|
||||||
|
│ ├── test_flow.py
|
||||||
|
│ └── test_nodes.py
|
||||||
|
├── main.py
|
||||||
|
├── flow.py
|
||||||
|
├── requirements.txt
|
||||||
|
└── design.md
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## System Design Steps:
|
||||||
|
|
||||||
1. **Understand Requirements**
|
1. **Understand Requirements**
|
||||||
- Clarify the app’s needs and workflow.
|
- Clarify the app’s needs and requirements.
|
||||||
- Determine data access (e.g., from files or databases).
|
- Determine data access (e.g., from files or databases).
|
||||||
|
|
||||||
2. **High-Level Flow Design**
|
2. **High-Level Flow Design**
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue