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:

ClusteringModelParametersSchema, QuantileV3.QuantileParametersV3

public 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_iterations for KMeans). NOTE: use subclasses, not this class directly. It is not abstract only so that we can instantiate it to generate metadata for it for the metadata API.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class water.api.Schema

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
Model.Parameters.FoldAssignmentScheme	fold_assignment
FrameV3.ColSpecifierV3	fold_column
boolean	ignore_const_cols
java.lang.String[]	ignored_columns
boolean	keep_cross_validation_predictions
boolean	keep_cross_validation_splits
KeyV3.ModelKeyV3	model_id
int	nfolds
FrameV3.ColSpecifierV3	offset_column
FrameV3.ColSpecifierV3	response_column
boolean	score_each_iteration
KeyV3.FrameKeyV3	training_frame
KeyV3.FrameKeyV3	validation_frame
FrameV3.ColSpecifierV3	weights_column

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
ModelParametersSchema()

Method Summary

Methods

Modifier and Type	Method and Description
protected static java.lang.String[]	append_field_arrays(java.lang.String[] first, java.lang.String[] second)
java.lang.String[]	fields()
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, getExperimentalVersion, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, markdown, markdown, markdown, markdown, newInstance, register, registerAllSchemasIfNecessary, schema, schema, schema, schema, schema, schemaClass, schemaClass, schemaClass, schemaClass, schemas

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

model_id

@API(help="Destination id for this model; auto-generated if not specified",
     required=false,
     direction=INOUT)
public KeyV3.ModelKeyV3 model_id

training_frame

@API(help="Training frame",
     direction=INOUT)
public KeyV3.FrameKeyV3 training_frame

validation_frame

@API(help="Validation frame",
     direction=INOUT)
public KeyV3.FrameKeyV3 validation_frame

nfolds

@API(help="Number of folds for N-fold cross-validation",
     level=critical,
     direction=INOUT)
public int nfolds

keep_cross_validation_splits

@API(help="Keep cross-validation training/validation split frames",
     level=expert,
     direction=INOUT)
public boolean keep_cross_validation_splits

keep_cross_validation_predictions

@API(help="Keep cross-validation model predictions",
     level=expert,
     direction=INOUT)
public boolean keep_cross_validation_predictions

response_column

@API(help="Response column",
     is_member_of_frames={"training_frame","validation_frame"},
     is_mutually_exclusive_with="ignored_columns",
     direction=INOUT)
public FrameV3.ColSpecifierV3 response_column

weights_column

@API(help="Column with observation weights",
     is_member_of_frames={"training_frame","validation_frame"},
     is_mutually_exclusive_with={"ignored_columns","response_column"},
     direction=INOUT)
public FrameV3.ColSpecifierV3 weights_column

offset_column

@API(help="Offset column",
     is_member_of_frames={"training_frame","validation_frame"},
     is_mutually_exclusive_with={"ignored_columns","response_column","weights_column"},
     direction=INOUT)
public FrameV3.ColSpecifierV3 offset_column

fold_column

@API(help="Column with cross-validation fold index assignment per observation",
     is_member_of_frames="training_frame",
     is_mutually_exclusive_with={"ignored_columns","response_column","weights_column","offset_column"},
     direction=INOUT)
public FrameV3.ColSpecifierV3 fold_column

fold_assignment

@API(help="Cross-validation fold assignment scheme, if fold_column is not specified",
     values={"Random","Modulo"},
     level=expert,
     direction=INOUT)
public Model.Parameters.FoldAssignmentScheme fold_assignment

ignored_columns

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

ignore_const_cols

@API(help="Ignore constant columns",
     direction=INOUT)
public boolean ignore_const_cols

score_each_iteration

@API(help="Whether to score during each iteration of model training",
     direction=INOUT,
     level=secondary)
public boolean score_each_iteration

Constructor Detail

ModelParametersSchema

public ModelParametersSchema()

Method Detail

fields

public java.lang.String[] fields()

append_field_arrays

protected static java.lang.String[] append_field_arrays(java.lang.String[] first,
                                     java.lang.String[] second)

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.