👋 Welcome to ER-Evaluation's documentation!
============================================

.. currentmodule:: er_evaluation

**ER-Evaluation** is a Python package for the evaluation of entity resolution (ER) systems. It provides data structure definitions, summary statistics, visualizations, error analysis tools, and statistically principled performance estimators.

How to get started
---------------------

To get started, please refer to the :doc:`README <readme>` page and the :doc:`API documentation <er_evaluation>`.

Use the project's `Discussion <https://github.com/OlivierBinette/ER-Evaluation/discussions>`_ page to ask questions and the `Issues <https://github.com/OlivierBinette/ER-Evaluation/issues>`_ page to request features and report bugs.

Quick links
--------------

.. grid:: 2

    .. grid-item-card::  🚀 README
      :text-align: center
      :link: readme
      :link-type: doc
      
      Get started with an overview of the package, installation instructions, and more.

    .. grid-item-card:: 🗃️ API Doc
      :text-align: center
      :link: er_evaluation
      :link-type: doc

      Access detailed documentation for all modules and functions.

.. grid:: 1

    .. grid-item-card::  📖 User Guide
      :text-align: center
      :link: userguide
      :link-type: doc
      
      Overview, usage examples, and advanced features of the package.


.. toctree::
   :maxdepth: 2
   :hidden:

   README <readme>
   User Guide <userguide>
   Examples <visualizations>
   er_evaluation
   authors

Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`