Skip to content

add xgb.Booster methods to feature_effects() and partial_dependence() #60

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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: 2 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ S3method(feature_effects,H2OModel)
S3method(feature_effects,default)
S3method(feature_effects,explainer)
S3method(feature_effects,ranger)
S3method(feature_effects,xgb.Booster)
S3method(partial_dependence,H2OModel)
S3method(partial_dependence,default)
S3method(partial_dependence,explainer)
S3method(partial_dependence,ranger)
S3method(partial_dependence,xgb.Booster)
S3method(plot,EffectData)
S3method(print,EffectData)
S3method(update,EffectData)
Expand Down
47 changes: 47 additions & 0 deletions R/feature_effects.R
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,53 @@ feature_effects.H2OModel <- function(
)
}

#' @describeIn feature_effects Method for xgb.Booster models.
#' @export
feature_effects.xgb.Booster <- function(
object,
v,
data,
y = NULL,
pred = NULL,
pred_fun = stats::predict,
trafo = NULL,
which_pred = NULL,
w = NULL,
breaks = "Sturges",
right = TRUE,
discrete_m = 13L,
outlier_iqr = 2,
calc_pred = TRUE,
pd_n = 500L,
ale_n = 50000L,
ale_bin_size = 200L,
...
) {
if (!inherits(data, "matrix")) {
data = as.matrix(data)
}
feature_effects.default(
object,
v = v,
data = data,
y = y,
pred = pred,
pred_fun = pred_fun,
trafo = trafo,
which_pred = which_pred,
w = w,
breaks = breaks,
right = right,
discrete_m = discrete_m,
outlier_iqr = outlier_iqr,
calc_pred = calc_pred,
pd_n = pd_n,
ale_n = ale_n,
ale_bin_size = ale_bin_size,
...
)
}

#' Workhorse of feature_effects()
#'
#' Internal function used to calculate the output of `feature_effects()` for one
Expand Down
40 changes: 40 additions & 0 deletions R/partial_dependence.R
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,46 @@ partial_dependence.H2OModel <- function(
)
}

#' @describeIn partial_dependence Method for xgb.Booster models.
#' @export
partial_dependence.xgb.Booster <- function(
object,
v,
data,
pred_fun = stats::predict,
trafo = NULL,
which_pred = NULL,
w = NULL,
breaks = "Sturges",
right = TRUE,
discrete_m = 13L,
outlier_iqr = 2,
pd_n = 500L,
seed = NULL,
...
) {

if (!inherits(data, "matrix")) {
data = as.matrix(data)
}
partial_dependence.default(
object = object,
v = v,
data = data,
pred_fun = pred_fun,
trafo = trafo,
which_pred = which_pred,
w = w,
breaks = breaks,
right = right,
discrete_m = discrete_m,
outlier_iqr = outlier_iqr,
pd_n = pd_n,
seed = seed,
...
)
}

#' Barebone Partial Dependence
#'
#' This is a barebone implementation of Friedman's partial dependence
Expand Down
24 changes: 24 additions & 0 deletions man/feature_effects.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 20 additions & 0 deletions man/partial_dependence.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.