.. The main documentation entry for AutoMLx
   This file is a reStructuredText, please refer to https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#quick-syntax-overview
   AutoMLx uses Sphinx for documentation, specifically for cross references, please refer to https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html

******************
Fairness
******************

.. automodule:: automl.fairness

=======================
Metrics
=======================

.. automodule:: automl.fairness.metrics

Evaluating a Model
------------------

Statistical Parity
^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.ModelStatisticalParityScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.model_statistical_parity

True Positive Rate Disparity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.TruePositiveRateScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.true_positive_rate

False Positive Rate Disparity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.FalsePositiveRateScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.false_positive_rate


False Negative Rate Disparity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.FalseNegativeRateScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.false_negative_rate

False Omission Rate Disparity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.FalseOmissionRateScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.false_omission_rate

False Discovery Rate Disparity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.FalseDiscoveryRateScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.false_discovery_rate

Error Rate Disparity
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.ErrorRateScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.error_rate

Equalized Odds
^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.EqualizedOddsScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.equalized_odds

Theil Index
^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.model.TheilIndexScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.model.theil_index

Evaluating a Dataset
--------------------

Statistical Parity
^^^^^^^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.dataset.DatasetStatisticalParityScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.dataset.dataset_statistical_parity

Consistency
^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.dataset.ConsistencyScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.dataset.consistency


Smoothed EDF
^^^^^^^^^^^^

.. autoclass:: automl.fairness.metrics.dataset.SmoothedEDFScorer
    :members:
    :inherited-members:
    :special-members: __call__

.. autofunction:: automl.fairness.metrics.dataset.smoothed_edf