hex.tree.isofor

Class IsolationForest

java.lang.Object

water.Iced

hex.ModelBuilder<M,P,O>

hex.tree.SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

hex.tree.isofor.IsolationForest

All Implemented Interfaces:

CalibrationHelper.ModelBuilderWithCalibration<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable

public class IsolationForest
extends SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

Isolation Forest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IsolationForest.VarSplits

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
IsolationForest(boolean startup_once)
IsolationForest(IsolationForestModel.IsolationForestParameters parms)
IsolationForest(IsolationForestModel.IsolationForestParameters parms, water.Job job)
IsolationForest(IsolationForestModel.IsolationForestParameters parms, water.Key<IsolationForestModel> key)

Method Summary

Modifier and Type	Method and Description
protected void	addCustomInfo(IsolationForestModel.IsolationForestOutput out)
hex.ModelBuilder.BuilderVisibility	builderVisibility()
hex.ModelCategory[]	can_build()
protected water.util.TwoDimTable	createScoringHistoryTable()
protected hex.ScoreKeeper.ProblemType	getProblemType()
boolean	haveMojo()
boolean	havePojo()
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
boolean	isResponseOptional()
boolean	isSupervised()
protected DTree.DecidedNode	makeDecided(DTree.UndecidedNode udn, DHistogram[] hs, Constraints cs)
protected double	score1(water.fvec.Chunk[] chks, double weight, double offset, double[] fs, int row)
boolean	scoreZeroTrees()
protected SharedTree.Driver	trainModelImpl()
protected void	validateRowSampleRate()
protected boolean	validateStoppingMetric()

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, getToEigenVec, idx_nids, idx_offset, idx_oobt, idx_resp, idx_treatment, idx_tree, idx_weight, idx_work, ignoreInvalidColumns, isUplift, makeScoreExtension, providesVarImp, setCalibrationFrame, setDebugParams, shouldReorder, validWorkspace, vec_nids, vec_offset, vec_oobt, vec_resp, vec_tree, vec_weight, vec_work

Methods inherited from class hex.ModelBuilder

algoName, algos, 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, 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, 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

IsolationForest

public IsolationForest(IsolationForestModel.IsolationForestParameters parms)

IsolationForest

public IsolationForest(IsolationForestModel.IsolationForestParameters parms,
                       water.Key<IsolationForestModel> key)

IsolationForest

public IsolationForest(IsolationForestModel.IsolationForestParameters parms,
                       water.Job job)

IsolationForest

public IsolationForest(boolean startup_once)

Method Detail

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

builderVisibility

public hex.ModelBuilder.BuilderVisibility builderVisibility()

Overrides:

builderVisibility in class hex.ModelBuilder<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

trainModelImpl

protected SharedTree.Driver trainModelImpl()

Specified by:

trainModelImpl in class hex.ModelBuilder<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

scoreZeroTrees

public boolean scoreZeroTrees()

Overrides:

scoreZeroTrees in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

isSupervised

public boolean isSupervised()

Overrides:

isSupervised in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

isResponseOptional

public boolean isResponseOptional()

Overrides:

isResponseOptional in class hex.ModelBuilder<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

getProblemType

protected hex.ScoreKeeper.ProblemType getProblemType()

Overrides:

getProblemType in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

init

public void init(boolean expensive)

Description copied from class: SharedTree

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 SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

validateRowSampleRate

protected void validateRowSampleRate()

Overrides:

validateRowSampleRate in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

validateStoppingMetric

protected boolean validateStoppingMetric()

Overrides:

validateStoppingMetric in class hex.ModelBuilder<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

makeDecided

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

Overrides:

makeDecided in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

addCustomInfo

protected void addCustomInfo(IsolationForestModel.IsolationForestOutput out)

Overrides:

addCustomInfo in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

score1

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

Specified by:

score1 in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

createScoringHistoryTable

protected water.util.TwoDimTable createScoringHistoryTable()

Overrides:

createScoringHistoryTable in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

havePojo

public boolean havePojo()

Overrides:

havePojo in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>

haveMojo

public boolean haveMojo()

Overrides:

haveMojo in class SharedTree<IsolationForestModel,IsolationForestModel.IsolationForestParameters,IsolationForestModel.IsolationForestOutput>