hex.quantile

Class Quantile

java.lang.Object

water.Iced<T>

water.Keyed

water.Job<M>

hex.ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

hex.quantile.Quantile

All Implemented Interfaces:

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

public class Quantile
extends ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

Quantile model builder... building a simple QuantileModel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Quantile.QTask

Nested classes/interfaces inherited from class hex.ModelBuilder

ModelBuilder.BuilderVisibility

Nested classes/interfaces inherited from class water.Job

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

Nested classes/interfaces inherited from class water.Keyed

Keyed.BinarySerializer<X extends Keyed>

Field Summary

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
Quantile(QuantileModel.QuantileParameters parms)

Method Summary

Methods

Modifier and Type	Method and Description
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).
hex.ModelCategory[]	can_build() List containing the categories of models that this builder can build.
void	init(boolean expensive) Initialize the ModelBuilder, validating all arguments and preparing the training frame.
long	progressUnits()
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.
Quantile	trainModelImpl(long work, boolean restartTimer) Model-specific implementation of model training

Methods inherited from class hex.ModelBuilder

canBeDone, cancel, checkDistributions, checkMemoryFootPrint, clearInitState, computeCrossValidation, computePriorClassDistribution, createModelBuilder, deleteProgressKey, error_count, getAlgo, getAlgo, getAlgo, getAlgoFullName, getModelBuilder, getModelBuilders, getModelClass, hasFoldCol, hasOffsetCol, hasWeightCol, ignoreBadColumns, ignoreStringColumns, isClassifier, isSupervised, modifyParmsForCrossValidationMainModel, modifyParmsForCrossValidationSplits, nclasses, nFoldCV, numSpecialCols, registerModelBuilder, response, responseMean, separateFeatureVecs, train, trainModel, updateModelOutput, valid, vresponse

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

Constructor Detail

Quantile

public Quantile(QuantileModel.QuantileParameters parms)

Method Detail

schema

public ModelBuilderSchema schema()

Description copied from class: ModelBuilder

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.

Specified by:

schema in class ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

trainModelImpl

public Quantile trainModelImpl(long work,
                      boolean restartTimer)

Description copied from class: ModelBuilder

Model-specific implementation of model training

Specified by:

trainModelImpl in class ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

Parameters:

work - Number of progress units (each advances the Job's progress bar by a bit)

Returns:

ModelBuilder job

progressUnits

public long progressUnits()

Specified by:

progressUnits in class ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

can_build

public hex.ModelCategory[] can_build()

Description copied from class: ModelBuilder

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

Specified by:

can_build in class ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

builderVisibility

public ModelBuilder.BuilderVisibility builderVisibility()

Description copied from class: ModelBuilder

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

Specified by:

builderVisibility in class ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

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

Overrides:

init in class ModelBuilder<QuantileModel,QuantileModel.QuantileParameters,QuantileModel.QuantileOutput>

See Also:

Job.updateValidationMessages()