phowell
/
pocketflow
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Zachary Huang 2025-02-22 20:34:31 -05:00 committed by GitHub
parent d7bb1711d8
commit 67dae24069
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -13,40 +13,37 @@
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 code](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 are terse, check out a [friendlier intro](https://chatgpt.com/share/678564bd-1ba4-8000-98e4-a6ffe363c1b8) - If the 100 lines are too terse, check out a [friendlier intro](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? Let LLM Agents Build LLM Agents for you! ## Why Pocket Flow? Let LLM Agents Build LLM Agents for You!
Pocket Flow is designed to be **the framework used by LLM Agents**: Pocket Flow is designed to be **the framework used by LLM Agents**:
- 🧑 Human users only need to specify LLM project requirements - 🧑 Human users only need to specify LLM project requirements.
- 🤖 LLM Agents build the LLM project for you, using *Pocket Flow* - 🤖 LLM Agents build the LLM project for you, using *Pocket Flow*.
To build LLM projects with LLM Agents (Cursor, ChatGPT, Claude, etc.): To build LLM projects with LLM Agents (Cursor, ChatGPT, Claude, etc.):
- **[Cursor Rules](https://docs.cursor.com/context/rules-for-ai)**: Copy and paste the [.cursorrules](https://github.com/The-Pocket/PocketFlow/blob/main/assets/.cursorrules) (created from [docs](docs)) into the root of your project.
- **[Cursor Rules](https://docs.cursor.com/context/rules-for-ai)**: Copy and paste the [.cursorrule](https://github.com/The-Pocket/PocketFlow/blob/main/assets/.cursorrules) (created from [docs](docs)) into the root of your project. - **[ChatGPT Project](https://help.openai.com/en/articles/10169521-using-projects-in-chatgpt)**: Create a project and upload the [docs](docs) to project knowledge.
- **[ChatGPT Project](https://help.openai.com/en/articles/10169521-using-projects-in-chatgpt)**: Create a project and upload the [docs](docs) to project knowledge
- **[Claude Project](https://www.anthropic.com/news/projects)**: Create a project and upload the [docs](docs) to project knowledge - **[Claude Project](https://www.anthropic.com/news/projects)**: Create a project and upload the [docs](docs) to project knowledge.
- **GPT Store**: Try this [GPT assistant](https://chatgpt.com/g/g-677464af36588191b9eba4901946557b-mini-llm-flow-assistant). However, it uses older models and is not good at coding. - **GPT Store**: Try this [GPT assistant](https://chatgpt.com/g/g-677464af36588191b9eba4901946557b-mini-llm-flow-assistant). However, it uses older models and is not very good at coding.
## What Is Pocket Flow? Graph + Shared Store
The [100 lines](pocketflow/__init__.py) capture what we believe to be the core abstraction of LLM projects:
## What's Pocket Flow? Graph + Shared Store - **Computation Model**: A *graph* that breaks down tasks into multiple nodes, with *branching, recursion, and nesting*.
- **Communication Model**: A *shared store* that all graph nodes can read and write to.
The [100 lines](pocketflow/__init__.py) capture what we believe to be the core abstraction of LLM projects:
- **Computation Model**: *Graph* that breaks down tasks into multiple nodes, with *branching, recursion and nesting*
- **Communication Model**: *Shared Store* that all graph nodes can read and write to
<br> <br>
<div align="center"> <div align="center">
@ -62,8 +59,6 @@ From there, it’s easy to implement popular design patterns like ([Multi-](http
</div> </div>
<br> <br>
- To learn about how Pocket Flow works, check out the [documentation](https://the-pocket.github.io/PocketFlow/) - To learn more about how it works, check out the [documentation](https://the-pocket.github.io/PocketFlow/)
- For an in-depth dive on the design, check out the [essay](https://github.com/The-Pocket/.github/blob/main/profile/pocketflow.md) - For an in-depth dive into the design, check out the [essay](https://github.com/The-Pocket/.github/blob/main/profile/pocketflow.md)