.. tau-eval documentation master file, created by
   sphinx-quickstart on Tue Jul  1 12:37:18 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to 𝜏 Tau-Eval's documentation!
====================================

**Tau-Eval** is a user-friendly, modular, and customizable Python library designed to benchmark and evaluate text anonymization algorithms. It enables granular analysis of anonymization impacts from both privacy and utility perspectives. Tau-Eval seamlessly integrates with `LiteLLM <https://www.litellm.ai/>`_ and `🤗 Hugging Face <https://huggingface.co/>`_ to support a wide range of datasets, models, and evaluation metrics.

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

   installation
   quickstart
   tutorials
   citation
   modules