.. 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:: automlx.fairness ======================= Metrics ======================= .. automodule:: automlx.fairness.metrics Evaluating a Model ------------------ Statistical Parity ^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.ModelStatisticalParityScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.model_statistical_parity True Positive Rate Disparity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.TruePositiveRateScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.true_positive_rate False Positive Rate Disparity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.FalsePositiveRateScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.false_positive_rate False Negative Rate Disparity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.FalseNegativeRateScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.false_negative_rate False Omission Rate Disparity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.FalseOmissionRateScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.false_omission_rate False Discovery Rate Disparity ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.FalseDiscoveryRateScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.false_discovery_rate Error Rate Disparity ^^^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.ErrorRateScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.error_rate Equalized Odds ^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.EqualizedOddsScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.equalized_odds Theil Index ^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._model.TheilIndexScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._model.theil_index Evaluating a Dataset -------------------- Statistical Parity ^^^^^^^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._dataset.DatasetStatisticalParityScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._dataset.dataset_statistical_parity Consistency ^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._dataset.ConsistencyScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._dataset.consistency Smoothed EDF ^^^^^^^^^^^^ .. autoclass:: automlx.fairness.metrics._dataset.SmoothedEDFScorer :members: :inherited-members: :special-members: __call__ .. autofunction:: automlx.fairness.metrics._dataset.smoothed_edf ======================= Bias Mitigation ======================= .. automodule:: automlx.fairness.bias_mitigation Bias Mitigator ^^^^^^^^^^^ .. autoclass:: automlx.fairness.bias_mitigation._sklearn.ModelBiasMitigator :members: :inherited-members: :special-members: __call__