FACTS: Fairness Aware Counterfactual for Subgroups package
=============

.. contents::
   :local:
   :depth: 2
   
---

FACTS
--------------

These are the main entry points to using the FACTS framework.

.. automodule:: humancompatible.explain.facts.__init__
   :members:
   :undoc-members:
   :show-inheritance:

---

.. Preprocessing & Cleaning
.. ------------------------

.. .. automodule:: src.clean
..    :members:
..    :undoc-members:
..    :show-inheritance:

.. .. automodule:: src.formatting
..    :members:
..    :undoc-members:
..    :show-inheritance:

---

Rule Mining & Filtering
-----------------------

.. automodule:: humancompatible.explain.facts.frequent_itemsets
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: humancompatible.explain.facts.predicate
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: humancompatible.explain.facts.rule_filters
   :members:
   :undoc-members:
   :show-inheritance:

---

Metrics
--------------------

.. automodule:: humancompatible.explain.facts.metrics
   :members:
   :undoc-members:
   :show-inheritance:

---

Optimization & Utilities
------------------------

.. automodule:: humancompatible.explain.facts.optimization
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: humancompatible.explain.facts.utils
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: humancompatible.explain.facts.misc
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: humancompatible.explain.facts.parameters
   :members:
   :undoc-members:
   :show-inheritance: