hex.tree

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

java.lang.Object

water.Iced<T>

water.Keyed

water.Job<M>

hex.ModelBuilder<M,P,O>

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

Direct Known Subclasses:

DRF, GBM

public abstract class SharedTree<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>
extends hex.ModelBuilder<M,P,O>

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	SharedTree.Driver

Nested classes/interfaces inherited from class hex.ModelBuilder

hex.ModelBuilder.BuilderVisibility

Nested classes/interfaces inherited from class water.Job

water.Job.JobCancelledException, water.Job.JobState, water.Job.Progress, water.Job.ProgressUpdate, water.Job.ValidationMessage

Nested classes/interfaces inherited from class water.Keyed

water.Keyed.BinarySerializer<X extends water.Keyed>

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_initialPrediction
protected M	_model
protected int	_ncols
protected int	_ntrees
static int	MAX_NTREES

Fields inherited from class hex.ModelBuilder

_fold, _nclass, _offset, _parms, _response, _train, _valid, _vresponse, _weights

Fields inherited from class water.Job

_description, _dest, _end_time, _exception, _messages, _progressKey, _start_time, _state, LIST

Fields inherited from class water.Keyed

_key, EMPTY_KEY_LIST

Constructor Summary

Constructors

Constructor and Description
SharedTree(java.lang.String name, P parms)

Method Summary

Methods

Modifier and Type	Method and Description
protected DHistogram[][][]	buildLayer(water.fvec.Frame fr, int nbins, int nbins_cats, DTree[] ktrees, int[] leafs, DHistogram[][][] hcs, boolean subset, boolean build_tree_one_node)
protected void	checkMemoryFootPrint()
protected water.fvec.Chunk	chk_nids(water.fvec.Chunk[] chks, int c)
protected water.fvec.Chunk	chk_offset(water.fvec.Chunk[] chks)
protected water.fvec.Chunk	chk_oobt(water.fvec.Chunk[] chks)
protected water.fvec.Chunk	chk_resp(water.fvec.Chunk[] chks)
protected water.fvec.Chunk	chk_tree(water.fvec.Chunk[] chks, int c)
protected water.fvec.Chunk	chk_weight(water.fvec.Chunk[] chks)
protected water.fvec.Chunk	chk_work(water.fvec.Chunk[] chks, int c)
protected boolean	computePriorClassDistribution()
static java.util.Random	createRNG(long seed)
protected double[]	data_row(water.fvec.Chunk[] chks, int row, double[] data)
protected double	doScoringAndSaveModel(boolean finalScoring, boolean oob, boolean build_tree_one_node)
protected double	getInitialValue() Compute the inital value for a given distribution
protected int	idx_nids(int c)
protected int	idx_offset()
protected int	idx_oobt()
protected int	idx_resp()
protected int	idx_tree(int c)
protected int	idx_weight()
protected int	idx_work(int c)
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
boolean	isSupervised()
protected abstract DTree.DecidedNode	makeDecided(DTree.UndecidedNode udn, DHistogram[] hs)
protected static void	printGenerateTrees(DTree[] trees)
long	progressUnits()
water.fvec.Vec	response()
protected abstract double	score1(water.fvec.Chunk[] chks, double offset, double weight, double[] fs, int row)
protected water.fvec.Vec	vec_nids(water.fvec.Frame fr, int c)
protected water.fvec.Vec	vec_resp(water.fvec.Frame fr)
protected water.fvec.Vec	vec_tree(water.fvec.Frame fr, int c)
water.fvec.Vec	vresponse()

Methods inherited from class hex.ModelBuilder

builderVisibility, can_build, canBeDone, cancel, checkDistributions, clearInitState, computeCrossValidation, createModelBuilder, deleteProgressKey, error_count, getAlgo, getAlgo, getAlgo, getAlgoFullName, getModelBuilder, getModelBuilders, getModelClass, hasFoldCol, hasOffsetCol, hasWeightCol, ignoreBadColumns, ignoreStringColumns, isClassifier, modifyParmsForCrossValidationMainModel, modifyParmsForCrossValidationSplits, nclasses, nFoldCV, numSpecialCols, registerModelBuilder, responseMean, schema, separateFeatureVecs, train, trainModel, trainModelImpl, updateModelOutput, valid

Methods inherited from class water.Job

block, cancel, checksum_impl, clearValidationErrors, createProgressKey, dest, done, done, error_count_or_uninitialized, error, failed, get, hide, info, isCancelledOrCrashed, isDone, isRunning, isRunning, isStopped, jobKey, jobs, message, msec, progress_msg, progress, remove_impl, start, update, update, update, update, updateValidationMessages, validationErrors, warn

Methods inherited from class water.Keyed

checksum, getBinarySerializer, getPublishedKeys, remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeJSON_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NTREES

public static final int MAX_NTREES

See Also:

Constant Field Values

_ntrees

protected int _ntrees

_model

protected M extends SharedTreeModel<M,P,O> _model

_ncols

protected int _ncols

_initialPrediction

protected double _initialPrediction

Constructor Detail

SharedTree

public SharedTree(java.lang.String name,
          P parms)

Method Detail

isSupervised

public boolean isSupervised()

Overrides:

isSupervised in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

response

public water.fvec.Vec response()

Overrides:

response in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

vresponse

public water.fvec.Vec vresponse()

Overrides:

vresponse in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

progressUnits

public long progressUnits()

Specified by:

progressUnits in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

computePriorClassDistribution

protected boolean computePriorClassDistribution()

Overrides:

computePriorClassDistribution in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

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 requested ntrees; precompute actual ntrees. Validate the number of classes to predict on; validate a checkpoint.

Overrides:

init in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

buildLayer

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

idx_weight

protected int idx_weight()

idx_offset

protected int idx_offset()

idx_resp

protected int idx_resp()

idx_tree

protected int idx_tree(int c)

idx_work

protected int idx_work(int c)

idx_nids

protected int idx_nids(int c)

idx_oobt

protected int idx_oobt()

chk_weight

protected water.fvec.Chunk chk_weight(water.fvec.Chunk[] chks)

chk_offset

protected water.fvec.Chunk chk_offset(water.fvec.Chunk[] chks)

chk_resp

protected water.fvec.Chunk chk_resp(water.fvec.Chunk[] chks)

chk_tree

protected water.fvec.Chunk chk_tree(water.fvec.Chunk[] chks,
                        int c)

chk_work

protected water.fvec.Chunk chk_work(water.fvec.Chunk[] chks,
                        int c)

chk_nids

protected water.fvec.Chunk chk_nids(water.fvec.Chunk[] chks,
                        int c)

chk_oobt

protected water.fvec.Chunk chk_oobt(water.fvec.Chunk[] chks)

vec_nids

protected final water.fvec.Vec vec_nids(water.fvec.Frame fr,
                      int c)

vec_resp

protected final water.fvec.Vec vec_resp(water.fvec.Frame fr)

vec_tree

protected final water.fvec.Vec vec_tree(water.fvec.Frame fr,
                      int c)

data_row

protected double[] data_row(water.fvec.Chunk[] chks,
                int row,
                double[] data)

makeDecided

protected abstract DTree.DecidedNode makeDecided(DTree.UndecidedNode udn,
                            DHistogram[] hs)

score1

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

doScoringAndSaveModel

protected double doScoringAndSaveModel(boolean finalScoring,
                           boolean oob,
                           boolean build_tree_one_node)

printGenerateTrees

protected static void printGenerateTrees(DTree[] trees)

createRNG

public static java.util.Random createRNG(long seed)

checkMemoryFootPrint

protected void checkMemoryFootPrint()

Overrides:

checkMemoryFootPrint in class hex.ModelBuilder<M extends SharedTreeModel<M,P,O>,P extends SharedTreeModel.SharedTreeParameters,O extends SharedTreeModel.SharedTreeOutput>

getInitialValue

protected double getInitialValue()

Compute the inital value for a given distribution

Returns:

initial value