smile.feature

Interface TreeSHAP

All Superinterfaces:

SHAP<smile.data.Tuple>

All Known Implementing Classes:

AdaBoost, GradientTreeBoost, RandomForest, RandomForest

public interface TreeSHAP
extends SHAP<smile.data.Tuple>

SHAP of ensemble tree methods. TreeSHAP is a fast and exact method to estimate SHAP values for tree models and ensembles of trees, under several different possible assumptions about feature dependence.

Method Summary

Modifier and Type	Method and Description
smile.data.formula.Formula	formula() Returns the formula associated with the model.
default double[]	shap(smile.data.DataFrame data) Returns the average of absolute SHAP values over a data frame.
default double[]	shap(smile.data.Tuple x) Returns the SHAP values.
CART[]	trees() Returns the classification/regression trees.

Methods inherited from interface smile.feature.SHAP

shap

Method Detail

trees

CART[] trees()

Returns the classification/regression trees.

formula

smile.data.formula.Formula formula()

Returns the formula associated with the model.

shap

default double[] shap(smile.data.Tuple x)

Description copied from interface: SHAP

Returns the SHAP values. For regression, the length of SHAP values is same as the number of features. For classification, SHAP values are of p x k, where p is the number of features and k is the classes. The first k elements are the SHAP values of first feature over k classes, respectively. The rest features follow accordingly.

Specified by:

shap in interface SHAP<smile.data.Tuple>

Parameters:

x - an instance.

Returns:

the SHAP values.

shap

default double[] shap(smile.data.DataFrame data)

Returns the average of absolute SHAP values over a data frame.