Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
parkervg committed May 13, 2024
1 parent 24f0796 commit 214274a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
16 changes: 9 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ pip install blendsql
</div>
</center>

### Features
- Supports many DBMS 💾
- Currently, SQLite and PostgreSQL are functional - more to come!
- Easily extendable to [multi-modal usecases](reference/examples/vqa-ingredient) 🖼️
- 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/) 🔑

BlendSQL is a *superset of SQLite* for problem decomposition and hybrid question-answering with LLMs.

As a result, we can *Blend* together...
Expand Down Expand Up @@ -99,13 +108,6 @@ SELECT date, rival, score, documents.content AS "Team Description" FROM w
}} WHERE rival = 'nsw waratahs'
```

### Features
- 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 🌳
- LLM function caching, built on [diskcache](https://grantjenks.com/docs/diskcache/) 🔑
- Constrained decoding with [guidance](https://github.com/guidance-ai/guidance) 🚀


For a technical walkthrough of how a BlendSQL query is executed, check out [technical_walkthrough.md](reference/technical_walkthrough.md).

### Citation
Expand Down
15 changes: 15 additions & 0 deletions docs/reference/blenders/llamacpp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Llama-Cpp

## LlamaCppLLM

::: blendsql.models.local._llama_cpp.LlamaCppLLM
handler: python
show_source: false

### Example Usage

```python
from blendsql.models import LlamaCppLLM

blender = LlamaCppLLM("./tinyllama-1.1b-1t-openorca.Q4_0.gguf")
```

0 comments on commit 214274a

Please sign in to comment.