Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor TrustyAI fairness metrics namespaces #156

Merged
merged 1 commit into from
May 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/trustyai/metrics/__init__.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# pylint: disable = import-error, invalid-name, wrong-import-order, no-name-in-module
"""General model classes"""
from trustyai import _default_initializer # pylint: disable=unused-import
from org.kie.trustyai.explainability.metrics import (
from org.kie.trustyai.metrics.explainability import (
ExplainabilityMetrics as _ExplainabilityMetrics,
)

Expand Down
23 changes: 14 additions & 9 deletions src/trustyai/metrics/fairness/group.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@
import numpy as np
import pandas as pd
from jpype import JInt
from org.kie.trustyai.explainability.metrics import FairnessMetrics
from org.kie.trustyai.metrics.fairness.group import (
DisparateImpactRatio,
GroupStatisticalParityDifference,
GroupAverageOddsDifference,
GroupAveragePredictiveValueDifference,
)

from trustyai.model import Value, PredictionProvider, Model
from trustyai.utils.data_conversions import (
Expand Down Expand Up @@ -37,7 +42,7 @@ def statistical_parity_difference(
) -> float:
"""Calculate Statistical Parity Difference between privileged and unprivileged dataframes"""
favorable_prediction_object = one_output_convert(favorable)
return FairnessMetrics.groupStatisticalParityDifference(
return GroupStatisticalParityDifference.calculate(
to_trusty_dataframe(
data=privileged, outputs=outputs, feature_names=feature_names
),
Expand All @@ -63,7 +68,7 @@ def statistical_parity_difference_model(
_jsamples = to_trusty_dataframe(
data=samples, no_outputs=True, feature_names=feature_names
)
return FairnessMetrics.groupStatisticalParityDifference(
return GroupStatisticalParityDifference.calculate(
_jsamples,
model,
_column_selector_to_index(privilege_columns, samples),
Expand All @@ -81,7 +86,7 @@ def disparate_impact_ratio(
) -> float:
"""Calculate Disparate Impact Ration between privileged and unprivileged dataframes"""
favorable_prediction_object = one_output_convert(favorable)
return FairnessMetrics.groupDisparateImpactRatio(
return DisparateImpactRatio.calculate(
to_trusty_dataframe(
data=privileged, outputs=outputs, feature_names=feature_names
),
Expand All @@ -107,7 +112,7 @@ def disparate_impact_ratio_model(
_jsamples = to_trusty_dataframe(
data=samples, no_outputs=True, feature_names=feature_names
)
return FairnessMetrics.groupDisparateImpactRatio(
return DisparateImpactRatio.calculate(
_jsamples,
model,
_column_selector_to_index(privilege_columns, samples),
Expand Down Expand Up @@ -135,7 +140,7 @@ def average_odds_difference(
_positive_class = [Value(v) for v in positive_class]
# determine privileged columns
_privilege_columns = _column_selector_to_index(privilege_columns, test)
return FairnessMetrics.groupAverageOddsDifference(
return GroupAverageOddsDifference.calculate(
to_trusty_dataframe(data=test, outputs=outputs, feature_names=feature_names),
to_trusty_dataframe(data=truth, outputs=outputs, feature_names=feature_names),
_privilege_columns,
Expand All @@ -160,7 +165,7 @@ def average_odds_difference_model(
_positive_class = [Value(v) for v in positive_class]
# determine privileged columns
_privilege_columns = _column_selector_to_index(privilege_columns, samples)
return FairnessMetrics.groupAverageOddsDifference(
return GroupAverageOddsDifference.calculate(
_jsamples, model, _privilege_columns, _privilege_values, _positive_class
)

Expand All @@ -182,7 +187,7 @@ def average_predictive_value_difference(
_privilege_values = [Value(v) for v in privilege_values]
_positive_class = [Value(v) for v in positive_class]
_privilege_columns = _column_selector_to_index(privilege_columns, test)
return FairnessMetrics.groupAveragePredictiveValueDifference(
return GroupAveragePredictiveValueDifference.calculate(
to_trusty_dataframe(data=test, outputs=outputs, feature_names=feature_names),
to_trusty_dataframe(data=truth, outputs=outputs, feature_names=feature_names),
_privilege_columns,
Expand All @@ -205,6 +210,6 @@ def average_predictive_value_difference_model(
_positive_class = [Value(v) for v in positive_class]
# determine privileged columns
_privilege_columns = _column_selector_to_index(privilege_columns, samples)
return FairnessMetrics.groupAveragePredictiveValueDifference(
return GroupAveragePredictiveValueDifference.calculate(
_jsamples, model, _privilege_columns, _privilege_values, _positive_class
)