update readme

This commit is contained in:
zachary62 2025-02-16 15:49:26 -05:00
parent 52097651de
commit 9ceec8ee36
5 changed files with 33 additions and 6 deletions

View File

@ -87,9 +87,17 @@ Pocket Flow is also a *learning resource*, as current frameworks abstract too mu
## 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, its 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, its 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/
@ -99,6 +107,4 @@ The [100 lines](pocketflow/__init__.py) capture what we see as the core abstract
- More coming soon ... Let us know youd love to see!
<div align="center">
<img src="./assets/graph.png" width="500"/>
</div>

BIN
assets/abstraction.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 236 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 256 KiB

BIN
assets/paradigm.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 252 KiB

View File

@ -10,9 +10,30 @@ nav_order: 1
{: .important }
> 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**
- Clarify the apps needs and workflow.
- Determine data access (e.g., from files or databases).
- Clarify the apps needs and requirements.
- Determine data access (e.g., from files or databases).
2. **High-Level Flow Design**
- Represent the process as a *Nested Directed Graph*.