Skip to content

Fix Outlines docs API cross-refs #3266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DouweM merged 1 commit into from
Oct 27, 2025
Merged

Fix Outlines docs API cross-refs #3266

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/models/outlines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Install

As Outlines is a library allowing you to run models from various different providers, it does not include the necessary dependencies for any provider by default. As a result, to use the [`OutlinesModel`][pydantic_ai.models.OutlinesModel], you must install `pydantic-ai-slim` with an optional group composed of outlines, a dash, and the name of the specific model provider you would use through Outlines. For instance:
As Outlines is a library allowing you to run models from various different providers, it does not include the necessary dependencies for any provider by default. As a result, to use the [`OutlinesModel`][pydantic_ai.models.outlines.OutlinesModel], you must install `pydantic-ai-slim` with an optional group composed of outlines, a dash, and the name of the specific model provider you would use through Outlines. For instance:

```bash
pip/uv-add "pydantic-ai-slim[outlines-transformers]"
Expand Down Expand Up @@ -51,11 +51,11 @@ Alternatively, you can use some `OutlinesModel` class methods made to load a spe

There are methods for the 5 Outlines models that are officially supported in the integration into Pydantic AI:

- [`from_transformers`][pydantic_ai.models.OutlinesModel.from_transformers]
- [`from_llamacpp`][pydantic_ai.models.OutlinesModel.from_llamacpp]
- [`from_mlxlm`][pydantic_ai.models.OutlinesModel.from_mlxlm]
- [`from_sglang`][pydantic_ai.models.OutlinesModel.from_sglang]
- [`from_vllm_offline`][pydantic_ai.models.OutlinesModel.from_vllm_offline]
- [`from_transformers`][pydantic_ai.models.outlines.OutlinesModel.from_transformers]
- [`from_llamacpp`][pydantic_ai.models.outlines.OutlinesModel.from_llamacpp]
- [`from_mlxlm`][pydantic_ai.models.outlines.OutlinesModel.from_mlxlm]
- [`from_sglang`][pydantic_ai.models.outlines.OutlinesModel.from_sglang]
- [`from_vllm_offline`][pydantic_ai.models.outlines.OutlinesModel.from_vllm_offline]

#### Transformers

Expand Down Expand Up @@ -125,7 +125,7 @@ model = OutlinesModel.from_vllm_offline(

Once you have initialized an `OutlinesModel`, you can use it with an Agent as with all other Pydantic AI models.

As Outlines is focused on structured output, this provider supports the `output_type` component through the [`NativeOutput`][pydantic_ai.outputs.NativeOutput] format. There is not need to include information on the required output format in your prompt, instructions based on the `output_type` will be included automatically.
As Outlines is focused on structured output, this provider supports the `output_type` component through the [`NativeOutput`][pydantic_ai.output.NativeOutput] format. There is not need to include information on the required output format in your prompt, instructions based on the `output_type` will be included automatically.

```python {test="skip"}
from pydantic import BaseModel
Expand Down