Package: flashlight 0.9.0.9000

flashlight: Shed Light on Black Box Machine Learning Models

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) <arxiv:1612.08468>), further effects plots, interaction strength, and variable contribution breakdown (Gosiewska and Biecek (2019) <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.

Authors:Michael Mayer [aut, cre, cph]

flashlight_0.9.0.9000.tar.gz
flashlight_0.9.0.9000.zip(r-4.5)flashlight_0.9.0.9000.zip(r-4.4)flashlight_0.9.0.9000.zip(r-4.3)
flashlight_0.9.0.9000.tgz(r-4.4-any)flashlight_0.9.0.9000.tgz(r-4.3-any)
flashlight_0.9.0.9000.tar.gz(r-4.5-noble)flashlight_0.9.0.9000.tar.gz(r-4.4-noble)
flashlight_0.9.0.9000.tgz(r-4.4-emscripten)flashlight_0.9.0.9000.tgz(r-4.3-emscripten)
flashlight.pdf |flashlight.html
flashlight/json (API)
NEWS

# Install 'flashlight' in R:
install.packages('flashlight', repos = c('https://mayer79.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/mayer79/flashlight/issues

On CRAN:

interpretabilityinterpretable-machine-learningmachine-learningxai

41 exports 22 stars 2.41 score 39 dependencies 1 dependents 49 scripts 579 downloads

Last updated 2 months agofrom:54e44b44e3. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKAug 23 2024
R-4.5-winNOTEAug 23 2024
R-4.5-linuxNOTEAug 23 2024
R-4.4-winNOTEAug 23 2024
R-4.4-macNOTEAug 23 2024
R-4.3-winOKAug 23 2024
R-4.3-macOKAug 23 2024

Exports:add_shapflashlightis.flashlightis.lightis.light_breakdownis.light_breakdown_multiis.light_effectsis.light_effects_multiis.light_global_surrogateis.light_global_surrogate_multiis.light_iceis.light_ice_multiis.light_importanceis.light_importance_multiis.light_performanceis.light_performance_multiis.light_profileis.light_profile_multiis.light_profile2dis.light_profile2d_multiis.light_scatteris.light_scatter_multiis.multiflashlightis.shaplight_breakdownlight_checklight_combinelight_effectslight_global_surrogatelight_icelight_importancelight_interactionlight_performancelight_profilelight_profile2dlight_recodelight_scattermost_importantmultiflashlightplot_countsresponse

Dependencies:clicolorspacecpp11dplyrfansifarvergenericsggplot2gluegtableisobandlabelinglatticelifecyclemagrittrMASSMatrixMetricsWeightedmgcvmunsellnlmepillarpkgconfigpurrrR6RColorBrewerrlangrpartrpart.plotscalesstringistringrtibbletidyrtidyselectutf8vctrsviridisLitewithr

Using flashlight

Rendered fromflashlight.Rmdusingknitr::rmarkdownon Aug 23 2024.

Last update: 2023-05-07
Started: 2019-08-19

Readme and manuals

Help Manual

Help pageTopics
DEPRECATEDadd_shap
Create or Update a flashlightflashlight flashlight.default flashlight.flashlight
Check functions for flashlight Classesis.flashlight is.light is.light_breakdown is.light_breakdown_multi is.light_effects is.light_effects_multi is.light_global_surrogate is.light_global_surrogate_multi is.light_ice is.light_ice_multi is.light_importance is.light_importance_multi is.light_performance is.light_performance_multi is.light_profile is.light_profile2d is.light_profile2d_multi is.light_profile_multi is.light_scatter is.light_scatter_multi is.multiflashlight is.shap
Variable Contribution Breakdown for Single Observationlight_breakdown light_breakdown.default light_breakdown.flashlight light_breakdown.multiflashlight
Check flashlightlight_check light_check.default light_check.flashlight light_check.multiflashlight
Combine Objectslight_combine light_combine.default light_combine.light light_combine.list
Combination of Response, Predicted, Partial Dependence, and ALE profiles.light_effects light_effects.default light_effects.flashlight light_effects.multiflashlight
Global Surrogate Treelight_global_surrogate light_global_surrogate.default light_global_surrogate.flashlight light_global_surrogate.multiflashlight
Individual Conditional Expectation (ICE)light_ice light_ice.default light_ice.flashlight light_ice.multiflashlight
Permutation Variable Importancelight_importance light_importance.default light_importance.flashlight light_importance.multiflashlight
Interaction Strengthlight_interaction light_interaction.default light_interaction.flashlight light_interaction.multiflashlight
Model Performance of Flashlightlight_performance light_performance.default light_performance.flashlight light_performance.multiflashlight
Partial Dependence and other Profileslight_profile light_profile.default light_profile.flashlight light_profile.multiflashlight
2D Partial Dependence and other 2D Profileslight_profile2d light_profile2d.default light_profile2d.flashlight light_profile2d.multiflashlight
DEPRECATEDlight_recode
Scatter Plot Datalight_scatter light_scatter.default light_scatter.flashlight light_scatter.multiflashlight
Most Important Variables.most_important
Create or Update a multiflashlightmultiflashlight multiflashlight.default multiflashlight.flashlight multiflashlight.list multiflashlight.multiflashlight
DEPRECATEDplot_counts
Visualize Variable Contribution Breakdown for Single Observationplot.light_breakdown
Visualize Multiple Types of Profiles Togetherplot.light_effects
Plot Global Surrogate Treesplot.light_global_surrogate
Visualize ICE profilesplot.light_ice
Visualize Variable Importanceplot.light_importance
Visualize Model Performanceplot.light_performance
Visualize Profiles, e.g. Partial Dependenceplot.light_profile
Visualize 2D-Profiles, e.g., of Partial Dependenceplot.light_profile2d
Scatter Plotplot.light_scatter
Predictions for flashlightpredict.flashlight
Predictions for multiflashlightpredict.multiflashlight
Prints a flashlightprint.flashlight
Prints light Objectprint.light
Prints a multiflashlightprint.multiflashlight
Residuals for flashlightresiduals.flashlight
Residuals for multiflashlightresiduals.multiflashlight
Response of multi/-flashlightresponse response.default response.flashlight response.multiflashlight