.. DQM documentation master file, created by
   sphinx-quickstart on Wed Mar 26 14:45:36 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to dqm-ml 's documentation
=================

.. include:: ../../README.md
   :parser: myst_parser.sphinx_
   :end-before: # Getting started

.. _links
Documentation structure
---------

To know how to get started with dqm, see the :ref:`guidelines` section.


If you want more informations about how to use implemented metrics see the corresponding sections:
:ref:`diversity`.
:ref:`domain_gap`.
:ref:`representativeness`.
:ref:`completeness`.

.. _links
References links
---------

.. include:: ../../README.md
   :parser: myst_parser.sphinx_
   :start-after: ## References


.. toctree::
   :maxdepth: 3
   :caption: Contents:

   guidelines
   completeness
   diversity
   domain_gap
   representativeness
   changelog
   modules