pocketflow/README.md

68 lines
3.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<h1 align="center">Pocket Flow - LLM Framework in 100 Lines</h1>
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
[![Docs](https://img.shields.io/badge/docs-latest-blue)](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 may seem too minimal for humans. But heres the **crucial point**: Pocket Flow is designed for
<p align="center"><strong><em><u>LLM Agents (e.g., Cursor AI) to build LLM Agents!</u></em></strong></p>
<p align="center"><strong><em><u>LLM Agents (e.g., Cursor AI) to build LLM Agents!</u></em></strong></p>
<p align="center"><strong><em><u>LLM Agents (e.g., Cursor AI) to build LLM Agents!</u></em></strong></p>
LLM Agents understand and use a minimal framework very well!
<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>
To set up:
- **[Cursor Rules](https://docs.cursor.com/context/rules-for-ai)**: Copy [.cursorrules](assets/.cursorrules) into your projects 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, 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), [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)