Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
parkervg committed Oct 26, 2024
1 parent a5ef3d1 commit a480b69
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 9 deletions.
24 changes: 24 additions & 0 deletions blendsql/models/local/_azure_phi.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,30 @@


class AzurePhiModel(LocalModel):
"""Class for Azure Phi model with guidance serverside integration.
https://github.com/guidance-ai/guidance?tab=readme-ov-file#azure-ai
Args:
env: Path to directory of .env file, or to the file itself to load as a dotfile.
Should either contain `AZURE_PHI_KEY` and `AZURE_PHI_URL`
caching: Bool determining whether we access the model's cache
Examples:
Given the following `.env` file in the directory above current:
```text
AZURE_PHI_KEY=...
AZURE_PHI_URL=...
```
```python
from blendsql.models import AzurePhiModel
model = AzurePhiModel(
env="..",
)
```
"""

def __init__(
self,
config: Optional[dict] = None,
Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ pip install blendsql
</center>

### ✨ News
- (10/26/24) New tutorial! [blendsql-by-example.ipynb](examples/blendsql-by-example.ipynb)
- (10/18/24) Concurrent async requests in 0.0.29! OpenAI and Anthropic `LLMMap` calls are speedy now.
- Customize max concurrent async calls via `blendsql.config.set_async_limit(10)`
- (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!

Expand Down
11 changes: 11 additions & 0 deletions docs/reference/models/azurephi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
hide:
- toc
---
# Azure Phi

## AzurePhiLLM

::: blendsql.models.local._azure_phi.AzurePhiModel
handler: python
show_source: false
4 changes: 1 addition & 3 deletions docs/reference/models/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,7 @@
hide:
- toc
---
# Blenders

We use the term "blender" to describe the model which receives the prompts used to perform each ingredient function within a BlendSQL script.
# Models

We enable integration with many existing LLMs by building on top of [`guidance` models](https://github.com/guidance-ai/guidance).

Expand Down
9 changes: 3 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ nav:
- Quickstart: quickstart.md
- Some Cool Things by Example: by-example.md
- Examples:
- BlendSQL by Example: reference/examples/blendsql-by-example.ipynb
- Custom VQA Ingredient with LLaVA: reference/examples/vqa-ingredient.ipynb
- Teaching BlendSQL via In-Context Learning: reference/examples/teaching-blendsql-via-in-context-learning.ipynb
- Documentation:
Expand All @@ -88,6 +89,7 @@ nav:
- Anthropic: reference/models/anthropic.md
- Transformers: reference/models/transformers.md
- Ollama: reference/models/ollama.md
- Azure Phi: reference/models/azurephi.md
- Databases:
- reference/databases/databases.md
- DuckDB: reference/databases/duckdb.md
Expand All @@ -97,9 +99,4 @@ nav:
- Smoothie:
- reference/smoothie.md
- Programs:
- reference/programs.md
- Natural Language to BlendSQL:
- reference/nl_to_blendsql/nl-to-blendsql.md
- Technical Walkthrough:
- reference/technical_walkthrough.md
- Query Optimization: reference/query_optimization.md
- reference/programs.md

0 comments on commit a480b69

Please sign in to comment.