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_iterations for KMeans).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModelParametersSchema.ValidationMessageBase<I extends ModelBuilder.ValidationMessage,S extends ModelParametersSchema.ValidationMessageBase<I,S>>
static class	ModelParametersSchema.ValidationMessageV2

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
KeyV1.ModelKeyV1	destination_key
java.lang.String[]	ignored_columns
static java.lang.String[]	own_fields
KeyV1.FrameKeyV1	training_frame
KeyV1.FrameKeyV1	validation_frame

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern

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, 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

own_fields

public static java.lang.String[] own_fields

destination_key

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

training_frame

@API(help="Training frame",
     direction=INOUT)
public KeyV1.FrameKeyV1 training_frame

validation_frame

@API(help="Validation frame",
     direction=INOUT)
public KeyV1.FrameKeyV1 validation_frame

ignored_columns

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

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.