hex.genmodel.algos.tree

Class ContributionComposer

java.lang.Object

hex.genmodel.algos.tree.ContributionComposer

public class ContributionComposer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ContributionComposer()

Method Summary

Modifier and Type	Method and Description
int	checkAndAdjustInput(int n, int len)
int[]	composeContributions(int[] contribNameIds, float[] contribs, int topN, int bottomN, boolean compareAbs) Sort #contribNameIds according to #contribs values and compose desired output with correct #topN, #bottomN fields

Methods inherited from class java.lang.Object

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

Constructor Detail

ContributionComposer

public ContributionComposer()

Method Detail

composeContributions

public final int[] composeContributions(int[] contribNameIds,
                                        float[] contribs,
                                        int topN,
                                        int bottomN,
                                        boolean compareAbs)

Sort #contribNameIds according to #contribs values and compose desired output with correct #topN, #bottomN fields

Parameters:

contribNameIds - Contribution corresponding feature ids

contribs - Raw contribution values

topN - Return only #topN highest #contribNameIds + bias. If topN<0 then sort all SHAP values in descending order If topN<0 && bottomN<0 then sort all SHAP values in descending order

bottomN - Return only #bottomN lowest #contribNameIds + bias If topN and bottomN are defined together then return array of #topN + #bottomN + bias If bottomN<0 then sort all SHAP values in ascending order If topN<0 && bottomN<0 then sort all SHAP values in descending order

compareAbs - True to compare absolute values of #contribs

Returns:

Sorted contribNameIds array of corresponding contributions features. The size of returned array is #topN + #bottomN + bias

checkAndAdjustInput

public int checkAndAdjustInput(int n,
                               int len)