Ollama

Installation

To be able to use Ollama in Outlines, you must install both Ollama and the optional dependency libraries of the model.

• To download Ollama: https://ollama.com/download
• To install the ollama python sdk: pip install outlines[ollama]

Consult the ollama documentation for detailed information on installation and client initialization.

Model Initialization

To create an Ollama model instance, you can use the from_ollama function. It takes 2 arguments:

• client: an ollama.Client instance
• model_name: the name of the model you want to use

For instance:

import ollama
import outlines

# Create the client
client = ollama.Client()

# Create the model
model = outlines.from_ollama(
    client,
    "tinyllama",
)

You can find the list of available models on the Ollama library.

Text Generation

Once you've created your Outlines Ollama model instance, you're all set to generate text with this provider. You can simply call the model with a prompt.

For instance:

import ollama
import outlines

# Create the model
model = outlines.from_ollama(ollama.Client(), "tinyllama")

# Call it to generate text
response = model("What's the capital of Latvia?")
print(response) # 'Riga'

Ollama also supports streaming. For instance:

import ollama
import outlines

# Create the model
model = outlines.from_ollama(ollama.Client(), "tinyllama")

# Stream text
for chunk in model.stream("Write a short story about a cat"):
    print(chunk) # 'In...'

Structured Generation

Ollama only provides support for structured generation based on a JSON schema. To use it, call the model with a JSON schema object as an output_type on top of your prompt.

For instance:

from typing import List
from pydantic import BaseModel
import ollama
import outlines

class Character(BaseModel):
    name: str
    age: int
    skills: List[str]

# Create the model
model = outlines.from_ollama(ollama.Client(), "tinyllama")

# Call it with the output type to generate structured text
result = model("Create a character", Character)
print(result) # '{"name": "Evelyn", "age": 34, "skills": ["archery", "stealth", "alchemy"]}'
print(Character.model_validate_json(result)) # name=Evelyn, age=34, skills=['archery', 'stealth', 'alchemy']

Inference arguments

When calling the model, you can provide keyword arguments that will be passed down to the generate method of the Ollama client.

Consult the Ollama REST API documentation for the full list of inference parameters.