water.api

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

java.lang.Object

water.Iced

water.api.Schema<M,S>

water.api.ModelSchema<M,P,O,S>

All Implemented Interfaces:

java.lang.Cloneable, Freezable

public abstract class ModelSchema<M extends Model,P extends Model.Parameters,O extends Model.Output,S extends ModelSchema<M,P,O,S>>
extends Schema<M,S>

A Model schema contains all the pieces associated with a Model:

• an instance of a ModelParameters schema containing the build parameters
• an instance of a ModelResults schema containing the f00 b4r b4z
• an instance of a ModelMetrics schema

Field Summary

Fields

Modifier and Type	Field and Description
protected Key	key
protected ModelOutputSchema	output
protected ModelParametersSchema	parameters

Constructor Summary

Constructors

Constructor and Description
ModelSchema()
ModelSchema(M m)

Method Summary

Methods

Modifier and Type	Method and Description
M	createImpl()
abstract ModelOutputSchema	createOutputSchema() Factory method to create the model-specific output schema.
abstract ModelParametersSchema	createParametersSchema() Factory method to create the model-specific parameters schema.
S	fillFromImpl(M m)
AutoBuffer	writeJSON_impl(AutoBuffer ab)

Methods inherited from class water.api.Schema

acceptsFrame, fillFromParms

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readJSON_impl, readJSON, write_impl, write, writeHTML_impl, writeHTML, writeJSON

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

key

@API(help="Model key",
     required=true)
protected Key key

parameters

@API(help="The build parameters for the model (e.g. K for KMeans).")
protected ModelParametersSchema parameters

output

@API(help="The build output for the model (e.g. the clusters for KMeans).")
protected ModelOutputSchema output

Constructor Detail

ModelSchema

public ModelSchema()

ModelSchema

public ModelSchema(M m)

Method Detail

createParametersSchema

public abstract ModelParametersSchema createParametersSchema()

Factory method to create the model-specific parameters schema.

createOutputSchema

public abstract ModelOutputSchema createOutputSchema()

Factory method to create the model-specific output schema.

createImpl

public M createImpl()

Specified by:

createImpl in class Schema<M extends Model,S extends ModelSchema<M,P,O,S>>

fillFromImpl

public S fillFromImpl(M m)

Specified by:

fillFromImpl in class Schema<M extends Model,S extends ModelSchema<M,P,O,S>>

writeJSON_impl

public AutoBuffer writeJSON_impl(AutoBuffer ab)

Specified by:

writeJSON_impl in interface Freezable

Overrides:

writeJSON_impl in class Iced