.. gec-metrics documentation master file, created by
   sphinx-quickstart on Sat Mar 29 01:42:35 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

gec-metrics documentation
#########################

.. Add your content using ``reStructuredText`` syntax. See the
.. `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
.. documentation for details.

gec-metrics is a library that supports various evaluation metrics through a unified interface.

Getting started
===============

- :doc:`getting_started/install`
- :doc:`getting_started/metrics`
- :doc:`getting_started/meta_eval`
- :doc:`getting_started/analysis`

Development
===========
- :doc:`develop/metric`

API Reference
=============
- :doc:`source/gec_metrics`

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


   getting_started/install
   getting_started/metrics
   getting_started/meta_eval
   getting_started/analysis

.. toctree::
   :maxdepth: 2
   :caption: Development:
   :hidden:

   develop/metric

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

   source/gec_metrics