Welcome to synthyverse's documentation!
=========================================

**synthyverse** is an extensive ecosystem for synthetic data generation and evaluation in Python.

The synthyverse provides:

* **Modular installation** - Install only the generator and evaluation extras needed for a given environment.
* **Low-level APIs** - Use preprocessing, generators, and metrics directly when you need explicit control.
* **High-level wrappers** - Use ``SynthyverseGenerator``, ``TabularMetricEvaluator``, and ``TabularSynthesisBenchmark`` for common end-to-end workflows.
* **Shared preprocessing** - Reuse schema restoration, missing-value handling, and constraints across generators.
* **Benchmarking** - Train, sample, evaluate, and save repeatable tabular synthesis runs.

Quick Start
-----------

.. toctree::
   :maxdepth: 2
   :caption: Getting Started

   getting_started
   in_depth_usage

API Reference
-------------

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index