Fast and easy wrapper around LLMs.
Project description
FastLLM
Fast and simple wrapper around LLMs. The package aims to be simply, precise and allows for fast prototyping of agents and applications around LLMs. At the moment focus around OpenAI's chat models.
Warning - experimental package and subject to change. For features and plans see the roadmap.
Installation
pip install fastllm
Samples
Require an openai api key in OPENAI_API_KEY
environment variable or .env
file.
export OPENAI_API_KEY=...
Agents
from fastllm import Agent
find_cities = Agent("List {{ n }} cities comma separated in {{ country }}.")
cities = find_cities(n=3, country="Austria").split(",")
print(cities)
['Vienna', 'Salzburg', 'Graz']
from fastllm import Agent, Message, Model, Prompt, Role
creative_name_finder = Agent(
Message("You are an expert name finder.", Role.SYSTEM),
Prompt("Find {{ n }} names.", temperature=2.0),
Prompt("Print names comma separated, nothing else!"),
model=Model(name="gpt-4"),
)
names = creative_name_finder(n=3).split(",")
print(names)
['Ethan Gallagher, Samantha Cheng, Max Thompson']
Functions
Functions can be added to Agents, Models or Prompts. Either as initial arguments or as decorator. Functions type hints, documentation and name are inferred from the function and added to the model call.
from typing import Literal
from fastllm import Agent, Prompt
calculator_agent = Agent(
Prompt("Calculate the result for task: {{ task }}"),
Prompt("Only give the result number as result without anything else!"),
)
@calculator_agent.function
def calculator(a, b, operator: Literal["+", "-", "*", "/"]):
"""A basic calculator using various operators."""
match operator:
case "+":
return a + b
case "-":
return a - b
case "*":
return a * b
case "/":
return a / b
case _:
raise ValueError(f"Unknown operator {operator}")
result = calculator_agent(task="give the final result for (11 + 14) * (6 - 2)")
print(result)
100
another_result = calculator_agent(
task="If I have 114 apples and 3 elephants, how many apples will each elephant get?"
)
print(another_result)
38
Avoid words/phrases
Avoid/ban word and phrases - supports patterns. Patterns follow regex syntax but do not support all features. If the number of possible strings matching the pattern is too large, the pattern is ignored.
For avoiding/banning words typically it is advised to put a blank space in front of the word.
cat = Agent(
Prompt("Say Cat!"),
)
print(cat())
Cat!
No we avoid/ban the regex pattern r"[ ]?Cat"
(e.g. " Cat" or "Cat") from the response.
not_cat = Agent(
Prompt("Say Cat!", avoid=r"[ ]?Cat"),
)
print(not_cat())
OpenAI is making fun of us (that really happened!) - obviously we need to be more specific (e.g. ban lowercase and uppercase)
Dog! Just kidding, cat!
Ok let's try again.
seriously_not_a_cat = Agent(
Prompt("Say Cat!, PLEEASSEE", avoid=r"[ ]?[Cc][aA][tT]]"),
)
print(seriously_not_a_cat())
Well no cat but kudos for the effort.
Sure, here you go: "Meow! "
Prefer words/phrases
Prefer words/phrases - supports patterns. Patterns follow regex syntax but do not support all features. Only supports pattern matching a limited number of strings. The max token length is set to the longest possible string in the pattern. Also the order of token can not be guaranteed.
meow = Agent(
Prompt("Say Hi!", prefer="Meow!"),
)
print(meow())
Meow!
austria_wins = Agent(
Prompt("Predict the score for Austria against Germany.", prefer=r"Austria: [3-4], Germany: [0-1]"),
)
print(austria_wins())
Order of tokens is not guaranteed (and this is obviously false ;))
Austria, 1: Germany, 3
meow = Agent(
Prompt("Say Hi!", prefer="Meow!", max_tokens=10),
)
print(meow())
Our model can only say "Meow" or "!" up to 10 tokens.
Meow!!!!Meow!Meow!Meow!Meow!Meow
Roadmap
Features
- Prompts using jinja2 templates
- LLM calling with backoff and retry
- Able to register functions to agents, models and prompts using decorators
- Possible to register functions on multiple levels (agent, model, prompt). The function call is only available on the level it was registered.
- Conversation history. The Model class keeps track of the conversation history.
- Function schema is inferred from python function type hints, documentation and name
- Function calling is handled by the Model class itself. Meaning if a LLM response indicate a function call, the Model class will call the function and return the result back to the LLM
- Streaming with function calling
- Function calling can result in an infinite loop if LLM can not provide function name or arguments properly. This needs to be handled by the Model class.
- Force particular function call by providing function call argument
- Option to "smartly forget" conversation history in case context length is too long.
- Prompts with pattern using logit bias to guide LLM completion.
- Able to switch between models (e.g. 3.5 and 4) within one agent over different prompts.
- Handling of multiple response messages from LLMs in a single call. At the moment only the first response is kept.
- Supporting non chat based LLMs (e.g. OpenAI's completion LLMs).
- Supporting other LLMs over APIs except OpenAI's. (e.g. Google etc.)
- Supporting local LLMs (e.g. llama-1, llama-2, etc.)
Package
- Basic package structure and functionality
- Test cases and high test coverage
- Mock implementation of OpenAI's API for tests
- Tests against multiple python versions
- 100% test coverage (at the moment around 90%)
- Better documentation including readthedocs site.
- Better error handling and logging
- Better samples using jupyter notebooks
- Set up of pre-commit
- CI using github actions
- Release and versioning
Development
Using poetry.
poetry install
Tests
poetry run pytest
Publish
poetry publish --build
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fastllm-0.2.1.tar.gz
.
File metadata
- Download URL: fastllm-0.2.1.tar.gz
- Upload date:
- Size: 16.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.10.6 Linux/6.2.0-37-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d32f6d4ced211b1c21dda45fad7bcd00bf82c5cd56873cd1fa945c1dcf626ba1 |
|
MD5 | 24e31d23bea055b496f246dc7ae6cabb |
|
BLAKE2b-256 | de7e7c7f52a2bed804f4349724853236f2fa41d2c530287d7b8e8b3a74cbee2d |
File details
Details for the file fastllm-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: fastllm-0.2.1-py3-none-any.whl
- Upload date:
- Size: 14.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.7.1 CPython/3.10.6 Linux/6.2.0-37-generic
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2b4521ec4cb8adf7854ac76a27cf79f2c76a86c02b6d9c8223a3bd259bd8121 |
|
MD5 | 8e22618fb54989d956926e409ed361af |
|
BLAKE2b-256 | a4dd9a80caefbfd27e7c462c3e27c6ebeac30e842990a0a6c8b369820d34e2f2 |