genlm-control 0.1.0

No project description provided

GenLM Control

GenLM Control is a library for controlled generation with programmable constraints. It leverages sequential Monte Carlo (SMC) methods to efficiently generate text that satisfies constraints or preferences encoded by arbitrary potential functions.

See the docs for details and examples for usage.

⚠️ Warning: This library is currently in active development. Please report any bugs in the issue tracker.

Quick Start

Installation

Clone the repository:

git clone [e-mail]:ChiSym/genlm-control.git
cd genlm-control

and install with pip:

pip install .

This installs the package without development dependencies. For development, install in editable mode with:

pip install -e ".[test,docs]"

which also installs the dependencies needed for testing (test) and documentation (docs).

Requirements

• Python >= 3.11
• The core dependencies listed in the pyproject.toml file of the repository.

Testing

When test dependencies are installed, the test suite can be run via:

pytest tests

Documentation

Documentation is generated using mkdocs and hosted on GitHub Pages. To build the documentation, run:

mkdocs build

To serve the documentation locally, run:

mkdocs serve