API reference
=============

The names exported at the top level (``from synthpriv import ...``) are
re-exports of the objects documented below; the canonical documentation lives
with the defining module.

Pipeline
--------

.. automodule:: synthpriv.pipeline
   :members:
   :show-inheritance:

Sweep
-----

.. automodule:: synthpriv.sweep
   :members:
   :show-inheritance:

Benchmark
---------

.. automodule:: synthpriv.benchmark
   :members:
   :show-inheritance:

Report
------

.. automodule:: synthpriv.report
   :members:
   :show-inheritance:

Core
----

.. automodule:: synthpriv.core.base
   :members:
   :show-inheritance:

.. automodule:: synthpriv.core.registry
   :members:
   :show-inheritance:

Generators
----------

.. automodule:: synthpriv.generators.tabular
   :members:
   :show-inheritance:

Differential privacy
--------------------

.. automodule:: synthpriv.privacy.mechanisms
   :members:
   :show-inheritance:

.. automodule:: synthpriv.privacy.accountant
   :members:
   :show-inheritance:

.. automodule:: synthpriv.privacy.assurance
   :members:
   :show-inheritance:

.. automodule:: synthpriv.privacy.budget
   :members:
   :show-inheritance:

.. automodule:: synthpriv.privacy.dpecdf
   :members:
   :show-inheritance:

DP generators
-------------

.. automodule:: synthpriv.dp.gan
   :members:
   :show-inheritance:

.. automodule:: synthpriv.dp.copula
   :members:
   :show-inheritance:

.. automodule:: synthpriv.dp.encoder
   :members:
   :show-inheritance:

Metrics
-------

.. automodule:: synthpriv.metrics.base
   :members:
   :show-inheritance:

.. automodule:: synthpriv.metrics.core
   :members:
   :show-inheritance:

.. automodule:: synthpriv.metrics.utility
   :members:
   :show-inheritance:

.. automodule:: synthpriv.metrics.privacy
   :members:
   :show-inheritance:

Utilities
---------

.. automodule:: synthpriv.utils
   :members:
   :show-inheritance:

Command-line interface
----------------------

.. automodule:: synthpriv.cli