flashlight1.0.0 package

Shed Light on Black Box Machine Learning Models

add_shap

DEPRECATED

flashlight

Create or Update a flashlight

is.flashlight

Check functions for flashlight Classes

light_breakdown

Variable Contribution Breakdown for Single Observation

light_check

Check flashlight

light_combine

Combine Objects

light_effects

Combination of Response, Predicted, Partial Dependence, and ALE profil...

light_global_surrogate

Global Surrogate Tree

light_ice

Individual Conditional Expectation (ICE)

light_importance

Permutation Variable Importance

light_interaction

Interaction Strength

light_performance

Model Performance of Flashlight

light_profile

Partial Dependence and other Profiles

light_profile2d

2D Partial Dependence and other 2D Profiles

light_recode

DEPRECATED

light_scatter

Scatter Plot Data

most_important

Most Important Variables.

multiflashlight

Create or Update a multiflashlight

plot_counts

DEPRECATED

plot.light_breakdown

Visualize Variable Contribution Breakdown for Single Observation

plot.light_effects

Visualize Multiple Types of Profiles Together

plot.light_global_surrogate

Plot Global Surrogate Trees

plot.light_ice

Visualize ICE profiles

plot.light_importance

Visualize Variable Importance

plot.light_performance

Visualize Model Performance

plot.light_profile

Visualize Profiles, e.g. Partial Dependence

plot.light_profile2d

Visualize 2D-Profiles, e.g., of Partial Dependence

plot.light_scatter

Scatter Plot

predict.flashlight

Predictions for flashlight

predict.multiflashlight

Predictions for multiflashlight

print.flashlight

Prints a flashlight

print.light

Prints light Object

print.multiflashlight

Prints a multiflashlight

residuals.flashlight

Residuals for flashlight

residuals.multiflashlight

Residuals for multiflashlight

response

Response of multi/-flashlight

Shed light on black box machine learning models by the help of model performance, variable importance, global surrogate models, ICE profiles, partial dependence (Friedman J. H. (2001) <doi:10.1214/aos/1013203451>), accumulated local effects (Apley D. W. (2016) <doi:10.48550/arXiv.1612.08468>), further effects plots, interaction strength, and variable contribution breakdown (Gosiewska and Biecek (2019) <doi:10.48550/arXiv.1903.11420>). All tools are implemented to work with case weights and allow for stratified analysis. Furthermore, multiple flashlights can be combined and analyzed together.

  • Maintainer: Michael Mayer
  • License: GPL (>= 2)
  • Last published: 2025-10-13