From ce27432021b502a4db1ec8740caac0b5c3c8e278 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Louf?= Date: Mon, 24 Feb 2025 09:42:11 +0100 Subject: [PATCH] Improve the README --- README.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index cb57be0ae..01d7b9c98 100644 --- a/README.md +++ b/README.md @@ -26,17 +26,12 @@ First time here? Go to our [setup guide](https://dottxt-ai.github.io/outlines/la ## Features -- [x] 🤖 [Multiple model integrations](https://dottxt-ai.github.io/outlines/latest/installation): OpenAI, transformers, llama.cpp, exllama2, mamba -- [x] 🖍️ Simple and powerful prompting primitives based on the [Jinja templating engine](https://jinja.palletsprojects.com/) -- [x] 🚄 [Multiple choices](#multiple-choices), [type constraints](#type-constraint) and dynamic stopping -- [x] ⚡ Fast [regex-structured generation](#efficient-regex-structured-generation) -- [x] 🔥 Fast [JSON generation](#efficient-json-generation-following-a-pydantic-model) following a JSON schema or a Pydantic model -- [x] 📝 [Grammar-structured generation](#using-context-free-grammars-to-guide-generation) -- [x] 🐍 Interleave completions with loops, conditionals, and custom Python functions -- [x] 💾 Caching of generations -- [x] 🗂️ Batch inference -- [x] 🎲 Sample with the greedy, multinomial and beam search algorithms (and more to come!) -- [x] 🚀 [Serve with vLLM](https://dottxt-ai.github.io/outlines/latest/reference/serve/vllm), with official Docker image, [`outlinesdev/outlines`](https://hub.docker.com/r/outlinesdev/outlines)! +- 🤖 [Multiple model integrations](https://dottxt-ai.github.io/outlines/latest/installation): OpenAI, transformers, llama.cpp, exllama2, mamba +- 🔥 Fast [JSON generation](#efficient-json-generation-following-a-pydantic-model) following a JSON schema or a Pydantic model +- 🚄 [Multiple choices](#multiple-choices), [type constraints](#type-constraint) and dynamic stopping +- 📝 Generate text that follows a [regex](#efficient-regex-structured-generation) or a [context-free grammar](#using-context-free-grammars-to-guide-generation) +- 🖍️ Simple and powerful prompting primitives based on the [Jinja templating engine](https://jinja.palletsprojects.com/) +- 🚀 [Serve with vLLM](https://dottxt-ai.github.io/outlines/latest/reference/serve/vllm), with official Docker image, [`outlinesdev/outlines`](https://hub.docker.com/r/outlinesdev/outlines)! Outlines has new releases and features coming every week. Make sure to ⭐ star and 👀 watch this repository, follow [@dottxtai][dottxt-twitter] to stay up to date!