SharedTreeMojoModel (h2o-genmodel 3.46.0 API)

java.lang.Object
- hex.genmodel.GenModel
- - hex.genmodel.MojoModel
  - - hex.genmodel.algos.tree.SharedTreeMojoModel

All Implemented Interfaces:

CalibrationMojoHelper.MojoModelWithCalibration, SharedTreeGraphConverter, TreeBackedMojoModel, IGenModel, java.io.Serializable, IGeneratedModel

Direct Known Subclasses:

IsolationForestMojoModel, SharedTreeMojoModelWithContributions, UpliftDrfMojoModel
```
public abstract class SharedTreeMojoModel
extends MojoModel
implements TreeBackedMojoModel, CalibrationMojoHelper.MojoModelWithCalibration
```
Common ancestor for DrfMojoModel and GbmMojoModel. See also: `hex.tree.SharedTreeModel` and `hex.tree.TreeVisitor` classes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SharedTreeMojoModel.AuxInfo`
`static interface`	`SharedTreeMojoModel.DecisionPathTracker<T>`
`static class`	`SharedTreeMojoModel.LeafDecisionPathTracker`
`static class`	`SharedTreeMojoModel.LeafNodeAssignments`
`static class`	`SharedTreeMojoModel.StringDecisionPathTracker`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`__INTERNAL_MAX_TREE_DEPTH`
`protected double[]`	`_calib_glm_beta` GLM's beta used for calibrating output probabilities using Platt Scaling.
`protected byte[][]`	`_compressed_trees` Array of binary tree data, each tree being a `byte[]` array.
`protected byte[][]`	`_compressed_trees_aux` Array of auxiliary binary tree data, each being a `byte[]` array.
`protected java.lang.String`	`_genmodel_encoding`
`protected IsotonicCalibrator`	`_isotonic_calibrator` For calibrating using Isotonic Regression
`protected int`	`_ntree_groups` `_ntree_groups` is the number of trees requested by the user.
`protected int`	`_ntrees_per_group`
`protected java.lang.String[][]`	`_orig_domain_values`
`protected java.lang.String[]`	`_orig_names`
`protected double[]`	`_orig_projection_array`

Fields inherited from class hex.genmodel.MojoModel
_algoName, _balanceClasses, _category, _defaultThreshold, _h2oVersion, _modelAttributes, _modelClassDistrib, _modelDescriptor, _mojo_version, _nclasses, _nfeatures, _priorClassDistrib, _reproducibilityInformation, _supervised, _uuid

Fields inherited from class hex.genmodel.GenModel
_domains, _names, _offsetColumn, _responseColumn, _treatmentColumn

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`SharedTreeMojoModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn)`
`protected`	`SharedTreeMojoModel(java.lang.String[] columns, java.lang.String[][] domains, java.lang.String responseColumn, java.lang.String treatmentColumn)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SharedTreeGraph`	`_computeGraph(int treeId)` Deprecated.
`boolean`	`calibrateClassProbabilities(double[] preds)` Subclasses implement calibration of class probabilities.
`SharedTreeGraph`	`computeGraph(int treeId)`
`SharedTreeGraph`	`computeGraph(int treeToPrint, ConvertTreeOptions options)` Compute a graph of the forest.
`static SharedTreeSubgraph`	`computeTreeGraph(int treeNum, java.lang.String treeName, byte[] tree, byte[] auxTreeInfo, java.lang.String[] names, java.lang.String[][] domains)`
`static SharedTreeSubgraph`	`computeTreeGraph(int treeNum, java.lang.String treeName, byte[] tree, byte[] auxTreeInfo, java.lang.String[] names, java.lang.String[][] domains, ConvertTreeOptions options)`
`SharedTreeGraph`	`convert(int treeNumber, java.lang.String treeClass)`
`SharedTreeGraph`	`convert(int treeNumber, java.lang.String treeClass, ConvertTreeOptions options)` Converts internal tree representation to a shared representation.
`static int`	`findMaxNodeId(byte[] auxTreeInfo)`
`double[]`	`getCalibGlmBeta()`
`CategoricalEncoding`	`getCategoricalEncoding()` Return type of encoding expected by the model implementation.
`static java.lang.String`	`getDecisionPath(double leafAssignment)`
`java.lang.String[]`	`getDecisionPath(double[] row)`
`static <T> T`	`getDecisionPath(double leafAssignment, SharedTreeMojoModel.DecisionPathTracker<T> tr)`
`java.lang.String[]`	`getDecisionPathNames()`
`IsotonicCalibrator`	`getIsotonicCalibrator()`
`SharedTreeMojoModel.LeafNodeAssignments`	`getLeafNodeAssignments(double[] row)`
`static int`	`getLeafNodeId(double leafAssignment, byte[] auxTree)`
`int`	`getNTreeGroups()`
`int`	`getNTreesPerGroup()`
`java.lang.String[][]`	`getOrigDomainValues()` Returns original domain values for all columns including response column.
`java.lang.String[]`	`getOrigNames()` The original names of all columns used, including response and offset columns.
`double[]`	`getOrigProjectionArray()` Returns original Eigen encoder projections array for all columns.
`protected void`	`postInit()`
`static java.util.Map<java.lang.Integer,SharedTreeMojoModel.AuxInfo>`	`readAuxInfos(byte[] auxTreeInfo)`
`protected void`	`scoreAllTrees(double[] row, double[] preds)` Score all trees and fill in the `preds` array.
`void`	`scoreSingleTree(double[] row, int index, double[] preds)` Generates a (per-class) prediction using only a single tree.
`double[]`	`scoreStagedPredictions(double[] row, int predsLength)` Returns staged predictions of tree algorithms (prediction probabilities of trees per iteration).
`static double`	`scoreTree(byte[] tree, double[] row, boolean computeLeafAssignment, java.lang.String[][] domains)` Highly efficient (critical path) tree scoring Given a tree (in the form of a byte array) and the row of input data, compute either this tree's predicted value when `computeLeafAssignment` is false, or the the decision path within the tree (but no more than 64 levels) when `computeLeafAssignment` is true.
`static double`	`scoreTree(byte[] tree, double[] row, int nclasses, boolean computeLeafAssignment, java.lang.String[][] domains)` Deprecated. use `scoreTree(byte[], double[], boolean, String[][])` instead.
`static double`	`scoreTree0(byte[] tree, double[] row, boolean computeLeafAssignment)` SET IN STONE FOR MOJO VERSION "1.00" - DO NOT CHANGE
`static double`	`scoreTree0(byte[] tree, double[] row, int nclasses, boolean computeLeafAssignment)` Deprecated. use `scoreTree0(byte[], double[], boolean)` instead.
`static double`	`scoreTree1(byte[] tree, double[] row, boolean computeLeafAssignment)` SET IN STONE FOR MOJO VERSION "1.10" - DO NOT CHANGE
`static double`	`scoreTree1(byte[] tree, double[] row, int nclasses, boolean computeLeafAssignment)` Deprecated. use `scoreTree1(byte[], double[], boolean)` instead.
`void`	`scoreTreeRange(double[] row, int fromIndex, int toIndex, double[] preds)` Generates (partial, per-class) predictions using only trees from a given range.
`byte[]`	`treeBytes(int groupIndex, int classIndex)`
`static java.lang.String`	`treeName(int groupIndex, int classIndex, java.lang.String[] domainValues)`
`abstract double[]`	`unifyPreds(double[] row, double offset, double[] preds)` Transforms tree predictions into the final model predictions.
`static void`	`writeUpdatedAuxInfos(byte[] origAux, java.util.Map<java.lang.Integer,SharedTreeMojoModel.AuxInfo> updatedAuxInfos, java.nio.ByteBuffer bb)`

Methods inherited from class hex.genmodel.MojoModel
getModelCategory, getUUID, isSupervised, load, load, load, nclasses, nfeatures

Methods inherited from class hex.genmodel.GenModel
bitSetContains, bitSetIsInRange, convertDouble2Float, correctProbabilities, createAuxKey, features, GBM_rescale, getColIdx, getDomainValues, getDomainValues, getDomainValues, getHeader, getModelCategories, getNames, getNumClasses, getNumCols, getNumResponseClasses, getOffsetName, getOrigNumCols, getOutputDomains, getOutputNames, getPrediction, getPredictionBinomial, getPredictionMultinomial, getPredsSize, getPredsSize, getResponseIdx, getResponseName, GLM_identityInv, GLM_inverseInv, GLM_logInv, GLM_logitInv, GLM_ologitInv, GLM_tweedieInv, img2pixels, internal_threadSafeInstance, isAutoEncoder, isClassifier, KMeans_closest, KMeans_distance, KMeans_distance, KMeans_distances, Kmeans_preprocessData, Kmeans_preprocessData, KMeans_simplex, log_rescale, mapEnum, nCatFeatures, requiresOffset, score0, score0, setCats, setCats, setInput, setInput

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hex.genmodel.algos.tree.TreeBackedMojoModel
getInitF

- Field Detail
  - _ntree_groups
```
protected int _ntree_groups
```
    _ntree_groups is the number of trees requested by the user. For binomial case or regression this is also the total number of trees trained; however in multinomial case each requested "tree" is actually represented as a group of trees, with _ntrees_per_group trees in each group. Each of these individual trees assesses the likelihood that a given observation belongs to class A, B, C, etc. of a multiclass response.
  - _ntrees_per_group
```
protected int _ntrees_per_group
```
  - _compressed_trees
```
protected byte[][] _compressed_trees
```
    Array of binary tree data, each tree being a byte[] array. The trees are logically grouped into a rectangular grid of dimensions _ntree_groups x _ntrees_per_group, however physically they are stored as 1-dimensional list, and an [i, j] logical tree is mapped to the index treeIndex(int, int).
  - _compressed_trees_aux
```
protected byte[][] _compressed_trees_aux
```
    Array of auxiliary binary tree data, each being a byte[] array.
  - _calib_glm_beta
```
protected double[] _calib_glm_beta
```
    GLM's beta used for calibrating output probabilities using Platt Scaling.
  - _isotonic_calibrator
```
protected IsotonicCalibrator _isotonic_calibrator
```
    For calibrating using Isotonic Regression
  - _genmodel_encoding
```
protected java.lang.String _genmodel_encoding
```
  - _orig_names
```
protected java.lang.String[] _orig_names
```
  - _orig_domain_values
```
protected java.lang.String[][] _orig_domain_values
```
  - _orig_projection_array
```
protected double[] _orig_projection_array
```
  - __INTERNAL_MAX_TREE_DEPTH
```
public static final int __INTERNAL_MAX_TREE_DEPTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SharedTreeMojoModel
```
protected SharedTreeMojoModel(java.lang.String[] columns,
                              java.lang.String[][] domains,
                              java.lang.String responseColumn)
```
  - SharedTreeMojoModel
```
protected SharedTreeMojoModel(java.lang.String[] columns,
                              java.lang.String[][] domains,
                              java.lang.String responseColumn,
                              java.lang.String treatmentColumn)
```
- Method Detail
  - postInit
```
protected void postInit()
```
  - getNTreeGroups
```
public final int getNTreeGroups()
```
    Specified by:
    
    getNTreeGroups in interface TreeBackedMojoModel
  - getNTreesPerGroup
```
public final int getNTreesPerGroup()
```
    Specified by:
    
    getNTreesPerGroup in interface TreeBackedMojoModel
  - scoreTree0
```
@Deprecated
public static double scoreTree0(byte[] tree,
                                            double[] row,
                                            int nclasses,
                                            boolean computeLeafAssignment)
```
    Deprecated. use scoreTree0(byte[], double[], boolean) instead.
  - scoreTree1
```
@Deprecated
public static double scoreTree1(byte[] tree,
                                            double[] row,
                                            int nclasses,
                                            boolean computeLeafAssignment)
```
    Deprecated. use scoreTree1(byte[], double[], boolean) instead.
  - scoreTree
```
@Deprecated
public static double scoreTree(byte[] tree,
                                           double[] row,
                                           int nclasses,
                                           boolean computeLeafAssignment,
                                           java.lang.String[][] domains)
```
    Deprecated. use scoreTree(byte[], double[], boolean, String[][]) instead.
  - scoreTree
```
public static double scoreTree(byte[] tree,
                               double[] row,
                               boolean computeLeafAssignment,
                               java.lang.String[][] domains)
```
    Highly efficient (critical path) tree scoring Given a tree (in the form of a byte array) and the row of input data, compute either this tree's predicted value when `computeLeafAssignment` is false, or the the decision path within the tree (but no more than 64 levels) when `computeLeafAssignment` is true. If path has 64 levels or more, Double.NaN is returned. Note: this function is also used from the `hex.tree.CompressedTree` class in `h2o-algos` project.
  - getCategoricalEncoding
```
public CategoricalEncoding getCategoricalEncoding()
```
    Description copied from class: GenModel
    
    Return type of encoding expected by the model implementation.
    
    Specified by:
    
    getCategoricalEncoding in interface IGeneratedModel
    
    Overrides:
    
    getCategoricalEncoding in class GenModel
  - getOrigNames
```
public java.lang.String[] getOrigNames()
```
    Description copied from class: GenModel
    
    The original names of all columns used, including response and offset columns.
    
    Specified by:
    
    getOrigNames in interface IGeneratedModel
    
    Overrides:
    
    getOrigNames in class GenModel
  - getOrigProjectionArray
```
public double[] getOrigProjectionArray()
```
    Description copied from class: GenModel
    
    Returns original Eigen encoder projections array for all columns.
    
    Specified by:
    
    getOrigProjectionArray in interface IGeneratedModel
    
    Overrides:
    
    getOrigProjectionArray in class GenModel
  - getOrigDomainValues
```
public java.lang.String[][] getOrigDomainValues()
```
    Description copied from interface: IGeneratedModel
    
    Returns original domain values for all columns including response column.
    
    Specified by:
    
    getOrigDomainValues in interface IGeneratedModel
    
    Overrides:
    
    getOrigDomainValues in class GenModel
  - getDecisionPath
```
public static <T> T getDecisionPath(double leafAssignment,
                                    SharedTreeMojoModel.DecisionPathTracker<T> tr)
```
  - getDecisionPath
```
public static java.lang.String getDecisionPath(double leafAssignment)
```
  - getLeafNodeId
```
public static int getLeafNodeId(double leafAssignment,
                                byte[] auxTree)
```
  - computeGraph
```
public SharedTreeGraph computeGraph(int treeToPrint,
                                    ConvertTreeOptions options)
```
    Compute a graph of the forest.
    
    Returns:
    
    A graph of the forest.
  - computeGraph
```
public SharedTreeGraph computeGraph(int treeId)
```
  - _computeGraph
```
@Deprecated
public SharedTreeGraph _computeGraph(int treeId)
```
    Deprecated.
  - computeTreeGraph
```
public static SharedTreeSubgraph computeTreeGraph(int treeNum,
                                                  java.lang.String treeName,
                                                  byte[] tree,
                                                  byte[] auxTreeInfo,
                                                  java.lang.String[] names,
                                                  java.lang.String[][] domains)
```
  - computeTreeGraph
```
public static SharedTreeSubgraph computeTreeGraph(int treeNum,
                                                  java.lang.String treeName,
                                                  byte[] tree,
                                                  byte[] auxTreeInfo,
                                                  java.lang.String[] names,
                                                  java.lang.String[][] domains,
                                                  ConvertTreeOptions options)
```
  - readAuxInfos
```
public static java.util.Map<java.lang.Integer,SharedTreeMojoModel.AuxInfo> readAuxInfos(byte[] auxTreeInfo)
```
  - findMaxNodeId
```
public static int findMaxNodeId(byte[] auxTreeInfo)
```
  - writeUpdatedAuxInfos
```
public static void writeUpdatedAuxInfos(byte[] origAux,
                                        java.util.Map<java.lang.Integer,SharedTreeMojoModel.AuxInfo> updatedAuxInfos,
                                        java.nio.ByteBuffer bb)
```
  - treeName
```
public static java.lang.String treeName(int groupIndex,
                                        int classIndex,
                                        java.lang.String[] domainValues)
```
  - scoreAllTrees
```
protected void scoreAllTrees(double[] row,
                             double[] preds)
```
    Score all trees and fill in the `preds` array.
  - unifyPreds
```
public abstract double[] unifyPreds(double[] row,
                                    double offset,
                                    double[] preds)
```
    Transforms tree predictions into the final model predictions. For classification: converts tree preds into probability distribution and picks predicted class. For regression: projects tree prediction from link-space into the original space.
    
    Parameters:
    
    row - input row.
    
    offset - offset.
    
    preds - final output, same structure as of GenModel.score0(double[], double[]).
    
    Returns:
    
    preds array.
  - scoreSingleTree
```
public final void scoreSingleTree(double[] row,
                                  int index,
                                  double[] preds)
```
    Generates a (per-class) prediction using only a single tree.
    
    Parameters:
    
    row - input row
    
    index - index of the tree (0..N-1)
    
    preds - array of partial predictions.
  - scoreTreeRange
```
public final void scoreTreeRange(double[] row,
                                 int fromIndex,
                                 int toIndex,
                                 double[] preds)
```
    Generates (partial, per-class) predictions using only trees from a given range.
    
    Parameters:
    
    row - input row
    
    fromIndex - low endpoint (inclusive) of the tree range
    
    toIndex - high endpoint (exclusive) of the tree range
    
    preds - array of partial predictions. To get final predictions pass the result to unifyPreds(double[], double, double[]).
  - getDecisionPathNames
```
public java.lang.String[] getDecisionPathNames()
```
  - getLeafNodeAssignments
```
public SharedTreeMojoModel.LeafNodeAssignments getLeafNodeAssignments(double[] row)
```
    Specified by:
    
    getLeafNodeAssignments in interface TreeBackedMojoModel
  - getDecisionPath
```
public java.lang.String[] getDecisionPath(double[] row)
```
    Specified by:
    
    getDecisionPath in interface TreeBackedMojoModel
  - treeBytes
```
public final byte[] treeBytes(int groupIndex,
                              int classIndex)
```
  - scoreTree0
```
public static double scoreTree0(byte[] tree,
                                double[] row,
                                boolean computeLeafAssignment)
```
    SET IN STONE FOR MOJO VERSION "1.00" - DO NOT CHANGE
    
    Parameters:
    
    tree -
    
    row -
    
    computeLeafAssignment -
    
    Returns:
  - scoreTree1
```
public static double scoreTree1(byte[] tree,
                                double[] row,
                                boolean computeLeafAssignment)
```
    SET IN STONE FOR MOJO VERSION "1.10" - DO NOT CHANGE
    
    Parameters:
    
    tree -
    
    row -
    
    computeLeafAssignment -
    
    Returns:
  - calibrateClassProbabilities
```
public boolean calibrateClassProbabilities(double[] preds)
```
    Description copied from class: GenModel
    
    Subclasses implement calibration of class probabilities. The input is array of predictions returned by the scoring function (score0). Supports classification models that were trained with calibration enabled. Original probabilities in the predictions array are overwritten by their corresponding calibrated counterparts. Return false if model doesn't support calibration.
    
    Overrides:
    
    calibrateClassProbabilities in class GenModel
  - getCalibGlmBeta
```
public double[] getCalibGlmBeta()
```
    Specified by:
    
    getCalibGlmBeta in interface CalibrationMojoHelper.MojoModelWithCalibration
  - getIsotonicCalibrator
```
public IsotonicCalibrator getIsotonicCalibrator()
```
    Specified by:
    
    getIsotonicCalibrator in interface CalibrationMojoHelper.MojoModelWithCalibration
  - convert
```
public SharedTreeGraph convert(int treeNumber,
                               java.lang.String treeClass)
```
    Specified by:
    
    convert in interface SharedTreeGraphConverter
  - convert
```
public SharedTreeGraph convert(int treeNumber,
                               java.lang.String treeClass,
                               ConvertTreeOptions options)
```
    Description copied from interface: SharedTreeGraphConverter
    
    Converts internal tree representation to a shared representation.
    
    Specified by:
    
    convert in interface SharedTreeGraphConverter
    
    Parameters:
    
    treeNumber - Number of the tree in the model to convert
    
    treeClass - Tree's class. If not specified, all the classes form a forest in the resulting SharedTreeGraph
    
    options - Allows to fine-tune the conversion process (eg. disable some internal consistency self-checks)
    
    Returns:
    
    An instance of SharedTreeGraph containing a single tree or a forest of multiple trees.
  - scoreStagedPredictions
```
public double[] scoreStagedPredictions(double[] row,
                                       int predsLength)
```
    Returns staged predictions of tree algorithms (prediction probabilities of trees per iteration). The output structure is for tree Tt and class Cc: Binomial models: [probability T1.C1, probability T2.C1, ..., Tt.C1] where Tt.C1 correspond to the the probability p0 Multinomial models: [probability T1.C1, probability T1.C2, ..., Tt.Cc]
    
    Parameters:
    
    row - Input row.
    
    predsLength - Length of prediction result.
    
    Returns:
    
    array of staged prediction probabilities

Class SharedTreeMojoModel

Nested Class Summary

Field Summary

Fields inherited from class hex.genmodel.MojoModel

Fields inherited from class hex.genmodel.GenModel

Constructor Summary

Method Summary

Methods inherited from class hex.genmodel.MojoModel

Methods inherited from class hex.genmodel.GenModel

Methods inherited from class java.lang.Object

Methods inherited from interface hex.genmodel.algos.tree.TreeBackedMojoModel

Field Detail

_ntree_groups

_ntrees_per_group

_compressed_trees

_compressed_trees_aux

_calib_glm_beta

_isotonic_calibrator

_genmodel_encoding

_orig_names

_orig_domain_values

_orig_projection_array

__INTERNAL_MAX_TREE_DEPTH

Constructor Detail

SharedTreeMojoModel

SharedTreeMojoModel

Method Detail

postInit

getNTreeGroups

getNTreesPerGroup

scoreTree0

scoreTree1

scoreTree

scoreTree

getCategoricalEncoding

getOrigNames

getOrigProjectionArray

getOrigDomainValues

getDecisionPath

getDecisionPath

getLeafNodeId

computeGraph

computeGraph

_computeGraph

computeTreeGraph

computeTreeGraph

readAuxInfos

findMaxNodeId

writeUpdatedAuxInfos

treeName

scoreAllTrees

unifyPreds

scoreSingleTree

scoreTreeRange

getDecisionPathNames

getLeafNodeAssignments

getDecisionPath

treeBytes

scoreTree0

scoreTree1

calibrateClassProbabilities

getCalibGlmBeta

getIsotonicCalibrator

convert

convert

scoreStagedPredictions