73 lines
3.3 KiB
Markdown
73 lines
3.3 KiB
Markdown
<h1 align="center">Pocket Flow - LLM Framework in 100 Lines</h1>
|
||
|
||
|
||
|
||
|
||
[](https://the-pocket.github.io/PocketFlow/)
|
||
|
||
<div align="center">
|
||
<img src="./assets/minillmflow.jpg" width="400"/>
|
||
</div>
|
||
|
||
<br>
|
||
|
||
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), [Workflow](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).
|
||
|
||
- 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/
|
||
|
||
## Why Pocket Flow?
|
||
|
||
Pocket Flow lets you **build LLM apps just by chatting with agents like Cursor AI**—no need for low-level coding.
|
||
|
||
<div align="center">
|
||
<a href="https://youtu.be/0Pv5HVoVBYE" target="_blank">
|
||
<img src="./assets/youtube.png" width="500" alt="IMAGE ALT TEXT" style="cursor: pointer;">
|
||
</a>
|
||
</div>
|
||
|
||
|
||
Pocket Flow is *designed for LLM Agents*. If you’re using Cursor AI...
|
||
|
||
1. **🫠 With LangChain-like frameworks**: Cursor AI gets overwhelmed by complex abstractions and calls deprecated functions by mistake.
|
||
2. **😐 With No Framework**: Cursor AI writes functional but lacks modularity and maintainability.
|
||
3. **🥰 With Pocket Flow**: (1) Minimal and expressive—easy for Cursor AI. (2) Nodes and flows keep the codes **modular and maintainable**. (3) The shared store **separates data from compute logic**.
|
||
|
||
With just 100 lines, Pocket Flow ensures Cursor AI follows good coding practices without sacrificing flexibility.
|
||
|
||
---
|
||
|
||
To set up:
|
||
|
||
- **[Cursor Rules](https://docs.cursor.com/context/rules-for-ai)**: Copy [.cursorrules](assets/.cursorrules) into your project’s root.
|
||
|
||
- **ChatGPT & Claude**: Create a project ([ChatGPT](https://help.openai.com/en/articles/10169521-using-projects-in-chatgpt) and[Claude](https://www.anthropic.com/news/projects)) and upload the [docs](docs) folder to project knowledge.
|
||
|
||
|
||
## What Is Pocket Flow?
|
||
|
||
The [100 lines](pocketflow/__init__.py) capture what we believe to be the core abstraction of LLM projects:
|
||
- **Computation**: A *graph* that breaks down tasks into nodes, with *branching, looping, and nesting*.
|
||
- **Communication**: A *shared store* that all nodes can read and write to.
|
||
|
||
<br>
|
||
<div align="center">
|
||
<img src="./assets/abstraction.png" width="600"/>
|
||
</div>
|
||
<br>
|
||
|
||
From there, it’s 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), [Workflow](https://the-pocket.github.io/PocketFlow/decomp.html), [RAG](https://the-pocket.github.io/PocketFlow/rag.html), etc.
|
||
|
||
<br>
|
||
<div align="center">
|
||
<img src="./assets/paradigm.png" width="600"/>
|
||
</div>
|
||
<br>
|
||
|
||
- To learn more about how it works, check out the [documentation](https://the-pocket.github.io/PocketFlow/)
|
||
- For an in-depth dive into the design, check out the [essay](https://github.com/The-Pocket/.github/blob/main/profile/pocketflow.md)
|
||
|