From 7569430823da617ba0f2855ec79e56e5253f09e8 Mon Sep 17 00:00:00 2001 From: Zachary Huang <33015448+zachary62@users.noreply.github.com> Date: Tue, 11 Mar 2025 17:19:44 -0400 Subject: [PATCH] Update README.md --- README.md | 114 ++++++++++++++++++++++++++---------------------------- 1 file changed, 55 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 4867357..b184203 100644 --- a/README.md +++ b/README.md @@ -12,47 +12,67 @@ Pocket Flow is a [100-line](pocketflow/__init__.py) minimalist LLM framework -- **Lightweight**: Just the core graph abstraction in 100 lines. Zero bloat, zero dependencies, zero vendor lock-in. +- **Lightweight**: Just 100 lines. Zero bloat, zero dependencies, zero vendor lock-in. -- **Expressive**: Everything you love from larger frameworks—([Multi-](https://the-pocket.github.io/PocketFlow/design_pattern/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/design_pattern/agent.html), [Workflow](https://the-pocket.github.io/PocketFlow/design_pattern/workflow.html), [RAG](https://the-pocket.github.io/PocketFlow/design_pattern/rag.html), and more. +- **Expressive**: Everything you love from large frameworks—([Multi-](https://the-pocket.github.io/PocketFlow/design_pattern/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/design_pattern/agent.html), [Workflow](https://the-pocket.github.io/PocketFlow/design_pattern/workflow.html), [RAG](https://the-pocket.github.io/PocketFlow/design_pattern/rag.html), and more. + +- **AI-Friendly**: Let AI Agents (e.g., Cursor AI) build Agents—10x productivity boost! -- **AI-Friendly**: Intuitive enough for AI agents (e.g., Cursor AI) to build agents! - -- **Principled**: Built with modularity and clear separation of concerns at its heart for maintainable codes. - - To install, ```pip install pocketflow```or just copy the [source code](pocketflow/__init__.py) (only 100 lines). - To learn more, check out the [documentation](https://the-pocket.github.io/PocketFlow/). For an in-depth design dive, read the [essay](https://github.com/The-Pocket/.github/blob/main/profile/pocketflow.md). - 🎉 We now have a [discord](https://discord.gg/hUHHE9Sa6T)! +## Why Pocket Flow? -## What can Pocket Flow build? - -✨ Below are examples of LLM Apps: +Current LLM frameworks are bloated. You only need 100 lines for LLM Framework!
- -| Formal App Name | Informal One-Liner |Difficulty | Learning Objectives | -| :------------- | :------------- | :------------- | :--------------------- | -| [Ask AI Paul Graham](https://github.com/The-Pocket/Tutorial-YC-Partner) | Ask AI Paul Graham, in case you don't get in | ★★☆
*Medium* | [RAG](https://the-pocket.github.io/PocketFlow/design_pattern/rag.html)
[Map Reduce](https://the-pocket.github.io/PocketFlow/design_pattern/mapreduce.html)
[Text-to-Speech](https://the-pocket.github.io/PocketFlow/utility_function/text_to_speech.html) | -| [Youtube Summarizer](https://github.com/The-Pocket/Tutorial-Youtube-Made-Simple) | Explain YouTube Videos to you like you're 5 | ★☆☆
*Beginner* | [Map Reduce](https://the-pocket.github.io/PocketFlow/design_pattern/mapreduce.html) | -| [Cold Opener Generator](https://github.com/The-Pocket/Tutorial-Cold-Email-Personalization) | Instant icebreakers that turn cold leads hot | ★☆☆
*Beginner* | [Map Reduce](https://the-pocket.github.io/PocketFlow/design_pattern/mapreduce.html)
[Web Search](https://the-pocket.github.io/PocketFlow/utility_function/websearch.html) | + + + + | | **Abstraction** | **App-Specific Wrappers** | **Vendor-Specific Wrappers** | **Lines** | **Size** | +|----------------|:-----------------------------: |:-----------------------------------------------------------:|:------------------------------------------------------------:|:---------------:|:----------------------------:| +| LangChain | Agent, Chain | Many
(e.g., QA, Summarization) | Many
(e.g., OpenAI, Pinecone, etc.) | 405K | +166MB | +| LlamaIndex | Agent, Graph | Native for RAG
(Summarization, KG Indexing) | Many [Optional]
(e.g., OpenAI, Pinecone, etc.) | 77K
(core-only) | +189MB
(core-only) | +| CrewAI | Agent, Chain | Many
(e.g., FileReadTool, SerperDevTool) | Many
(e.g., OpenAI, Anthropic, Pinecone, etc.) | 18K | +173MB | +| Haystack | Agent, Graph | Many
(e.g., QA, Summarization) | Many
(e.g., OpenAI, Anthropic, Pinecone, etc.) | 31K | +195MB | +| SmolAgent | Agent | Some
(e.g., CodeAgent, VisitWebTool) | Some
(e.g., DuckDuckGo, Hugging Face, etc.) | 8K | +198MB | +| LangGraph | Agent, Graph | Some
(e.g., Semantic Search) | Some
(e.g., PostgresStore, SqliteSaver, etc.) | 37K | +51MB | +| AutoGen | Agent | Some
(e.g., Tool Agent, Chat Agent) | Many [Optional]
(e.g., OpenAI, Pinecone, etc.) | 7K
(core-only) | +26MB
(core-only) | +| **PocketFlow** | **Graph** | **None** | **None** | **100** | **+56KB** |
-- Want to learn how I vibe code these LLM Apps? Check out [my YouTube](https://www.youtube.com/@ZacharyLLM?sub_confirmation=1)! - -- Want to create your own Python project? Start with [this template](https://github.com/The-Pocket/PocketFlow-Template-Python)! +## How does Pocket Flow work? -## Why Pocket Flow? +The [100 lines](pocketflow/__init__.py) capture the core abstraction of LLM frameworks: Graph! -🚀 **Agents build Agents** – the fastest paradigm for building LLM systems! +
+ +
+ +From there, it’s easy to implement popular design patterns like ([Multi-](https://the-pocket.github.io/PocketFlow/design_pattern/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/design_pattern/agent.html), [Workflow](https://the-pocket.github.io/PocketFlow/design_pattern/workflow.html), [RAG](https://the-pocket.github.io/PocketFlow/design_pattern/rag.html), etc. + +
+ +
+ + + + +## How to Use Pocket Flow? + + +🚀 It's highly recommended to **build Agents with Agents**—the fastest development paradigm! - 😎 **Humans** craft the **high-level requirements and system design**. - + - 🤖 **AI agents** (e.g., Cursor AI) handle the **low-level implementation**. +Check out the video to see the process in action! +
@@ -62,49 +82,25 @@ Pocket Flow is a [100-line](pocketflow/__init__.py) minimalist LLM framework
-Compare to other frameworks, Pocket Flow is purpose-built for LLM Agents: +## What can Pocket Flow build? -1. **🫠 LangChain-like frameworks** overwhelm Cursor AI with *complex* abstractions, *deprecated* functions and *irritating* dependency issues. - -3. 😐 **Without a framework**, code is *ad hoc*—suitable only for immediate tasks, *not modular or maintainable*. - -5. **🥰 With Pocket Flow**: (1) Minimal and expressive—easy for Cursor AI to pick up. (2) *Nodes and Flows* keep everything *modular*. (3) A *Shared Store* decouples your data structure from compute logic. +✨ Below are examples of LLM Apps: -In short, the **100 lines** ensures LLM Agents follows *solid coding practices* without sacrificing *simplicity* or *flexibility*. - - - - -## How does Pocket Flow work? - -The [100 lines](pocketflow/__init__.py) capture the core Graph abstraction of LLM frameworks: - -
- + +| Formal App Name | Informal One-Liner |Difficulty | Learning Objectives | +| :------------- | :------------- | :-------------: | :--------------------- | +| [Ask AI Paul Graham](https://github.com/The-Pocket/Tutorial-YC-Partner) | Ask AI Paul Graham, in case you don't get in | ★★☆
*Medium* | [RAG](https://the-pocket.github.io/PocketFlow/design_pattern/rag.html)
[Map Reduce](https://the-pocket.github.io/PocketFlow/design_pattern/mapreduce.html)
[Text-to-Speech](https://the-pocket.github.io/PocketFlow/utility_function/text_to_speech.html) | +| [Youtube Summarizer](https://github.com/The-Pocket/Tutorial-Youtube-Made-Simple) | Explain YouTube Videos to you like you're 5 | ★☆☆
*Beginner* | [Map Reduce](https://the-pocket.github.io/PocketFlow/design_pattern/mapreduce.html) | +| [Cold Opener Generator](https://github.com/The-Pocket/Tutorial-Cold-Email-Personalization) | Instant icebreakers that turn cold leads hot | ★☆☆
*Beginner* | [Map Reduce](https://the-pocket.github.io/PocketFlow/design_pattern/mapreduce.html)
[Web Search](https://the-pocket.github.io/PocketFlow/utility_function/websearch.html) | +
-
-From there, it’s easy to implement popular design patterns like ([Multi-](https://the-pocket.github.io/PocketFlow/design_pattern/multi_agent.html))[Agents](https://the-pocket.github.io/PocketFlow/design_pattern/agent.html), [Workflow](https://the-pocket.github.io/PocketFlow/design_pattern/workflow.html), [RAG](https://the-pocket.github.io/PocketFlow/design_pattern/rag.html), etc. - -
-
- -
-
- - -## How to start? - - -- **For quick questions**: Use the [GPT assistant](https://chatgpt.com/g/g-677464af36588191b9eba4901946557b-pocket-flow-assistant) (note: it uses older models not ideal for coding). +- Want to learn how I built these LLM Apps? Check out [my YouTube](https://www.youtube.com/@ZacharyLLM?sub_confirmation=1)! -- **For one-time LLM task**: Create a [ChatGPT](https://help.openai.com/en/articles/10169521-using-projects-in-chatgpt) or [Claude](https://www.anthropic.com/news/projects) project; upload the [docs](docs) to project knowledge. - -- **For LLM App development**: Use [Cursor AI](https://www.cursor.com/). - - - If you want to start a new project, check out the [project template](https://github.com/The-Pocket/PocketFlow-Template-Python). - - - If you already have a project, copy [.cursorrules](.cursorrules) to your project root as [Cursor Rules](https://docs.cursor.com/context/rules-for-ai). +- Want to create your own Python project? Start with [this template](https://github.com/The-Pocket/PocketFlow-Template-Python)! + + +