.. ACFX documentation master file, created by
   sphinx-quickstart on Fri Feb 23 10:20:26 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to the ACFX documentation
---------------------------------

**ACFX** is Actionable Counterfactual eXplainer. It is a model-agnostic XAI algorithm that provides actionable counterfactual explanations for any type of machine-learning model.



Install
=======

**acfx** package can be installed from either `PyPI <https://pypi.org/project/acfx>`_ or directly from source code `GitHub <https://github.com/sbobek/acfx>`_

To install form PyPI::

   pip install acfx

To install from source code::

   git clone https://github.com/sbobek/acfx
   cd acfx/src
   pip install .

.. toctree::
   :maxdepth: 2
   :caption: Examples

   Basic Usage examples <basic_examples>


.. toctree::
   :maxdepth: 2
   :caption: Reference

   API reference <api>

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

   Release notes <release_notes>
   Contributing guide <contributing>