Update README.md

This commit is contained in:
Zachary Huang 2025-02-22 19:53:50 -05:00 committed by GitHub
parent c3c7dcaa2b
commit 25833498ee
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 11 deletions

View File

@ -13,16 +13,21 @@
A [100-line](pocketflow/__init__.py) minimalist LLM framework for ([Multi-](https://the-pocket.github.io/PocketFlow/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/agent.html), [Prompt Chaining](https://the-pocket.github.io/PocketFlow/decomp.html), [RAG](https://the-pocket.github.io/PocketFlow/rag.html), etc. A [100-line](pocketflow/__init__.py) minimalist LLM framework for ([Multi-](https://the-pocket.github.io/PocketFlow/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/agent.html), [Prompt Chaining](https://the-pocket.github.io/PocketFlow/decomp.html), [RAG](https://the-pocket.github.io/PocketFlow/rag.html), etc.
- Install via ```pip install pocketflow```, or just copy the [source codes](pocketflow/__init__.py) (only 100 lines) - ⚙️ Install via ```pip install pocketflow```, or just copy the [source code](pocketflow/__init__.py) (only 100 lines)
- If the 100 lines feel terse and youd prefer a friendlier intro, [check this out](https://chatgpt.com/share/678564bd-1ba4-8000-98e4-a6ffe363c1b8) - 😊 If the 100 lines feel terse and youd prefer a friendlier intro, [check this out](https://chatgpt.com/share/678564bd-1ba4-8000-98e4-a6ffe363c1b8)
Documentation: https://the-pocket.github.io/PocketFlow/ - 📖 Documentation: https://the-pocket.github.io/PocketFlow/
## Why Pocket Flow? ## Why Pocket Flow? Let LLM Agents Build LLM Agents for you!
Pocket Flow is designed to be **the framework used by LLMs**. In the future, LLM projects will be *self-programmed* by LLMs themselves: Users specify requirements, and LLMs will design, build, and maintain. Pocket Flow is designed to be **the framework used by LLM Agents**:
To build LLM projects with LLMs assistants (ChatGPT, Claude, Cursor.ai, etc.):
- 🧑 Human users specify project requirements and provide high-level guidance
- 🤖 LLM Agents build and maintain LLM projects for you, using *Pocket Flow*
To build LLM projects with LLMs Agents (ChatGPT, Claude, Cursor.ai, etc.):
<details> <details>
<summary><b>(🫵 Click to expand) Use Claude to build LLM apps</b></summary> <summary><b>(🫵 Click to expand) Use Claude to build LLM apps</b></summary>
@ -68,9 +73,11 @@ To build LLM projects with LLMs assistants (ChatGPT, Claude, Cursor.ai, etc.):
## How does it work? ## What's Pocket Flow? Graph + Shared Store
The [100 lines](pocketflow/__init__.py) capture what we see as the core abstraction of LLM frameworks: a **Graph** that breaks down tasks into multiple (LLM) steps, with branching and recursion for agent-like decision-making, and a **Shared Store** that communicates across graph nodes. The [100 lines](pocketflow/__init__.py) capture what what we believe to be the core abstraction of LLM projects:
- **Graph** as the *Computation Model* that breaks down tasks into multiple-step LLM chains, with branching, recursion and nesting for agent-like decision-making
- **Shared Store** as the *Communication Model* that all graph nodes can read and write to
<br> <br>
<div align="center"> <div align="center">
@ -78,7 +85,7 @@ The [100 lines](pocketflow/__init__.py) capture what we see as the core abstract
</div> </div>
<br> <br>
From there, its easy to implement popular design patterns ike ([Multi-](https://the-pocket.github.io/PocketFlow/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/agent.html), [Prompt Chaining](https://the-pocket.github.io/PocketFlow/decomp.html), [RAG](https://the-pocket.github.io/PocketFlow/rag.html), etc. From there, its easy to implement popular design patterns like ([Multi-](https://the-pocket.github.io/PocketFlow/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/agent.html), [Prompt Chaining](https://the-pocket.github.io/PocketFlow/decomp.html), [RAG](https://the-pocket.github.io/PocketFlow/rag.html), etc.
<br> <br>
<div align="center"> <div align="center">
@ -86,8 +93,8 @@ From there, its easy to implement popular design patterns ike ([Multi-](https
</div> </div>
<br> <br>
- To learn more details, please check out the [documentation](https://the-pocket.github.io/PocketFlow/) - 📖 To learn about how Pocket Flow works, please check out the [documentation](https://the-pocket.github.io/PocketFlow/)
- For a more in-depth dive on the design choices, check out the [essay](https://github.com/The-Pocket/.github/blob/main/profile/pocketflow.mdb) - 🤓 For a more in-depth dive on the design choices, check out the [essay](https://github.com/The-Pocket/.github/blob/main/profile/pocketflow.md)