hex.genmodel.algos.tree

Class ContributionsPredictor<E>

java.lang.Object

hex.genmodel.algos.tree.ContributionsPredictor<E>

All Implemented Interfaces:

PredictContributions, java.io.Serializable

Direct Known Subclasses:

SharedTreeMojoModelWithContributions.SharedTreeContributionsPredictor

public abstract class ContributionsPredictor<E>
extends java.lang.Object
implements PredictContributions

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ContributionsPredictor(int ncontribs, java.lang.String[] featureContributionNames, TreeSHAPPredictor<E> treeSHAPPredictor)

Method Summary

Modifier and Type	Method and Description
float[]	calculateContributions(double[] input) Calculate contributions (SHAP values) for a given input row.
FeatureContribution[]	calculateContributions(double[] input, int topN, int bottomN, boolean compareAbs)
float[]	getContribs(float[] contribs)
java.lang.String[]	getContributionNames()
protected abstract E	toInputRow(double[] input)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContributionsPredictor

public ContributionsPredictor(int ncontribs,
                              java.lang.String[] featureContributionNames,
                              TreeSHAPPredictor<E> treeSHAPPredictor)

Method Detail

getContributionNames

public final java.lang.String[] getContributionNames()

Specified by:

getContributionNames in interface PredictContributions

calculateContributions

public final float[] calculateContributions(double[] input)

Description copied from interface: PredictContributions

Calculate contributions (SHAP values) for a given input row.

Specified by:

calculateContributions in interface PredictContributions

Parameters:

input - input data

Returns:

per-feature contributions, last value is the model bias

toInputRow

protected abstract E toInputRow(double[] input)

getContribs

public float[] getContribs(float[] contribs)

calculateContributions

public FeatureContribution[] calculateContributions(double[] input,
                                                    int topN,
                                                    int bottomN,
                                                    boolean compareAbs)

Specified by:

calculateContributions in interface PredictContributions