showWaterfall: Step 3: Get prediction breakdown and waterfall chart for a...

In lantanacamara/lightgbmExplainer: An R package that makes lightgbm models fully interpretable

Description

This function prints the feature impact breakdown for a single data row, and plots an accompanying waterfall chart.

Usage

showWaterfall(lgb.model, explainer, lgb.dtrain, lgb.train.data, id,
  type = "binary", threshold = 1e-04)

Arguments

lgb.model	A trained lightgbm model
explainer	The output from the buildExplainer function, for this model
lgb.dtrain	The lgb.dtrain in which the row to be predicted is stored
lgb.train.data	The matrix of data from which the lgb.dtrain was built
type	The objective function of the model - either "binary" (for binary:logistic) or "regression" (for reg:linear)
threshold	Default = 0.0001. The waterfall chart will group all variables with absolute impact less than the threshold into a variable called 'Other'
idx	The row number of the data to be explained

Value

None

lantanacamara/lightgbmExplainer documentation built on Aug. 8, 2019, 4 p.m.