hex.example

Class Example

java.lang.Object

water.Iced<T>

water.Keyed

water.Job<M>

hex.ModelBuilder<M,P,O>

hex.SupervisedModelBuilder<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.SupervisedModelBuilder<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.ValidationMessage

Nested classes/interfaces inherited from class water.Job

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

Field Summary

Fields inherited from class hex.SupervisedModelBuilder

_nclass, _response, _response_key, _vresponse, _vresponse_key

Fields inherited from class hex.ModelBuilder

_messages, _parms, _train, _valid

Fields inherited from class water.Job

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

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
Example(ExampleModel.ExampleParameters parms)

Method Summary

Methods

Modifier and Type	Method and Description
hex.Model.ModelCategory[]	can_build()
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
hex.schemas.ModelBuilderSchema	schema()
Example	trainModel()

Methods inherited from class hex.SupervisedModelBuilder

isClassifier, response, vresponse

Methods inherited from class hex.ModelBuilder

clearInitState, createModelBuilder, error_count, error, getAlgo, getModelBuilder, getModelBuilderName, getModelBuilders, getModelClass, hide, info, registerModelBuilder, train, valid, validationErrors, warn

Methods inherited from class water.Job

cancel, cancel, cancel2, checksum_impl, dest, done, get, isCancelledOrCrashed, isDone, isRunning, isRunning, isStopped, jobs, msec, onCancelled, progress, remove_impl, start, update, update

Methods inherited from class water.Keyed

checksum, remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeHTML_impl, writeHTML, writeJSON_impl, 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.Model.ModelCategory[] can_build()

Specified by:

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

schema

public hex.schemas.ModelBuilderSchema schema()

Specified by:

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

trainModel

public Example trainModel()

Specified by:

trainModel 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_iters.

Overrides:

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