Reference

Explainers

Functions that generate model adapters

explain.default() explain()

Create Model Explainer

print(<explainer>)

Print Explainer Summary

Instance Level Explanations

Functions that generate and plot instance/local/predict level explanations

predict(<explainer>) model_prediction()

Predictions for the Explainer

predict_parts() predict_parts_oscillations() predict_parts_oscillations_uni() predict_parts_oscillations_emp() predict_parts_break_down() predict_parts_break_down_interactions() predict_parts_shap() predict_parts_shap_aggregated() predict_parts_kernel_shap() predict_parts_kernel_shap_break_down() predict_parts_kernel_shap_aggreagted() variable_attribution()

Instance Level Parts of the Model Predictions

predict_profile() individual_profile()

Instance Level Profile as Ceteris Paribus

predict_diagnostics() individual_diagnostics()

Instance Level Residual Diagnostics

Dataset Level Explanations

Functions that generate and plot dataset/global/model level explanations

model_performance()

Dataset Level Model Performance Measures

model_parts()

Dataset Level Variable Importance as Change in Loss Function after Variable Permutations

model_profile() variable_profile() single_variable()

Dataset Level Variable Profile as Partial Dependence or Accumulated Local Dependence Explanations

model_diagnostics()

Dataset Level Model Diagnostics

Generic print and plot functions for selected explanations

print(<predict_diagnostics>)

Print Instance Level Residual Diagnostics

plot(<predict_diagnostics>)

Plot Instance Level Residual Diagnostics

plot(<predict_parts>)

Plot Variable Attribution Explanations

plot(<predict_profile>)

Plot Variable Profile Explanations

print(<model_performance>)

Print Dataset Level Model Performance Summary

plot(<model_performance>)

Plot Dataset Level Model Performance Explanations

plot(<model_parts>)

Plot Variable Importance Explanations

plot(<shap_aggregated>)

Plot Generic for Break Down Objects

print(<model_profile>)

Print Dataset Level Model Profile

plot(<model_profile>)

Plot Dataset Level Model Profile Explanations

print(<model_diagnostics>)

Print Dataset Level Model Diagnostics

plot(<model_diagnostics>)

Plot Dataset Level Model Diagnostics

print(<description>)

Print Natural Language Descriptions

print(<model_info>)

Print model_info

Model performance measures

Model performance measures for packages from the DrWhy.AI universe

loss_cross_entropy() loss_sum_of_squares() loss_root_mean_square() loss_accuracy() loss_one_minus_accuracy() get_loss_one_minus_accuracy() loss_one_minus_auc() get_loss_default() loss_default()

Calculate Loss Functions

get_loss_yardstick() loss_yardstick()

Wrapper for Loss Functions from the yardstick Package

Supplementary functions

Shared functions for packages from the DrWhy.AI universe

update_label()

Update label of explainer object

update_data()

Update data of an explainer object

yhat yhat.lm yhat.randomForest yhat.svm yhat.gbm yhat.glm yhat.cv.glmnet yhat.glmnet yhat.ranger yhat.model_fit yhat.train yhat.lrm yhat.rpart yhat.function yhat.party yhat.default

Wrap Various Predict Functions

model_info()

Exract info from model

plot(<list>)

Plot List of Explanations

install_dependencies()

Install all dependencies for the DALEX package

colors_discrete_drwhy() colors_diverging_drwhy() colors_breakdown_drwhy()

DrWhy color palettes for ggplot objects

set_theme_dalex() theme_default_dalex() theme_vertical_default_dalex()

Default Theme for DALEX plots

theme_drwhy() theme_ema() theme_drwhy_vertical() theme_ema_vertical()

DrWhy Theme for ggplot objects

shap_aggregated()

SHAP aggregated values

variable_effect() variable_effect_partial_dependency() variable_effect_accumulated_dependency()

Dataset Level Variable Effect as Partial Dependency Profile or Accumulated Local Effects

Datasets

Datasets used in Examples and Vignettes

apartments

Apartments Data

covid_summer covid_spring

Data for early COVID mortality

dragons

Dragon Data

fifa

FIFA 20 preprocessed data

happiness_train happiness_test

World Happiness Report data

HR

Human Resources Data

titanic titanic_imputed

Passengers and Crew on the RMS Titanic Data