Welcome to Outformer's Documentation!
=====================================

.. raw:: html

   <div class="badges-container">
      <a href="https://pypi.org/project/outformer/"><img src="https://img.shields.io/pypi/v/outformer?logo=pypi&style=flat&color=8c52ff" alt="PyPI - Package Version"></a>
      <a href="https://pypi.org/project/outformer/"><img src="https://img.shields.io/pypi/pyversions/outformer?logo=python&logoColor=5ce1e6" alt="Python Versions"></a>
      <a href="https://github.com/milistu/outformer/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=393be5" alt="License"></a>
      <a href="https://github.com/milistu/outformer"><img src="https://img.shields.io/static/v1?logo=github&style=flat&color=5ce1e6&label=Repo&message=outformer" alt="Repo - GitHub.io"></a>
   </div>

Outformer is a powerful library that enables language models to generate structured outputs. 
It ensures always valid JSON outputs by generating only values while maintaining the structural integrity of your schema.

Features
--------

* 🔄 **Structured Output Generation**: Generate valid JSON outputs from language models
* 🎯 **Schema Validation**: Ensure outputs conform to your JSON schema  
* 🛠️ **Flexible Integration**: Works with any Hugging Face transformer model
* 🚀 **Easy to Use**: Simple API with minimal configuration
* 🎨 **Value Highlighting**: Visualize generated values in your JSON structure

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   quickstart
   examples
   json_schema
   api_reference

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`