.. xai-compare documentation master file, created by
   sphinx-quickstart on Tue Jul 30 13:26:36 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

xai-compare documentation
=========================

.. image:: images/xai-compare_logo.png
   :width: 300px
   :align: center

.. raw:: html

   <br>

**XAI-Compare** is a platform for evaluating explanability methods of machine learning models.
The link of the github repository can be found `here <https://github.com/emunaran/xai-compare>`_.

Install
=======

XAI-Compare can be installed from `PyPI <https://pypi.org/project/xai-compare>`_ ::

   pip install xai-compare


.. toctree::
   :maxdepth: 2
   :caption: Contents:

   API reference <api_reference>

.. toctree::
   :maxdepth: 1
   :caption: Development

   Release notes <release_notes>