.. FixOut documentation master file, created by
   sphinx-quickstart on Thu Mar 13 21:40:37 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

FixOut documentation
====================

.. warning ::

    FixOut is still in development. **The documentation is subject to change.**

FixOut is a package to help ML practitioners assess fairness in their models.
It is a Python library that provides functionalities related to fairness assessment, explanations and unfairness mitigation.

This reference manual details functions, modules, and objects included in FixOut, 
describing what they are and what they do.
You can start by looking at the User Guide section or go directly to the API definition.
For learning how to use FixOut from different examples, see the `demos page <https://fixout.fr/demos>`_.

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


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   guide.rst
   install.rst
   fixout.rst


..    .. container:: sphx-glr-download sphx-glr-download-jupyter
..
..      :download:`Download all examples in Jupyter notebooks: auto_examples_jupyter.zip </auto_examples/auto_examples_jupyter.zip>`