hex.tree

Class SharedTreeModel<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<M>

hex.Model<M,P,O>

hex.tree.SharedTreeModel<M,P,O>

All Implemented Interfaces:

hex.Model.FeatureFrequencies, hex.Model.GetMostImportantFeatures, hex.Model.LeafNodeAssignment, hex.Model.UpdateAuxTreeWeights, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.api.StreamWriter, water.Freezable<M>

Direct Known Subclasses:

IsolationForestModel, SharedTreeModelWithContributions, UpliftDRFModel

public abstract class SharedTreeModel<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>
extends hex.Model<M,P,O>
implements hex.Model.LeafNodeAssignment, hex.Model.GetMostImportantFeatures, hex.Model.FeatureFrequencies, hex.Model.UpdateAuxTreeWeights

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SharedTreeModel.BufStringDecisionPathTracker
static class	SharedTreeModel.SharedTreeOutput
static class	SharedTreeModel.SharedTreeParameters

Nested classes/interfaces inherited from class hex.Model

hex.Model.AdaptFrameParameters, hex.Model.BigScore, hex.Model.BigScoreChunkPredict, hex.Model.BigScorePredict, hex.Model.Contributions, hex.Model.DeepFeatures, hex.Model.ExemplarMembers, hex.Model.FeatureFrequencies, hex.Model.GetMostImportantFeatures, hex.Model.GetNTrees, hex.Model.GLRMArchetypes, hex.Model.GridSortBy, hex.Model.H2OModelDescriptor, hex.Model.InteractionBuilder, hex.Model.InteractionPair, hex.Model.InteractionSpec, hex.Model.JavaModelStreamWriter, hex.Model.JavaScoringOptions, hex.Model.LeafNodeAssignment, hex.Model.Output, hex.Model.Parameters, hex.Model.PredictScoreResult, hex.Model.RowToTreeAssignment, hex.Model.StagedPredictions, hex.Model.UpdateAuxTreeWeights

Nested classes/interfaces inherited from interface hex.Model.LeafNodeAssignment

hex.Model.LeafNodeAssignment.LeafNodeAssignmentType

Nested classes/interfaces inherited from interface hex.Model.UpdateAuxTreeWeights

hex.Model.UpdateAuxTreeWeights.UpdateAuxTreeWeightsReport

Field Summary

Fields inherited from class hex.Model

_dist, _input_parms, _output, _parms, _toDelete, _warnings, _warningsP, EVAL_AUTO_PARAMS_ENABLED, evalAutoParamsEnabled, scoringInfo

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
SharedTreeModel(water.Key<M> selfKey, P parms, O output)

Method Summary

Modifier and Type	Method and Description
boolean	binomialOpt()
protected M	deepClone(water.Key<M> result) Performs deep clone of given model.
hex.genmodel.CategoricalEncoding	getGenModelEncoding()
java.lang.String[]	getMostImportantFeatures(int n)
hex.genmodel.algos.tree.SharedTreeSubgraph	getSharedTreeSubgraph(int tidx, int cls) Converts a given tree of the ensemble to a user-understandable representation.
hex.ToEigenVec	getToEigenVec()
boolean	isFeatureUsedInPredict(java.lang.String featureName)
protected java.lang.String[]	makeAllTreeColumnNames()
hex.ModelMetrics.MetricBuilder	makeMetricBuilder(java.lang.String[] domain)
protected hex.PojoWriter	makePojoWriter()
protected SharedTreePojoWriter	makeTreePojoWriter()
protected water.fvec.Frame	postProcessPredictions(water.fvec.Frame adaptedFrame, water.fvec.Frame predictFr, water.Job j)
protected water.Keyed	readAll_impl(water.AutoBuffer ab, water.Futures fs)
protected water.Futures	remove_impl(water.Futures fs, boolean cascade)
protected double[]	score0(double[] data, double[] preds)
protected double[]	score0(double[] data, double[] preds, double offset)
protected double[]	score0(double[] data, double[] preds, double offset, int ntrees)
protected double[]	score0(double[] data, double[] preds, double offset, int startTree, int ntrees)
protected double[]	score0Incremental(Score.ScoreIncInfo sii, water.fvec.Chunk[] chks, double offset, int row_in_chunk, double[] tmp, double[] preds)
water.fvec.Frame	scoreFeatureFrequencies(water.fvec.Frame frame, water.Key<water.fvec.Frame> destination_key)
water.fvec.Frame	scoreLeafNodeAssignment(water.fvec.Frame frame, hex.Model.LeafNodeAssignment.LeafNodeAssignmentType type, water.Key<water.fvec.Frame> destination_key)
hex.Model.UpdateAuxTreeWeights.UpdateAuxTreeWeightsReport	updateAuxTreeWeights(water.fvec.Frame frame, java.lang.String weightsColumn)
protected water.AutoBuffer	writeAll_impl(water.AutoBuffer ab) Write out K/V pairs

Methods inherited from class hex.Model

adaptFrameForScore, adaptTestForJavaScoring, adaptTestForTrain, adaptTestForTrain, adaptTestForTrain, addMetrics, addModelMetrics, addWarning, aic, auc, AUCPR, checksum_impl, classification_error, compareTo, computeDeviances, containsResponse, data, defaultThreshold, defaultThreshold, deleteCrossValidationFoldAssignment, deleteCrossValidationModels, deleteCrossValidationPreds, deviance, deviance, evaluateAutoModelParameters, exportBinaryModel, exportMojo, fetchAll, fillScoringInfo, getDefaultGridSortBy, getMojo, getPojoInterfaces, haveMojo, havePojo, importBinaryModel, initActualParamValues, isDistributionHuber, isFeatureUsedInPredict, isGeneric, isSupervised, last_scored, lift_top_group, likelihood, logloss, loss, mae, makeAdaptFrameParameters, makeBigScoreTask, makeInteraction, makeInteractions, makeInteractions, makeSchema, makeScoringDomains, makeScoringNames, makeScoringNames, mean_per_class_error, modelDescriptor, mse, needsPostProcess, predictScoreImpl, r2, resetThreshold, result, rmsle, score, score, score, score, score, score, score, score, score0, score0, score0PostProcessSupervised, scoreMetrics, scoring_history, scoringDomains, setInputParms, setupBigScorePredict, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, toJava, toJava, toJava, toJavaAlgo, toJavaCheckTooBig, toJavaInit, toJavaModelClassName, toJavaPredictBody, toJavaTransform, toJavaUUID, toMojo, toMojo, toString, transform, uploadBinaryModel, writeTo

Methods inherited from class water.Lockable

delete_and_lock, delete_and_lock, delete_and_lock, delete_and_lock, delete, delete, delete, delete, read_lock, read_lock, read_lock, unlock_all, unlock, unlock, unlock, unlock, update, update, update, write_lock_to_read_lock, write_lock, write_lock, write_lock

Methods inherited from class water.Keyed

checksum_impl, checksum, checksum, getKey, readAll, remove_impl, remove_self_key_impl, remove, remove, remove, remove, remove, remove, removeQuietly, writeAll

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Constructor Detail

SharedTreeModel

public SharedTreeModel(water.Key<M> selfKey,
                       P parms,
                       O output)

Method Detail

getMostImportantFeatures

public java.lang.String[] getMostImportantFeatures(int n)

Specified by:

getMostImportantFeatures in interface hex.Model.GetMostImportantFeatures

getToEigenVec

public hex.ToEigenVec getToEigenVec()

Overrides:

getToEigenVec in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

makeMetricBuilder

public hex.ModelMetrics.MetricBuilder makeMetricBuilder(java.lang.String[] domain)

Specified by:

makeMetricBuilder in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

makeAllTreeColumnNames

protected java.lang.String[] makeAllTreeColumnNames()

scoreLeafNodeAssignment

public water.fvec.Frame scoreLeafNodeAssignment(water.fvec.Frame frame,
                                                hex.Model.LeafNodeAssignment.LeafNodeAssignmentType type,
                                                water.Key<water.fvec.Frame> destination_key)

Specified by:

scoreLeafNodeAssignment in interface hex.Model.LeafNodeAssignment

updateAuxTreeWeights

public hex.Model.UpdateAuxTreeWeights.UpdateAuxTreeWeightsReport updateAuxTreeWeights(water.fvec.Frame frame,
                                                                                      java.lang.String weightsColumn)

Specified by:

updateAuxTreeWeights in interface hex.Model.UpdateAuxTreeWeights

scoreFeatureFrequencies

public water.fvec.Frame scoreFeatureFrequencies(water.fvec.Frame frame,
                                                water.Key<water.fvec.Frame> destination_key)

Specified by:

scoreFeatureFrequencies in interface hex.Model.FeatureFrequencies

postProcessPredictions

protected water.fvec.Frame postProcessPredictions(water.fvec.Frame adaptedFrame,
                                                  water.fvec.Frame predictFr,
                                                  water.Job j)

Overrides:

postProcessPredictions in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

score0Incremental

protected double[] score0Incremental(Score.ScoreIncInfo sii,
                                     water.fvec.Chunk[] chks,
                                     double offset,
                                     int row_in_chunk,
                                     double[] tmp,
                                     double[] preds)

score0

protected double[] score0(double[] data,
                          double[] preds,
                          double offset)

Overrides:

score0 in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

score0

protected double[] score0(double[] data,
                          double[] preds)

Specified by:

score0 in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

score0

protected double[] score0(double[] data,
                          double[] preds,
                          double offset,
                          int ntrees)

score0

protected double[] score0(double[] data,
                          double[] preds,
                          double offset,
                          int startTree,
                          int ntrees)

deepClone

protected M deepClone(water.Key<M> result)

Performs deep clone of given model.

remove_impl

protected water.Futures remove_impl(water.Futures fs,
                                    boolean cascade)

Overrides:

remove_impl in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

writeAll_impl

protected water.AutoBuffer writeAll_impl(water.AutoBuffer ab)

Write out K/V pairs

Overrides:

writeAll_impl in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

readAll_impl

protected water.Keyed readAll_impl(water.AutoBuffer ab,
                                   water.Futures fs)

Overrides:

readAll_impl in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

getSharedTreeSubgraph

public hex.genmodel.algos.tree.SharedTreeSubgraph getSharedTreeSubgraph(int tidx,
                                                                        int cls)

Converts a given tree of the ensemble to a user-understandable representation.

Parameters:

tidx - tree index

cls - tree class

Returns:

instance of SharedTreeSubgraph

isFeatureUsedInPredict

public boolean isFeatureUsedInPredict(java.lang.String featureName)

Overrides:

isFeatureUsedInPredict in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

binomialOpt

public boolean binomialOpt()

getGenModelEncoding

public hex.genmodel.CategoricalEncoding getGenModelEncoding()

Overrides:

getGenModelEncoding in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

makeTreePojoWriter

protected SharedTreePojoWriter makeTreePojoWriter()

makePojoWriter

protected final hex.PojoWriter makePojoWriter()

Overrides:

makePojoWriter in class hex.Model<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>