aif360.explainers.MetricTextExplainer¶
-
class
aif360.explainers.MetricTextExplainer(metric)[source]¶ Class for explaining metric values with text.
These briefly explain what a metric is and/or how it is calculated unless it is obvious (e.g. accuracy) and print the value.
This class contains text explanations for all metric values regardless of which subclass they appear in. This will raise an error if the metric does not apply (e.g. calling
true_positive_rateiftype(metric) == DatasetMetric).Initialize a
MetricExplainerobject.Parameters: metric (Metric) – The metric to be explained. Methods
accuracyaverage_abs_odds_differenceaverage_odds_differencebetween_all_groups_coefficient_of_variationbetween_all_groups_generalized_entropy_indexbetween_all_groups_theil_indexbetween_group_coefficient_of_variationbetween_group_generalized_entropy_indexbetween_group_theil_indexcoefficient_of_variationconsistencydisparate_impactequal_opportunity_differenceerror_rateerror_rate_differenceerror_rate_ratiofalse_discovery_ratefalse_discovery_rate_differencefalse_discovery_rate_ratiofalse_negative_ratefalse_negative_rate_differencefalse_negative_rate_ratiofalse_omission_ratefalse_omission_rate_ratiofalse_positive_ratefalse_positive_rate_differencefalse_positive_rate_ratiofalses_omission_rate_differencegeneralized_entropy_indexmean_differencenegative_predictive_valuenum_false_negativesnum_false_positivesnum_instancesnum_negativesnum_positivesnum_pred_negativesnum_pred_positivesnum_true_negativesnum_true_positivespositive_predictive_valuepowerprecisionrecallsensitivityspecificitystatistical_parity_differencetheil_indextrue_negative_ratetrue_positive_ratetrue_positive_rate_difference