fairlearn.reductions.BoundedGroupLoss#

class fairlearn.reductions.BoundedGroupLoss(loss, *, upper_bound=None)[source]#

Moment for constraining the worst-case loss by a group.

For more information refer to the user guide.

Attributes:
total_samples

Return the number of samples in the data.

Methods

bound()

Return the vector of bounds.

default_objective()

Return a default objective.

gamma(predictor)

Calculate the degree to which constraints are currently violated by the predictor.

load_data(X, y, *, sensitive_features)

Load data into the moment object.

project_lambda(lambda_vec)

Return the lambda values.

signed_weights([lambda_vec])

Return the signed weights.

bound()[source]#

Return the vector of bounds.

Returns:

A vector of bounds on group-level losses

Return type:

pandas.Series

default_objective()[source]#

Return a default objective.

gamma(predictor)[source]#

Calculate the degree to which constraints are currently violated by the predictor.

load_data(X, y, *, sensitive_features)[source]#

Load data into the moment object.

project_lambda(lambda_vec)[source]#

Return the lambda values.

signed_weights(lambda_vec=None)[source]#

Return the signed weights.

property total_samples#

Return the number of samples in the data.