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:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<XGBoostModel>

public class XGBoostModel
extends hex.Model<XGBoostModel,XGBoostModel.XGBoostParameters,XGBoostOutput>

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.BigScore, hex.Model.DeepFeatures, hex.Model.ExemplarMembers, hex.Model.GetMostImportantFeatures, hex.Model.GLRMArchetypes, hex.Model.GridSortBy, hex.Model.InteractionBuilder, hex.Model.InteractionPair, hex.Model.InteractionSpec, hex.Model.JavaModelStreamWriter, hex.Model.LeafNodeAssignment, hex.Model.Output, hex.Model.Parameters

Field Summary

Fields inherited from class hex.Model

_dist, _output, _parms, _toDelete, _warnings, _warningsP, 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
protected boolean	bulkBigScorePredict()
static BoosterParms	createParams(XGBoostModel.XGBoostParameters p, int nClasses)
void	doScoring(ml.dmlc.xgboost4j.java.Booster booster, water.fvec.Frame _train, water.fvec.Frame _trainOrig, water.fvec.Frame _valid, water.fvec.Frame _validOrig) Score an XGBoost model on training and validation data (optional) Note: every row is scored, all observation weights are assumed to be equal
XGBoostMojoWriter	getMojo()
hex.ModelMetrics.MetricBuilder	makeMetricBuilder(java.lang.String[] domain)
XGBoostModelInfo	model_info()
protected water.Keyed	readAll_impl(water.AutoBuffer ab, water.Futures fs)
protected water.Futures	remove_impl(water.Futures fs)
water.fvec.Frame	score(water.fvec.Frame fr, java.lang.String destination_key, water.Job j, boolean computeMetrics)
double[][]	score0(water.fvec.Chunk[] chks, double[] offset, int[] rowsInChunk, double[][] tmp, double[][] preds)
protected double[]	score0(double[] data, double[] preds)
double[]	score0(double[] data, double[] preds, double offset)
protected water.AutoBuffer	writeAll_impl(water.AutoBuffer ab)

Methods inherited from class hex.Model

adaptTestForTrain, adaptTestForTrain, addMetrics, addModelMetrics, addWarning, addWarningP, auc, checksum_impl, classification_error, closeBigScorePredict, compareTo, computeDeviances, containsResponse, data, defaultThreshold, defaultThreshold, deleteCrossValidationModels, deleteCrossValidationPreds, deviance, deviance, exportBinaryModel, exportMojo, fetchAll, fillScoringInfo, getDefaultGridSortBy, getPojoInterfaces, getToEigenVec, haveMojo, havePojo, importBinaryModel, isSupervised, last_scored, lift_top_group, logloss, loss, mae, makeBigScoreTask, makeInteraction, makeInteractions, makeInteractions, makeSchema, makeScoringNames, makeScoringNames, mean_per_class_error, mse, needsPostProcess, postProcessPredictions, predictScoreImpl, r2, rmsle, score, score, score, score, score, score, score0, score0, score0PostProcessSupervised, scoreMetrics, scoring_history, scoringDomains, setupBigScorePredict, testJavaScoring, testJavaScoring, testJavaScoring, testJavaScoring, toJava, toJava, toJava, toJavaCheckTooBig, toJavaInit, toJavaNCLASSES, toJavaPredictBody, toJavaPROB, toJavaSuper, toJavaTransform, toMojo, toString

Methods inherited from class water.Lockable

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

Methods inherited from class water.Keyed

checksum, readAll, remove, remove, remove, remove, writeAll

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, wait, wait, wait

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>

createParams

public static BoosterParms createParams(XGBoostModel.XGBoostParameters p,
                                        int nClasses)

score0

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

Specified by:

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

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>

doScoring

public void doScoring(ml.dmlc.xgboost4j.java.Booster booster,
                      water.fvec.Frame _train,
                      water.fvec.Frame _trainOrig,
                      water.fvec.Frame _valid,
                      water.fvec.Frame _validOrig)
               throws ml.dmlc.xgboost4j.java.XGBoostError

Score an XGBoost model on training and validation data (optional) Note: every row is scored, all observation weights are assumed to be equal

Parameters:

booster - xgboost model

_train - training data in the form of matrix

_valid - validation data (optional, can be null)

Throws:

ml.dmlc.xgboost4j.java.XGBoostError

score0

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

Overrides:

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

score0

public double[][] score0(water.fvec.Chunk[] chks,
                         double[] offset,
                         int[] rowsInChunk,
                         double[][] tmp,
                         double[][] preds)

Overrides:

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

bulkBigScorePredict

protected boolean bulkBigScorePredict()

Overrides:

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

remove_impl

protected water.Futures remove_impl(water.Futures fs)

Overrides:

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

score

public water.fvec.Frame score(water.fvec.Frame fr,
                              java.lang.String destination_key,
                              water.Job j,
                              boolean computeMetrics)
                       throws java.lang.IllegalArgumentException

Overrides:

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

Throws:

java.lang.IllegalArgumentException