water.api

Class ModelParametersSchema<P extends Model.Parameters,S extends ModelParametersSchema<P,S>>

java.lang.Object

water.Iced

water.api.Schema<P,S>

water.api.ModelParametersSchema<P,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

SupervisedModelParametersSchema

public abstract class ModelParametersSchema<P extends Model.Parameters,S extends ModelParametersSchema<P,S>>
extends Schema<P,S>

An instance of a ModelParameters schema contains the Model build parameters (e.g., K and max_iters for KMeans).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelParametersSchema.ValidationMessageBase
static class	ModelParametersSchema.ValidationMessageV2

Field Summary

Fields

Modifier and Type	Field and Description
Key	destination_key
java.lang.String[]	ignored_columns
boolean	score_each_iteration
Frame	training_frame
Frame	validation_frame

Fields inherited from class water.api.Schema

_version_pattern, schema_name, schema_type, schema_version

Constructor Summary

Constructors

Constructor and Description
ModelParametersSchema()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String[]	fields() List of fields in the order in which we want them serialized.
S	fillFromImpl(P impl) Version and Schema-specific filling from the implementation object.
P	fillImpl(P impl) Fill an impl object and any children from this schema and its children.
static AutoBuffer	writeParametersJSON(AutoBuffer ab, ModelParametersSchema parameters, ModelParametersSchema default_parameters) Write the parameters, including their metadata, into an AutoBuffer.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromParms, getImplClass, getImplClass, markdown, markdown, register

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, 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

destination_key

@API(help="Destination key for this model; if unset they key is auto-generated.",
     required=false,
     direction=INOUT)
public Key destination_key

training_frame

@API(help="Training frame",
     direction=INOUT)
public Frame training_frame

validation_frame

@API(help="Validation frame",
     direction=INOUT)
public Frame validation_frame

ignored_columns

@API(help="Ignored columns",
     direction=INOUT)
public java.lang.String[] ignored_columns

score_each_iteration

@API(help="Score validation set on each major model-building iteration; can be slow",
     direction=INOUT)
public boolean score_each_iteration

Constructor Detail

ModelParametersSchema

public ModelParametersSchema()

Method Detail

fields

public abstract java.lang.String[] fields()

List of fields in the order in which we want them serialized. This is the order they will be presented in the UI.

fillFromImpl

public S fillFromImpl(P impl)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<P extends Model.Parameters,S extends ModelParametersSchema<P,S>>

fillImpl

public P fillImpl(P impl)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children.

Overrides:

fillImpl in class Schema<P extends Model.Parameters,S extends ModelParametersSchema<P,S>>

writeParametersJSON

public static final AutoBuffer writeParametersJSON(AutoBuffer ab,
                             ModelParametersSchema parameters,
                             ModelParametersSchema default_parameters)

Write the parameters, including their metadata, into an AutoBuffer. Used by ModelBuilderSchema#writeJSON_impl and ModelSchema#writeJSON_impl.