hex.tree.xgboost

Class XGBoost

java.lang.Object

water.Iced

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

hex.tree.xgboost.XGBoost

All Implemented Interfaces:

hex.tree.PlattScalingHelper.ModelBuilderWithCalibration<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

public class XGBoost
extends hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>
implements hex.tree.PlattScalingHelper.ModelBuilderWithCalibration<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

Gradient Boosted Trees Based on "Elements of Statistical Learning, Second Edition, page 387"

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hex.ModelBuilder

hex.ModelBuilder.BuilderVisibility, hex.ModelBuilder.Driver, hex.ModelBuilder.FilterCols, hex.ModelBuilder.ValidationMessage

Field Summary

Fields inherited from class hex.ModelBuilder

_fold, _input_parms, _job, _messages, _nclass, _offset, _orig_projection_array, _origDomains, _origNames, _origTrain, _parms, _priorClassDist, _removedCols, _response, _result, _startUpOnceModelBuilder, _train, _valid, _vresponse, _weights

Constructor Summary

Constructors

Constructor and Description
XGBoost(boolean startup_once)
XGBoost(XGBoostModel.XGBoostParameters parms)
XGBoost(XGBoostModel.XGBoostParameters parms, water.Key<XGBoostModel> key)

Method Summary

Modifier and Type	Method and Description
hex.ModelBuilder.BuilderVisibility	builderVisibility()
hex.ModelCategory[]	can_build()
protected boolean	canLearnFromNAs()
void	cv_computeAndSetOptimalParameters(hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>[] cvModelBuilders)
water.fvec.Frame	getCalibrationFrame()
XGBoost	getModelBuilder()
boolean	haveMojo()
boolean	havePojo()
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
boolean	isSupervised()
protected int	nModelsInParallel(int folds)
protected water.fvec.Frame	rebalance(water.fvec.Frame original_fr, boolean local, java.lang.String name)
void	setCalibrationFrame(water.fvec.Frame f)
protected hex.tree.xgboost.XGBoost.XGBoostDriver	trainModelImpl() Start the XGBoost training Job on an F/J thread.

Methods inherited from class hex.ModelBuilder

algoName, algos, bulkBuildModels, checkDistributions, checkMemoryFootPrint_impl, checkMemoryFootPrint, checkResponseVariable, clearInitState, clearValidationErrors, computeCrossValidation, computePriorClassDistribution, cv_AssignFold, cv_buildModels, cv_mainModelScores, cv_makeWeights, cv_scoreCVModels, defaultKey, desiredChunks, dest, error_count, error, get, getName, getSysProperty, getToEigenVec, hasFoldCol, hasOffsetCol, hasWeightCol, hide, ignoreBadColumns, ignoreConstColumns, ignoreInvalidColumns, ignoreStringColumns, ignoreUuidColumns, info, init_adaptFrameToTrain, init_getNClass, initWorkspace, isClassifier, isResponseOptional, isStopped, javaName, logMe, make, make, make, message, nclasses, nFoldCV, nFoldWork, nModelsInParallel, nModelsInParallel, numSpecialCols, paramName, remainingTimeSecs, response, schemaDirectory, separateFeatureVecs, setModelBuilderListener, setTrain, shouldReorder, specialColNames, stop_requested, timeout, train, trainModel, trainModelNested, trainModelNested, trainModelOnH2ONode, valid, validateStoppingMetric, validationErrors, vresponse, warn

Methods inherited from class water.Iced

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

Methods inherited from class java.lang.Object

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

Constructor Detail

XGBoost

public XGBoost(XGBoostModel.XGBoostParameters parms)

XGBoost

public XGBoost(XGBoostModel.XGBoostParameters parms,
               water.Key<XGBoostModel> key)

XGBoost

public XGBoost(boolean startup_once)

Method Detail

haveMojo

public boolean haveMojo()

Overrides:

haveMojo in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

havePojo

public boolean havePojo()

Overrides:

havePojo in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

builderVisibility

public hex.ModelBuilder.BuilderVisibility builderVisibility()

Overrides:

builderVisibility in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

isSupervised

public boolean isSupervised()

Specified by:

isSupervised in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

nModelsInParallel

protected int nModelsInParallel(int folds)

Overrides:

nModelsInParallel in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

trainModelImpl

protected hex.tree.xgboost.XGBoost.XGBoostDriver trainModelImpl()

Start the XGBoost training Job on an F/J thread.

Specified by:

trainModelImpl in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

init

public void init(boolean expensive)

Initialize the ModelBuilder, validating all arguments and preparing the training frame. This call is expected to be overridden in the subclasses and each subclass will start with "super.init();". This call is made by the front-end whenever the GUI is clicked, and needs to be fast; heavy-weight prep needs to wait for the trainModel() call. Validate the learning rate and distribution family.

Overrides:

init in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

getModelBuilder

public XGBoost getModelBuilder()

Specified by:

getModelBuilder in interface hex.tree.PlattScalingHelper.ModelBuilderWithCalibration<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

getCalibrationFrame

public water.fvec.Frame getCalibrationFrame()

Specified by:

getCalibrationFrame in interface hex.tree.PlattScalingHelper.ModelBuilderWithCalibration<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

setCalibrationFrame

public void setCalibrationFrame(water.fvec.Frame f)

Specified by:

setCalibrationFrame in interface hex.tree.PlattScalingHelper.ModelBuilderWithCalibration<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

canLearnFromNAs

protected boolean canLearnFromNAs()

Overrides:

canLearnFromNAs in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

rebalance

protected water.fvec.Frame rebalance(water.fvec.Frame original_fr,
                                     boolean local,
                                     java.lang.String name)

Overrides:

rebalance in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

cv_computeAndSetOptimalParameters

public void cv_computeAndSetOptimalParameters(hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>[] cvModelBuilders)

Overrides:

cv_computeAndSetOptimalParameters in class hex.ModelBuilder<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>