.. Duplexity documentation master file, created by
   sphinx-quickstart on Fri Aug  9 11:03:23 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Duplexity: Model Evaluation Metrics
=====================================

**Duplexity** is a Python package that provides a set of deterministic and probabilistic metrics for 
evaluating the performance of machine learning models. It is designed to be easy to use and to provide a wide 
range of metrics for comparing data sets.



.. note::

   This project is still in the early development stages. This means the code is 
   constantly changing, and we currently don't guarantee backwards compatibility 
   when changes are made. Once a stable release of Duplexity is available, we will
   upload Duplexity to PyPI to make it pip-installable.

**Useful links**: `Code repository <https://github.com/bodekerscientific/Duplexity>`_ 


.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: User Guide 

   Installation <guide/installation>
   Metric Overview <metrics/metrics_overview>
   Visualization <plot/plot>


.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Contributing

   Contributing <guide/contributing>
   License <guide/license>

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

   API Reference <guide/api_reference>



   

Indices and tables
~~~~~~~~~~~~~~~~~~~

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`