hex.example

Class Example

java.lang.Object

water.Iced

hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>

hex.example.Example

All Implemented Interfaces:

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

public class Example
extends hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>

Example model builder... building a trivial ExampleModel

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, _job, _messages, _nclass, _offset, _origDomains, _origNames, _parms, _priorClassDist, _removedCols, _response, _result, _train, _valid, _vresponse, _weights

Constructor Summary

Constructors

Constructor and Description
Example(ExampleModel.ExampleParameters parms)

Method Summary

Methods

Modifier and Type	Method and Description
hex.ModelBuilder.BuilderVisibility	builderVisibility()
hex.ModelCategory[]	can_build()
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
boolean	isSupervised()
protected hex.example.Example.ExampleDriver	trainModelImpl()

Methods inherited from class hex.ModelBuilder

algoName, algos, checkDistributions, checkMemoryFootPrint, clearInitState, clearValidationErrors, computeCrossValidation, computePriorClassDistribution, cv_AssignFold, cv_buildModels, cv_computeAndSetOptimalParameters, cv_mainModelScores, cv_makeFramesAndBuilders, cv_makeWeights, cv_scoreCVModels, defaultKey, desiredChunks, dest, error_count, error, get, getToEigenVec, hasFoldCol, hasOffsetCol, hasWeightCol, haveMojo, havePojo, hide, ignoreBadColumns, ignoreConstColumns, ignoreInvalidColumns, ignoreStringColumns, info, init_adaptFrameToTrain, isClassifier, isStopped, javaName, logMe, make, message, nclasses, nFoldCV, nFoldWork, nModelsInParallel, numSpecialCols, paramName, rebalance, response, schemaDirectory, separateFeatureVecs, setTrain, shouldReorder, specialColNames, stop_requested, timeout, train, trainModel, trainModelNested, valid, 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

Example

public Example(ExampleModel.ExampleParameters parms)

Method Detail

can_build

public hex.ModelCategory[] can_build()

Specified by:

can_build in class hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>

builderVisibility

public hex.ModelBuilder.BuilderVisibility builderVisibility()

Overrides:

builderVisibility in class hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>

isSupervised

public boolean isSupervised()

Specified by:

isSupervised in class hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>

trainModelImpl

protected hex.example.Example.ExampleDriver trainModelImpl()

Specified by:

trainModelImpl in class hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>

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 max_iterations.

Overrides:

init in class hex.ModelBuilder<ExampleModel,ExampleModel.ExampleParameters,ExampleModel.ExampleOutput>