score_gini: Gini Coefficient

In auditor: Model Audit - Verification, Validation, and Error Analysis

Gini Coefficient

Description

The Gini coefficient measures the inequality among values of a frequency distribution. A Gini coefficient equals 0 means perfect equality, where all values are the same. A Gini coefficient equals 100

Usage

score_gini(object, data = NULL, y = NULL, ...)

Arguments

object	An object of class explainer created with function explain from the DALEX package.
data	New data that will be used to calculate the score. Pass NULL if you want to use data from object.
y	New y parameter will be used to calculate score.
...	Other arguments dependent on the type of score.

Value

An object of class auditor_score.

See Also

plot_roc

Examples

library(DALEX)

# fit a model
model_glm <- glm(survived ~ ., family = binomial, data = titanic_imputed)

# create an explainer
exp_glm <- explain(model_glm,
                   data = titanic_imputed,
                   y = titanic_imputed$survived)

# calculate score
score_gini(exp_glm)

auditor documentation built on Nov. 2, 2023, 6:13 p.m.