README.md

Structured generation (in Rust).

This package provides the core functionality for structured generation, formerly implemented in Outlines, with a focus on performance and portability.

Install

We provide bindings to the following languages:

• Rust (Original implementation)
• Python

The latest release of the Python bindings is available on PyPi using pip:

pip install outlines-core

The current development branch of outlines-core can be installed from GitHub, also using pip:

pip install git+https://github.com/outlines-dev/outlines-core

Or install in a rust project with cargo:

cargo add outlines-core

How to contribute?

Setup

First, fork the repository on GitHub and clone the fork locally:

git clone git@github.com/YourUserName/outlines-core.git
cd outlines-core

Create a new virtual environment:

python -m venv .venv
source .venv/bin/activate

Then install the dependencies in editable mode, and install the pre-commit hooks:

pip install -e ".[test]"
pre-commit install

Before pushing your code

Run the tests:

pytest

And run the code style checks:

pre-commit run --all-files