hex.tree.uplift

Class UpliftDRF

java.lang.Object

water.Iced

hex.ModelBuilder<M,P,O>

hex.tree.SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

hex.tree.uplift.UpliftDRF

All Implemented Interfaces:

CalibrationHelper.ModelBuilderWithCalibration<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

public class UpliftDRF
extends SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpliftDRF.UpliftMetricType

Nested classes/interfaces inherited from class hex.tree.SharedTree

SharedTree.Driver, SharedTree.FrameMap, SharedTree.ScoreBuildOneTree, SharedTree.SharedTreeDebugParams

Nested classes/interfaces inherited from class hex.ModelBuilder

hex.ModelBuilder.BuilderVisibility, hex.ModelBuilder.FilterCols, hex.ModelBuilder.ModelTrainingCoordinator, hex.ModelBuilder.ValidationMessage

Field Summary

Fields inherited from class hex.tree.SharedTree

_ics, _improvPerVar, _initialPrediction, _lastScoredTree, _model, _mtry, _mtry_per_tree, _ncols, _ntrees, _rand, _trainPredsCache, _validPredsCache, _validWorkspace, MAX_NTREES

Fields inherited from class hex.ModelBuilder

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

Constructor Summary

Constructors

Constructor and Description
UpliftDRF(boolean startup_once)
UpliftDRF(UpliftDRFModel.UpliftDRFParameters parms)
UpliftDRF(UpliftDRFModel.UpliftDRFParameters parms, water.Job job)
UpliftDRF(UpliftDRFModel.UpliftDRFParameters parms, water.Key<UpliftDRFModel> key)

Method Summary

Modifier and Type	Method and Description
protected void	addCustomInfo(UpliftDRFModel.UpliftDRFOutput out)
protected DHistogram[][][]	buildLayer(water.fvec.Frame fr, int nbins, DTree tree, int[] leafs, DHistogram[][][] hcs, boolean build_tree_one_node)
hex.ModelCategory[]	can_build()
protected water.util.TwoDimTable	createScoringHistoryTable()
boolean	haveMojo()
boolean	havePojo()
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
boolean	isUplift()
protected hex.tree.uplift.UpliftDRF.UpliftScoreExtension	makeScoreExtension()
protected double	score1(water.fvec.Chunk[] chks, double weight, double offset, double[] fs, int row) Read the 'tree' columns, do model-specific math and put the results in the fs[] array, and return the sum.
boolean	scoreZeroTrees()
protected SharedTree.Driver	trainModelImpl() Start the DRF training Job on an F/J thread.

Methods inherited from class hex.tree.SharedTree

buildLayer, canLearnFromNAs, checkEarlyStoppingReproducibility, checkMemoryFootPrint_impl, chk_nids, chk_offset, chk_oobt, chk_resp, chk_tree, chk_weight, chk_work, computePriorClassDistribution, createModelSummaryTable, createScoringHistoryTable, cv_canBuildMainModelInParallel, cv_computeAndSetOptimalParameters, cv_initStoppingParameters, cv_updateOptimalParameters, data_row, doScoringAndSaveModel, getCalibrationFrame, getInitialValue, getModelBuilder, getProblemType, getToEigenVec, idx_nids, idx_offset, idx_oobt, idx_resp, idx_treatment, idx_tree, idx_weight, idx_work, ignoreInvalidColumns, isSupervised, makeDecided, providesVarImp, setCalibrationFrame, setDebugParams, shouldReorder, validateRowSampleRate, validWorkspace, vec_nids, vec_offset, vec_oobt, vec_resp, vec_tree, vec_weight, vec_work

Methods inherited from class hex.ModelBuilder

algoName, algos, builderVisibility, checkCustomMetricForEarlyStopping, checkDistributions, checkMemoryFootPrint, checkResponseVariable, clearInitState, clearValidationErrors, computeCrossValidation, cv_buildModels, cv_mainModelScores, cv_makeAggregateModelMetrics, cv_scoreCVModels, defaultKey, desiredChunks, dest, error_count, error, get, getMessagesByFieldAndSeverity, getName, getSysProperty, hasFoldCol, hasOffsetCol, hasTreatmentCol, hasWeightCol, hide, ignoreBadColumns, ignoreConstColumns, ignoreStringColumns, ignoreUuidColumns, info, init_adaptFrameToTrain, init_getNClass, initWorkspace, isClassifier, isResponseOptional, isStopped, javaName, logMe, make, make, make, makeCVMetrics, makeCVModelBuilder, makeParameters, makePojoWriter, message, nclasses, nFoldCV, nFoldWork, nModelsInParallel, nModelsInParallel, nModelsInParallel, numSpecialCols, paramName, raiseReproducibilityWarning, rebalance, remainingTimeSecs, response, schemaDirectory, separateFeatureVecs, setMaxRuntimeSecsForMainModel, setTrain, setValid, smallDataSize, stop_requested, timeout, train, trainModel, trainModel, trainModelNested, trainModelNested, trainModelOnH2ONode, valid, validateBinaryResponse, validateStoppingMetric, validationErrors, validationWarnings, vresponse, warn

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

Constructor Detail

UpliftDRF

public UpliftDRF(UpliftDRFModel.UpliftDRFParameters parms)

UpliftDRF

public UpliftDRF(UpliftDRFModel.UpliftDRFParameters parms,
                 water.Key<UpliftDRFModel> key)

UpliftDRF

public UpliftDRF(UpliftDRFModel.UpliftDRFParameters parms,
                 water.Job job)

UpliftDRF

public UpliftDRF(boolean startup_once)

Method Detail

isUplift

public boolean isUplift()

Overrides:

isUplift in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

haveMojo

public boolean haveMojo()

Overrides:

haveMojo in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

havePojo

public boolean havePojo()

Overrides:

havePojo in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

trainModelImpl

protected SharedTree.Driver trainModelImpl()

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

Specified by:

trainModelImpl in class hex.ModelBuilder<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

scoreZeroTrees

public boolean scoreZeroTrees()

Overrides:

scoreZeroTrees in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

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.

Overrides:

init in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

score1

protected double score1(water.fvec.Chunk[] chks,
                        double weight,
                        double offset,
                        double[] fs,
                        int row)

Read the 'tree' columns, do model-specific math and put the results in the fs[] array, and return the sum. Dividing any fs[] element by the sum turns the results into a probability distribution.

Specified by:

score1 in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

buildLayer

protected DHistogram[][][] buildLayer(water.fvec.Frame fr,
                                      int nbins,
                                      DTree tree,
                                      int[] leafs,
                                      DHistogram[][][] hcs,
                                      boolean build_tree_one_node)

createScoringHistoryTable

protected water.util.TwoDimTable createScoringHistoryTable()

Overrides:

createScoringHistoryTable in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

addCustomInfo

protected void addCustomInfo(UpliftDRFModel.UpliftDRFOutput out)

Overrides:

addCustomInfo in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>

makeScoreExtension

protected hex.tree.uplift.UpliftDRF.UpliftScoreExtension makeScoreExtension()

Overrides:

makeScoreExtension in class SharedTree<UpliftDRFModel,UpliftDRFModel.UpliftDRFParameters,UpliftDRFModel.UpliftDRFOutput>