Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update the README with articles on structured generation #805

Merged
merged 2 commits into from
Apr 12, 2024
Merged

Update the README with articles on structured generation #805

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10b6315
Why use structured generation
rlouf Apr 12, 2024
4fb6ab1
Add .txt blurb
rlouf Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,11 @@

*Robust (structured) text generation.*

Made with ❤👷️ by the team at [.txt](https://dottxt.co). [Give our .json API a try](https://h1xbpbfsf0w.typeform.com/to/ZgBCvJHF) ✨
Made with ❤👷️ by the team at [.txt](https://dottxt.co).

</div>



``` bash
pip install outlines
```
Expand All @@ -42,6 +41,20 @@ First time here? Go to our [setup guide](https://outlines-dev.github.io/outlines

Outlines 〰 has new releases and features coming every week. Make sure to ⭐ star and 👀 watch this repository, follow [@dottxtai][twitter] to stay up to date!

## Why should I use structured generation?

* It doesn't add any overhead during inference (cost-free)
* [It speeds up inference](http://blog.dottxt.co/coalescence.html)
* [It improves the performance of base models (GSM8K)](http://blog.dottxt.co/performance-gsm8k.html)
* [It improves the performance of finetuned models (CoNNL)](https://predibase.com/blog/lorax-outlines-better-json-extraction-with-structured-generation-and-lora)

## .txt company

<div align="center">
<img src="./docs/assets/images/dottxt.png" alt="Outlines Logo" width=100></img>
</div>

We started a company to keep pushing the boundaries of structured generation. Learn more about [.txt](https://twitter.com/dottxtai), and [give our .json API a try](https://h1xbpbfsf0w.typeform.com/to/ZgBCvJHF) if you need a hosted solution ✨

## Structured generation

Expand Down