Skip to content

Commit 3569385

Browse files
Lingjiao ChenLingjiao Chen
Lingjiao Chen
authored and
Lingjiao Chen
committed
update readme
1 parent 41b5bbf commit 3569385

File tree

1 file changed

+61
-2
lines changed

1 file changed

+61
-2
lines changed

README.md

+61-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,61 @@
1-
# FrugalGPT
2-
FrugalGPT: better quality and lower cost for LLM applications
1+
# 🎓 FrugalGPT: Better Quality and Lower Cost for LLM Applications
2+
3+
4+
The FrugalGPT framework offers a collection of techniques for _building LLM applications with budget constraints_.
5+
6+
## 🔧 Installation
7+
To install FrugalGPT, run the following commands:
8+
9+
`git clone https://github.com/stanford-futuredata/FrugalGPT`
10+
11+
`cd FrugalGPT`
12+
13+
`pip install git+https://github.com/stanford-futuredata/FrugalGPT`
14+
15+
`wget https://github.com/lchen001/DataHolder/releases/download/v0.0.1/HEADLINES.zip`
16+
17+
` unzip HEADLINES.zip -d strategy/`
18+
19+
`rm HEADLINES.zip`
20+
21+
`wget -P db/ https://github.com/lchen001/DataHolder/releases/download/v0.0.1/HEADLINES.sqlite`
22+
23+
`wget -P db/ https://github.com/lchen001/DataHolder/releases/download/v0.0.1/qa_cache.sqlite`
24+
25+
26+
27+
28+
29+
Now you are ready to use the [intro notebook](intro.ipynb)!
30+
31+
## 🚀 Getting Started
32+
33+
Our [intro notebook](intro.ipynb) provides examples of using FrugalGPT in a few different applications.
34+
35+
You can also directly start with the [Google Colab Notebook](https://colab.research.google.com/drive/1LM-Wq-u87VI4TKM4thpnwepnOxTAtWaM?authuser=1#scrollTo=a95a1eec). You don't even need API keys to get started with it.
36+
37+
Once you go through the notebook, you'll be ready to build your own LLM applcations with FrugalGPT!
38+
39+
40+
## 📚 Read More
41+
42+
43+
You can get an overview via our Twitter threads:
44+
* [**Introducing**](https://twitter.com/james_y_zou/status/1656285537185980417?cxt=HHwWgoCzqfa6p_wtAAAA) [**FrugalGPT**](https://twitter.com/matei_zaharia/status/1656295461953650688?cxt=HHwWgIC2zc_8q_wtAAAA) (May 10, 2023)
45+
46+
And read more in the academic paper:
47+
* [**FrugalGPT: How to Use Large Language Models While Reducing Cost and Improving Performance**](https://arxiv.org/pdf/2305.05176.pdf)
48+
49+
## 🎯 Reference
50+
51+
If you use FrugalGPT in a research paper, please cite our work as follows:
52+
53+
54+
```
55+
@article{chen2023frugalgpt,
56+
title={FrugalGPT: How to Use Large Language Models While Reducing Cost and Improving Performance},
57+
author={Chen, Lingjiao and Zaharia, Matei and Zou, James},
58+
journal={arXiv preprint arXiv:2305.05176},
59+
year={2023}
60+
}
61+
```

0 commit comments

Comments
 (0)