Toggle navigation sidebar
Toggle in-page Table of Contents
SolasAI documentation
Getting Started
SolasAI Disparity Introduction
SolasAI Disparity Calculations
SolasAI Disparity Plots
Python API Reference
solas_disparity
adverse_impact_ratio
adverse_impact_ratio_by_quantile
categorical_adverse_impact_ratio
custom_disparity_metric
false_discovery_rate
false_negative_rate
false_positive_rate
odds_ratio
pgrg_ordered
precision
residual_standardized_mean_difference
scoring_impact_ratio
segmented_adverse_impact_ratio
selection_impact_ratio
standardized_mean_difference
true_negative_rate
true_positive_rate
solas_disparity.const
solas_disparity.disparity
adverse_impact_ratio
adverse_impact_ratio_by_quantile
categorical_adverse_impact_ratio
custom_disparity_metric
false_discovery_rate
false_negative_rate
false_positive_rate
odds_ratio
precision
residual_standardized_mean_difference
scoring_impact_ratio
segmented_adverse_impact_ratio
selection_impact_ratio
standardized_mean_difference
true_negative_rate
true_positive_rate
solas_disparity.plots
plot_adverse_impact_ratio
plot_adverse_impact_ratio_by_quantile
plot_categorical_adverse_impact_ratio
plot_custom_disparity_metric
plot_false_discovery_rate
plot_false_negative_rate
plot_false_positive_rate
plot_odds_ratio
plot_precision
plot_residual_standardized_mean_difference
plot_scoring_impact_ratio
plot_segmented_adverse_impact_ratio
plot_selection_impact_ratio
plot_standardized_mean_difference
plot_true_negative_rate
plot_true_positive_rate
plot_wasserstein
solas_disparity.statistical_significance
bootstrapping
chi_squared_test
fishers_exact
fishers_or_chi_squared
stacked_regression
two_sample_t_test
solas_disparity.types
DifferenceCalculation
Disparity
DisparityCalculation
DisparityResponse
EnumBase
RatioCalculation
ResidualSMDDenominator
SMDDenominator
ShortfallMethod
StatSig
StatSigRegressionType
StatSigTest
solas_disparity.utils
pgrg_ordered
repository
open issue
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
_
__init__() (solas_disparity.types.Disparity method)
(solas_disparity.types.StatSig method)
A
adverse_impact_ratio() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
adverse_impact_ratio_by_quantile() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
affected_categories (solas_disparity.types.Disparity property)
affected_groups (solas_disparity.types.Disparity property)
affected_reference (solas_disparity.types.Disparity property)
air_threshold (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
B
bootstrapping() (in module solas_disparity.statistical_significance)
C
categorical_adverse_impact_ratio() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
chi_squared_test() (in module solas_disparity.statistical_significance)
custom_disparity_metric() (in module solas_disparity)
(in module solas_disparity.disparity)
D
difference_calculation (solas_disparity.types.Disparity attribute)
difference_threshold (solas_disparity.types.Disparity attribute)
DifferenceCalculation (class in solas_disparity.types)
Disparity (class in solas_disparity.types)
,
[1]
disparity_type (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
DisparityCalculation (class in solas_disparity.types)
DisparityResponse (class in solas_disparity.types)
drop_small_groups (solas_disparity.types.Disparity attribute)
E
EnumBase (class in solas_disparity.types)
F
false_discovery_rate() (in module solas_disparity)
(in module solas_disparity.disparity)
false_negative_rate() (in module solas_disparity)
(in module solas_disparity.disparity)
false_positive_rate() (in module solas_disparity)
(in module solas_disparity.disparity)
fdr_threshold (solas_disparity.types.Disparity attribute)
fishers_exact() (in module solas_disparity.statistical_significance)
fishers_or_chi_squared() (in module solas_disparity.statistical_significance)
G
group_categories (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
L
label (solas_disparity.types.DisparityResponse attribute)
lower_score_favorable (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
M
max_for_fishers (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
metric (solas_disparity.types.Disparity attribute)
module
solas_disparity
solas_disparity.const
solas_disparity.disparity
solas_disparity.plots
solas_disparity.statistical_significance
solas_disparity.types
solas_disparity.utils
O
odds_ratio() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
odds_ratio_threshold (solas_disparity.types.Disparity attribute)
outcome (solas_disparity.types.DisparityResponse attribute)
P
p_value_threshold (solas_disparity.types.Disparity attribute)
percent_difference_threshold (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
pgrg_ordered() (in module solas_disparity)
(in module solas_disparity.utils)
plot_adverse_impact_ratio() (in module solas_disparity.plots)
plot_adverse_impact_ratio_by_quantile() (in module solas_disparity.plots)
plot_categorical_adverse_impact_ratio() (in module solas_disparity.plots)
plot_custom_disparity_metric() (in module solas_disparity.plots)
plot_false_discovery_rate() (in module solas_disparity.plots)
plot_false_negative_rate() (in module solas_disparity.plots)
plot_false_positive_rate() (in module solas_disparity.plots)
plot_json (solas_disparity.types.DisparityResponse attribute)
plot_odds_ratio() (in module solas_disparity.plots)
plot_precision() (in module solas_disparity.plots)
plot_residual_standardized_mean_difference() (in module solas_disparity.plots)
plot_scoring_impact_ratio() (in module solas_disparity.plots)
plot_segmented_adverse_impact_ratio() (in module solas_disparity.plots)
plot_selection_impact_ratio() (in module solas_disparity.plots)
plot_standardized_mean_difference() (in module solas_disparity.plots)
plot_true_negative_rate() (in module solas_disparity.plots)
plot_true_positive_rate() (in module solas_disparity.plots)
plot_wasserstein() (in module solas_disparity.plots)
precision() (in module solas_disparity)
(in module solas_disparity.disparity)
protected_groups (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
R
ratio_calculation (solas_disparity.types.Disparity attribute)
ratio_threshold (solas_disparity.types.Disparity attribute)
RatioCalculation (class in solas_disparity.types)
reference_groups (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
report (solas_disparity.types.Disparity property)
residual_smd_denominator (solas_disparity.types.Disparity attribute)
residual_smd_threshold (solas_disparity.types.Disparity attribute)
residual_standardized_mean_difference() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
ResidualSMDDenominator (class in solas_disparity.types)
S
sample_weight (solas_disparity.types.DisparityResponse attribute)
scoring_impact_ratio() (in module solas_disparity)
(in module solas_disparity.disparity)
segmented_adverse_impact_ratio() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
selection_impact_ratio() (in module solas_disparity)
(in module solas_disparity.disparity)
shift_zeros (solas_disparity.types.Disparity attribute)
shortfall_method (solas_disparity.types.Disparity attribute)
ShortfallMethod (class in solas_disparity.types)
small_group_table (solas_disparity.types.Disparity attribute)
smd_denominator (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
smd_threshold (solas_disparity.types.Disparity attribute)
(solas_disparity.types.DisparityResponse attribute)
SMDDenominator (class in solas_disparity.types)
solas_disparity
module
solas_disparity.const
module
solas_disparity.disparity
module
solas_disparity.plots
module
solas_disparity.statistical_significance
module
solas_disparity.types
module
solas_disparity.utils
module
stacked_regression() (in module solas_disparity.statistical_significance)
standardized_mean_difference() (in module solas_disparity)
,
[1]
(in module solas_disparity.disparity)
stat_sig_test (solas_disparity.types.StatSig attribute)
statistical_significance (solas_disparity.types.Disparity attribute)
statistical_significance_test (solas_disparity.types.Disparity attribute)
StatSig (class in solas_disparity.types)
,
[1]
StatSigRegressionType (class in solas_disparity.types)
StatSigTest (class in solas_disparity.types)
summary_table (solas_disparity.types.Disparity attribute)
(solas_disparity.types.StatSig attribute)
summary_table_json (solas_disparity.types.DisparityResponse attribute)
summary_table_json_flat (solas_disparity.types.DisparityResponse attribute)
T
to_excel() (solas_disparity.types.Disparity method)
true_negative_rate() (in module solas_disparity)
(in module solas_disparity.disparity)
true_positive_rate() (in module solas_disparity)
(in module solas_disparity.disparity)
two_sample_t_test() (in module solas_disparity.statistical_significance)
U
unknown_table (solas_disparity.types.Disparity attribute)