hex

Class ModelBuilder<M extends Model<M,P,O>,P extends Model.Parameters,O extends Model.Output>

java.lang.Object

water.Iced<T>

water.Keyed

water.Job<M>

hex.ModelBuilder<M,P,O>

All Implemented Interfaces:

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

Direct Known Subclasses:

ClusteringModelBuilder, Quantile, SupervisedModelBuilder

public abstract class ModelBuilder<M extends Model<M,P,O>,P extends Model.Parameters,O extends Model.Output>
extends Job<M>

Model builder parent class. Contains the common interfaces and fields across all model builders.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelBuilder.BuilderVisibility Visibility for this algo: is it always visible, is it beta (always visible but with a note in the UI) or is it experimental (hidden by default, visible in the UI if the user gives an "experimental" flag at startup).
static class	ModelBuilder.ValidationMessage The result of an abnormal Model.Parameter check.

Nested classes/interfaces inherited from class water.Job

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

Field Summary

Fields

Modifier and Type	Field and Description
ModelBuilder.ValidationMessage[]	_messages A list of field validation issues.
P	_parms All the parameters required to build the model.
protected Frame	_train
protected Frame	_valid

Fields inherited from class water.Job

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

Fields inherited from class water.Keyed

_key

Constructor Summary

Constructors

Constructor and Description
ModelBuilder(Key dest, java.lang.String desc, P parms) Default constructor, given all arguments
ModelBuilder(P ignore) Constructor called from an http request; MUST override in subclasses.
ModelBuilder(java.lang.String desc, P parms) Constructor making a default destination key

Method Summary

Methods

Modifier and Type	Method and Description
abstract ModelBuilder.BuilderVisibility	builderVisibility() Visibility for this algo: is it always visible, is it beta (always visible but with a note in the UI) or is it experimental (hidden by default, visible in the UI if the user gives an "experimental" flag at startup).
abstract hex.ModelCategory[]	can_build() List containing the categories of models that this builder can build.
protected void	checkMemoryFootPrint() Override this method to call error() if the model is expected to not fit in memory, and say why
void	clearInitState() Clear whatever was done by init() so it can be run again.
static ModelBuilder	createModelBuilder(java.lang.String algo) Factory method to create a ModelBuilder instance of the correct class given the algo name.
int	error_count()
void	error(java.lang.String field_name, java.lang.String message)
java.lang.String	getAlgo()
static java.lang.String	getAlgo(java.lang.Class<? extends ModelBuilder> clz)
static java.lang.String	getAlgo(Model model) Get the algo name for the given Model.
static java.lang.String	getAlgoFullName(java.lang.String algo) Get the algo full name for the given algo.
static java.lang.Class<? extends ModelBuilder>	getModelBuilder(java.lang.String name) Get the ModelBuilder class for the given algo name.
static java.util.Map<java.lang.String,java.lang.Class<? extends ModelBuilder>>	getModelBuilders() Get a Map of all algo names to their ModelBuilder classes.
static java.lang.Class<? extends Model>	getModelClass(java.lang.String name) Get the Model class for the given algo name.
void	hide(java.lang.String field_name, java.lang.String message)
void	info(java.lang.String field_name, java.lang.String message)
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
static void	registerModelBuilder(java.lang.String name, java.lang.String full_name, java.lang.Class<? extends ModelBuilder> clz) Register a ModelBuilder, assigning it an algo name.
abstract ModelBuilderSchema	schema() Externally visible default schema TODO: this is in the wrong layer: the internals should not know anything about the schemas!!! This puts a reverse edge into the dependency graph.
Frame	train() Training frame: derived from the parameter's training frame, excluding all ignored columns, all constant and bad columns, perhaps flipping the response column to an Categorical, etc.
abstract Job<M>	trainModel() Method to launch training of a Model, based on its parameters.
void	updateValidationMessages() init(expensive) is called inside a DTask, not from the http request thread.
Frame	valid() Validation frame: derived from the parameter's validation frame, excluding all ignored columns, all constant and bad columns, perhaps flipping the response column to a Categorical, etc.
java.lang.String	validationErrors() Get a string representation of only the ERROR ValidationMessages (e.g., to use in an exception throw).
void	warn(java.lang.String field_name, java.lang.String message)

Methods inherited from class water.Job

cancel, cancel, checksum_impl, dest, done, failed, get, isCancelledOrCrashed, isDone, isRunning, isRunning, isStopped, jobs, msec, onCancelled, progress_msg, progress, remove_impl, start, update, update, 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

Field Detail

_parms

public final P extends Model.Parameters _parms

All the parameters required to build the model.

_train

protected transient Frame _train

_valid

protected transient Frame _valid

_messages

public ModelBuilder.ValidationMessage[] _messages

A list of field validation issues.

Constructor Detail

ModelBuilder

public ModelBuilder(P ignore)

Constructor called from an http request; MUST override in subclasses.

ModelBuilder

public ModelBuilder(java.lang.String desc,
            P parms)

Constructor making a default destination key

ModelBuilder

public ModelBuilder(Key dest,
            java.lang.String desc,
            P parms)

Default constructor, given all arguments

Method Detail

train

public final Frame train()

Training frame: derived from the parameter's training frame, excluding all ignored columns, all constant and bad columns, perhaps flipping the response column to an Categorical, etc.

valid

public final Frame valid()

Validation frame: derived from the parameter's validation frame, excluding all ignored columns, all constant and bad columns, perhaps flipping the response column to a Categorical, etc. Is null if no validation key is set.

registerModelBuilder

public static void registerModelBuilder(java.lang.String name,
                        java.lang.String full_name,
                        java.lang.Class<? extends ModelBuilder> clz)

Register a ModelBuilder, assigning it an algo name.

getModelBuilders

public static java.util.Map<java.lang.String,java.lang.Class<? extends ModelBuilder>> getModelBuilders()

Get a Map of all algo names to their ModelBuilder classes.

getModelBuilder

public static java.lang.Class<? extends ModelBuilder> getModelBuilder(java.lang.String name)

Get the ModelBuilder class for the given algo name.

getModelClass

public static java.lang.Class<? extends Model> getModelClass(java.lang.String name)

Get the Model class for the given algo name.

getAlgo

public static java.lang.String getAlgo(Model model)

Get the algo name for the given Model.

getAlgoFullName

public static java.lang.String getAlgoFullName(java.lang.String algo)

Get the algo full name for the given algo.

getAlgo

public java.lang.String getAlgo()

getAlgo

public static java.lang.String getAlgo(java.lang.Class<? extends ModelBuilder> clz)

schema

public abstract ModelBuilderSchema schema()

Externally visible default schema TODO: this is in the wrong layer: the internals should not know anything about the schemas!!! This puts a reverse edge into the dependency graph.

createModelBuilder

public static ModelBuilder createModelBuilder(java.lang.String algo)

Factory method to create a ModelBuilder instance of the correct class given the algo name.

trainModel

public abstract Job<M> trainModel()

Method to launch training of a Model, based on its parameters.

can_build

public abstract hex.ModelCategory[] can_build()

List containing the categories of models that this builder can build. Each ModelBuilder must have one of these.

builderVisibility

public abstract ModelBuilder.BuilderVisibility builderVisibility()

Visibility for this algo: is it always visible, is it beta (always visible but with a note in the UI) or is it experimental (hidden by default, visible in the UI if the user gives an "experimental" flag at startup).

clearInitState

public void clearInitState()

Clear whatever was done by init() so it can be run again.

checkMemoryFootPrint

protected void checkMemoryFootPrint()

Override this method to call error() if the model is expected to not fit in memory, and say why

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 whenever expensive is false; it will be called once again at the start of model building trainModel() with expensive set to true.

The incoming training frame (and validation frame) will have ignored columns dropped out, plus whatever work the parent init did.

NOTE: The front end initially calls this through the parameters validation endpoint with no training_frame, so each subclass's init() method has to work correctly with the training_frame missing.

See Also:

updateValidationMessages()

updateValidationMessages

public void updateValidationMessages()

init(expensive) is called inside a DTask, not from the http request thread. If we add validation messages to the ModelBuilder (aka the Job) we want to update it in the DKV so the client can see them when polling and later on after the job completes.

NOTE: this should only be called when no other threads are updating the job, for example from init() or after the DTask is stopped and is getting cleaned up.

See Also:

init(boolean)

error_count

public int error_count()

hide

public void hide(java.lang.String field_name,
        java.lang.String message)

info

public void info(java.lang.String field_name,
        java.lang.String message)

warn

public void warn(java.lang.String field_name,
        java.lang.String message)

error

public void error(java.lang.String field_name,
         java.lang.String message)

validationErrors

public java.lang.String validationErrors()

Get a string representation of only the ERROR ValidationMessages (e.g., to use in an exception throw).