hex.tree.xgboost

Class XGBoostModel

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<M>

hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

hex.tree.xgboost.XGBoostModel

All Implemented Interfaces:

hex.FeatureInteractionsCollector, hex.FriedmanPopescusHCollector, hex.genmodel.algos.tree.SharedTreeGraphConverter, hex.Model.Contributions, hex.Model.LeafNodeAssignment, hex.Model.UpdateAuxTreeWeights, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.api.StreamWriter, water.Freezable<XGBoostModel>

public class XGBoostModel
extends hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>
implements hex.genmodel.algos.tree.SharedTreeGraphConverter, hex.Model.LeafNodeAssignment, hex.Model.Contributions, hex.FeatureInteractionsCollector, hex.Model.UpdateAuxTreeWeights, hex.FriedmanPopescusHCollector

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XGBoostModel.XGBoostParameters

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.Contributions

hex.Model.Contributions.ContributionsOptions, hex.Model.Contributions.ContributionsOutputFormat

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
XGBoostModel(water.Key<XGBoostModel> selfKey, XGBoostModel.XGBoostParameters parms, XGBoostOutput output, water.fvec.Frame train, water.fvec.Frame valid)

Method Summary

Modifier and Type	Method and Description
hex.genmodel.algos.tree.SharedTreeGraph	convert(int treeNumber, java.lang.String treeClassName)
hex.genmodel.algos.tree.SharedTreeGraph	convert(int treeNumber, java.lang.String treeClass, hex.genmodel.algos.tree.ConvertTreeOptions options)
static BoosterParms	createParams(XGBoostModel.XGBoostParameters p, int nClasses, java.lang.String[] coefNames)
static java.util.Map<java.lang.String,java.lang.Object>	createParamsMap(XGBoostModel.XGBoostParameters p, int nClasses, java.lang.String[] coefNames)
protected XGBoostModel	deepClone(water.Key<XGBoostModel> result) Performs deep clone of given model.
static XGBoostModel.XGBoostParameters.Backend	getActualBackend(XGBoostModel.XGBoostParameters p, boolean verbose)
static XGBoostModel.XGBoostParameters.TreeMethod	getActualTreeMethod(XGBoostModel.XGBoostParameters p)
hex.FeatureInteractions	getFeatureInteractions(int maxInteractionDepth, int maxTreeDepth, int maxDeepening)
water.util.TwoDimTable[][]	getFeatureInteractionsTable(int maxInteractionDepth, int maxTreeDepth, int maxDeepening)
double	getFriedmanPopescusH(water.fvec.Frame frame, java.lang.String[] vars)
XGBoostMojoWriter	getMojo()
void	initActualParamValues()
void	initActualParamValuesAfterOutputSetup(boolean isClassifier, int nclasses)
boolean	isFeatureUsedInPredict(java.lang.String featureName)
hex.ModelMetrics.MetricBuilder	makeMetricBuilder(java.lang.String[] domain)
XGBoostModelInfo	model_info()
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)
double[]	score0(double[] data, double[] preds, double offset)
water.fvec.Frame	scoreContributions(water.fvec.Frame frame, water.Key<water.fvec.Frame> destination_key)
water.fvec.Frame	scoreContributions(water.fvec.Frame frame, water.Key<water.fvec.Frame> destination_key, water.Job<water.fvec.Frame> j, hex.Model.Contributions.ContributionsOptions options)
water.fvec.Frame	scoreLeafNodeAssignment(water.fvec.Frame frame, hex.Model.LeafNodeAssignment.LeafNodeAssignmentType type, water.Key<water.fvec.Frame> destination_key)
XGBoostBigScorePredict	setupBigScorePredict(boolean isTrain)
protected XGBoostBigScorePredict	setupBigScorePredict(hex.Model.BigScore bs)
XGBoostVariableImportance	setupVarImp()
protected boolean	toJavaCheckTooBig()
protected water.util.SBPrintStream	toJavaInit(water.util.SBPrintStream sb, water.codegen.CodeGeneratorPipeline fileCtx)
protected void	toJavaPredictBody(water.util.SBPrintStream sb, water.codegen.CodeGeneratorPipeline classCtx, water.codegen.CodeGeneratorPipeline fileCtx, boolean verboseCode)
hex.Model.UpdateAuxTreeWeights.UpdateAuxTreeWeightsReport	updateAuxTreeWeights(water.fvec.Frame frame, java.lang.String weightsColumn)
protected water.AutoBuffer	writeAll_impl(water.AutoBuffer ab)

Methods inherited from class hex.Model

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

Methods inherited from class water.Lockable

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

Methods inherited from interface hex.Model.Contributions

composeScoreContributionTaskMetadata, scoreContributions

Constructor Detail

XGBoostModel

public XGBoostModel(water.Key<XGBoostModel> selfKey,
                    XGBoostModel.XGBoostParameters parms,
                    XGBoostOutput output,
                    water.fvec.Frame train,
                    water.fvec.Frame valid)

Method Detail

model_info

public XGBoostModelInfo model_info()

makeMetricBuilder

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

Specified by:

makeMetricBuilder in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

initActualParamValues

public void initActualParamValues()

Overrides:

initActualParamValues in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

getActualTreeMethod

public static XGBoostModel.XGBoostParameters.TreeMethod getActualTreeMethod(XGBoostModel.XGBoostParameters p)

initActualParamValuesAfterOutputSetup

public void initActualParamValuesAfterOutputSetup(boolean isClassifier,
                                                  int nclasses)

getActualBackend

public static XGBoostModel.XGBoostParameters.Backend getActualBackend(XGBoostModel.XGBoostParameters p,
                                                                      boolean verbose)

createParamsMap

public static java.util.Map<java.lang.String,java.lang.Object> createParamsMap(XGBoostModel.XGBoostParameters p,
                                                                               int nClasses,
                                                                               java.lang.String[] coefNames)

createParams

public static BoosterParms createParams(XGBoostModel.XGBoostParameters p,
                                        int nClasses,
                                        java.lang.String[] coefNames)

deepClone

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

Performs deep clone of given model.

writeAll_impl

protected water.AutoBuffer writeAll_impl(water.AutoBuffer ab)

Overrides:

writeAll_impl in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

readAll_impl

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

Overrides:

readAll_impl in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

getMojo

public XGBoostMojoWriter getMojo()

Overrides:

getMojo in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

postProcessPredictions

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

Overrides:

postProcessPredictions in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

score0

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

Specified by:

score0 in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

score0

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

Overrides:

score0 in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

setupBigScorePredict

protected XGBoostBigScorePredict setupBigScorePredict(hex.Model.BigScore bs)

Overrides:

setupBigScorePredict in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

setupBigScorePredict

public XGBoostBigScorePredict setupBigScorePredict(boolean isTrain)

setupVarImp

public XGBoostVariableImportance setupVarImp()

scoreContributions

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

Specified by:

scoreContributions in interface hex.Model.Contributions

scoreContributions

public water.fvec.Frame scoreContributions(water.fvec.Frame frame,
                                           water.Key<water.fvec.Frame> destination_key,
                                           water.Job<water.fvec.Frame> j,
                                           hex.Model.Contributions.ContributionsOptions options)

Specified by:

scoreContributions in interface hex.Model.Contributions

updateAuxTreeWeights

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

Specified by:

updateAuxTreeWeights in interface hex.Model.UpdateAuxTreeWeights

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

remove_impl

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

Overrides:

remove_impl in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

convert

public hex.genmodel.algos.tree.SharedTreeGraph convert(int treeNumber,
                                                       java.lang.String treeClassName)

Specified by:

convert in interface hex.genmodel.algos.tree.SharedTreeGraphConverter

convert

public hex.genmodel.algos.tree.SharedTreeGraph convert(int treeNumber,
                                                       java.lang.String treeClass,
                                                       hex.genmodel.algos.tree.ConvertTreeOptions options)

Specified by:

convert in interface hex.genmodel.algos.tree.SharedTreeGraphConverter

isFeatureUsedInPredict

public boolean isFeatureUsedInPredict(java.lang.String featureName)

Overrides:

isFeatureUsedInPredict in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

toJavaCheckTooBig

protected boolean toJavaCheckTooBig()

Overrides:

toJavaCheckTooBig in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

toJavaInit

protected water.util.SBPrintStream toJavaInit(water.util.SBPrintStream sb,
                                              water.codegen.CodeGeneratorPipeline fileCtx)

Overrides:

toJavaInit in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

toJavaPredictBody

protected void toJavaPredictBody(water.util.SBPrintStream sb,
                                 water.codegen.CodeGeneratorPipeline classCtx,
                                 water.codegen.CodeGeneratorPipeline fileCtx,
                                 boolean verboseCode)

Overrides:

toJavaPredictBody in class hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

getFeatureInteractions

public hex.FeatureInteractions getFeatureInteractions(int maxInteractionDepth,
                                                      int maxTreeDepth,
                                                      int maxDeepening)

getFeatureInteractionsTable

public water.util.TwoDimTable[][] getFeatureInteractionsTable(int maxInteractionDepth,
                                                              int maxTreeDepth,
                                                              int maxDeepening)

Specified by:

getFeatureInteractionsTable in interface hex.FeatureInteractionsCollector

getFriedmanPopescusH

public double getFriedmanPopescusH(water.fvec.Frame frame,
                                   java.lang.String[] vars)

Specified by:

getFriedmanPopescusH in interface hex.FriedmanPopescusHCollector