From 1496368c9222a87365c7eb1eeda3d3507fb85f47 Mon Sep 17 00:00:00 2001 From: parkervg Date: Thu, 17 Oct 2024 09:38:42 -0400 Subject: [PATCH] documentation updates --- README.md | 24 ++++++++++++------------ docs/index.md | 30 ++++++++++++++++++------------ 2 files changed, 30 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 68c0357b..168ae1a3 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,18 @@ pip install blendsql - (10/15/24) As of version 0.0.27, there is a new pattern for defining + retrieving few-shot prompts; check out [Few-Shot Prompting](#few-shot-prompting) in the README for more info - (10/15/24) Check out [Some Cool Things by Example](https://parkervg.github.io/blendsql/by-example/) for some recent language updates! +### Features + +- Supports many DBMS 💾 + - SQLite, PostgreSQL, DuckDB, Pandas (aka duckdb in a trenchcoat) +- Supports many models ✨ + - Transformers, OpenAI, Anthropic, Ollama +- Easily extendable to [multi-modal usecases](./examples/vqa-ingredient.ipynb) 🖼️ +- Write your normal queries - smart parsing optimizes what is passed to external functions 🧠 + - Traverses abstract syntax tree with [sqlglot](https://github.com/tobymao/sqlglot) to minimize LLM function calls 🌳 +- Constrained decoding with [guidance](https://github.com/guidance-ai/guidance) 🚀 + - When using local models, we only generate syntactically valid outputs according to query syntax + database contents +- LLM function caching, built on [diskcache](https://grantjenks.com/docs/diskcache/) 🔑 BlendSQL is a *superset of SQLite* for problem decomposition and hybrid question-answering with LLMs. @@ -138,18 +150,6 @@ Now, we have an intermediate representation for our LLM to use that is explainab For in-depth descriptions of the above queries, check out our [documentation](https://parkervg.github.io/blendsql/). -### Features - -- Supports many DBMS 💾 - - SQLite, PostgreSQL, DuckDB, Pandas (aka duckdb in a trenchcoat) -- Supports many models ✨ - - Transformers, OpenAI, Anthropic, Ollama -- Easily extendable to [multi-modal usecases](./examples/vqa-ingredient.ipynb) 🖼️ -- Smart parsing optimizes what is passed to external functions 🧠 - - Traverses abstract syntax tree with [sqlglot](https://github.com/tobymao/sqlglot) to minimize LLM function calls 🌳 -- Constrained decoding with [guidance](https://github.com/guidance-ai/guidance) 🚀 -- LLM function caching, built on [diskcache](https://grantjenks.com/docs/diskcache/) 🔑 - ## Quickstart ```python diff --git a/docs/index.md b/docs/index.md index a4728703..74e4d337 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,6 +25,24 @@ pip install blendsql ``` + +### ✨ News +- (10/15/24) As of version 0.0.27, there is a new pattern for defining + retrieving few-shot prompts; check out [Few-Shot Prompting](#few-shot-prompting) in the README for more info +- (10/15/24) Check out [Some Cool Things by Example](https://parkervg.github.io/blendsql/by-example/) for some recent language updates! + +### Features + +- Supports many DBMS 💾 + - SQLite, PostgreSQL, DuckDB, Pandas (aka duckdb in a trenchcoat) +- Supports many models ✨ + - Transformers, OpenAI, Anthropic, Ollama +- Easily extendable to [multi-modal usecases](./examples/vqa-ingredient.ipynb) 🖼️ +- Write your normal queries - smart parsing optimizes what is passed to external functions 🧠 + - Traverses abstract syntax tree with [sqlglot](https://github.com/tobymao/sqlglot) to minimize LLM function calls 🌳 +- Constrained decoding with [guidance](https://github.com/guidance-ai/guidance) 🚀 + - When using local models, we only generate syntactically valid outputs according to query syntax + database contents +- LLM function caching, built on [diskcache](https://grantjenks.com/docs/diskcache/) 🔑 +- BlendSQL is a *superset of SQLite* for problem decomposition and hybrid question-answering with LLMs. As a result, we can *Blend* together... @@ -125,18 +143,6 @@ Now, we have an intermediate representation for our LLM to use that is explainab For in-depth descriptions of the above queries, check out our [documentation](https://parkervg.github.io/blendsql/). -### Features - -- Supports many DBMS 💾 - - SQLite, PostgreSQL, DuckDB, Pandas (aka duckdb in a trenchcoat) -- Supports many models ✨ - - Transformers, OpenAI, Anthropic, Ollama -- Easily extendable to [multi-modal usecases](./examples/vqa-ingredient.ipynb) 🖼️ -- Smart parsing optimizes what is passed to external functions 🧠 - - Traverses abstract syntax tree with [sqlglot](https://github.com/tobymao/sqlglot) to minimize LLM function calls 🌳 -- Constrained decoding with [guidance](https://github.com/guidance-ai/guidance) 🚀 -- LLM function caching, built on [diskcache](https://grantjenks.com/docs/diskcache/) 🔑 -
### Citation