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.io.Externalizable, java.io.Serializable, 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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	algo
protected long	checksum
protected Key	key
protected ModelOutputSchema	output
protected ModelParametersSchema	parameters

Fields inherited from class water.api.Schema

_version_pattern, schema_name, schema_type, schema_version

Constructor Summary

Constructors

Constructor and Description
ModelSchema()
ModelSchema(M m)

Method Summary

Methods

Modifier and Type	Method and Description
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) Version and Schema-specific filling from the implementation object.
AutoBuffer	writeJSON_impl(AutoBuffer ab) Implementation of the Iced serialization protocol, only called by auto-genned code.

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, createImpl, extractVersion, fillFromParms, fillImpl, 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

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,
     direction=INOUT)
protected Key key

algo

@API(help="The algo name for this Model.",
     direction=OUTPUT)
protected java.lang.String algo

parameters

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

output

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

checksum

@API(help="Checksum for all the things that go into building the Model.",
     direction=OUTPUT)
protected long checksum

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.

fillFromImpl

public S fillFromImpl(M m)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

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

writeJSON_impl

public AutoBuffer writeJSON_impl(AutoBuffer ab)

Description copied from class: Iced

Implementation of the Iced serialization protocol, only called by auto-genned code. Not intended to be called by user code. Override only for custom Iced serializers.

Specified by:

writeJSON_impl in interface Freezable

Overrides:

writeJSON_impl in class Iced

Parameters:

ab - AutoBuffer to write this object to.

Returns:

Returns the original AutoBuffer for flow-coding.