.. LLMSQL documentation master file, created by
   sphinx-quickstart on Wed Sep 24 11:41:44 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to LLMSQL project
====================

.. image:: https://img.shields.io/pypi/v/llmsql
   :target: https://pypi.org/project/llmsql/

LLMSQL is a Python package for SQL reasoning with LLMs and vLLM inference.

🚀 Features
-----------
- Easy vLLM inference integration
- Evaluator utilities
- HuggingFace + TRL support

📦 Installation
---------------
.. code-block:: bash

   pip3 install llmsql

🔗 Resources
------------
- `Source code on GitHub <https://github.com/LLMSQL/llmsql-benchmark>`_
- `PyPI project <https://pypi.org/project/llmsql/>`_
- `Dataset on Hugging Face <https://huggingface.co/llmsql-bench>`_
- `Example Usages <https://github.com/LLMSQL/llmsql-benchmark/tree/main/examples>`_


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