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 2024-12-26 17:56:45 -05:00 committed by GitHub
parent 87929060c8
commit a9e46b61d3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,28 +1,30 @@
<h1 align="center">miniLLMFlow</h1> <h1 align="center">Mini LLM Flow</h1>
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg) ![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
Minimalist LLM framework in [100 lines](minillmflow/__init__.py). Express popular paradigms like agents, task decomposition, RAG, and more. A 100-line minimalist LLM framework for agents, task decomposition, RAG, etc.
- Install via ```pip install minillmflow```. Or just copy the [source codes](minillmflow/__init__.py) (it's only 100 lines) - Install via ```pip install minillmflow```, or just copy the [source](minillmflow/__init__.py) (only 100 lines)
- We **strongly recommened** using LLMs (e.g., Claude, ChatGPT, Cursor) to develop LLM applications with [this prompt](minillmflow/docs/prompt)
## Why miniLLMFlow? - **Pro tip:** Build LLM apps with LLMs assistants (ChatGPT, Claude, etc.) via [this prompt](minillmflow/docs/prompt)
The future of programming will be heavily LLM-assited, and LLMs: ## Why Mini LLM Flow?
1. **😀 Shine at Feature Implementation**: The future of LLM app development will be **heavily LLM-assited**: users specify requirements, and LLMs build, test, and maintain on their own. Current LLM assistants:
1. **😀 Shine at Low-level Implementation**:
With proper docs, LLMs can handle APIs, tools, chunking, prompt wrapping, etc. With proper docs, LLMs can handle APIs, tools, chunking, prompt wrapping, etc.
These are hard to maintain and optimize, so they don’t belong in the framework. These are hard to maintain and optimize for a general-purpose framework.
2. **☹️ Struggle with Paradigm Design**: 2. **☹️ Struggle with High-level Paradigms**:
Paradigms like MapReduce, task decomposition, and agents are powerful, even for LLMs. Paradigms like MapReduce, task decomposition, and agents are powerful for development.
However, designing these elegantly remains challenging for LLMs. However, designing these elegantly remains challenging for LLMs.
To enable LLMs to develop LLM applications, a framework should To enable LLMs to develop LLM app, a framework should
(1) remove redunant feature implementations but (1) remove specialized low-level implementations, and
(2) keep core paradigms to build on. (2) keep high-level paradigms to program against.
It turns out that such a framework only needs 100 lines of code. Hence, I built this framework that lets LLMs focus on what matters. It turns out 100 lines is all you need.
<div align="center"> <div align="center">
<img src="./docs/minillmflow.jpg" width="400"/> <img src="./docs/minillmflow.jpg" width="400"/>