water.api

Class ModelSchema<M extends Model<M,P,O>,S extends ModelSchema<M,S,P,PS,O,OS>,P extends Model.Parameters,PS extends ModelParametersSchema<P,PS>,O extends Model.Output,OS extends ModelOutputSchema<O,OS>>

java.lang.Object

water.Iced

water.api.Schema<M,S>

water.api.ModelSchemaBase<M,S>

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

All Implemented Interfaces:

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

public class ModelSchema<M extends Model<M,P,O>,S extends ModelSchema<M,S,P,PS,O,OS>,P extends Model.Parameters,PS extends ModelParametersSchema<P,PS>,O extends Model.Output,OS extends ModelOutputSchema<O,OS>>
extends ModelSchemaBase<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

Nested Class Summary

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

Schema.Meta

Field Summary

Fields

Modifier and Type	Field and Description
protected long	checksum
OS	output
PS	parameters

Fields inherited from class water.api.ModelSchemaBase

algo, algo_full_name, data_frame, model_id, response_column_name, timestamp

Constructor Summary

Constructors

Constructor and Description
ModelSchema()
ModelSchema(M m)

Method Summary

Methods

Modifier and Type	Method and Description
OS	createOutputSchema() Factory method to create the model-specific output schema.
PS	createParametersSchema() Factory method to create the model-specific parameters schema.
S	fillFromImpl(M m) Fill this Schema from the given 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

createAndFillImpl, createImpl, fillFromParms, fillFromParms, fillImpl, get__meta, getExperimentalVersion, getHighestSupportedVersion, getImplClass, getImplClass, getLatestVersion, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, registerAllSchemasIfNecessary, schema, schema, schemaClass, schemaClass, schemas, setField

Methods inherited from class water.Iced

clone, copyOver, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, write_impl, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

parameters

@API(help="The build parameters for the model (e.g. K for KMeans).",
     direction=OUTPUT)
public PS extends ModelParametersSchema<P,PS> parameters

output

@API(help="The build output for the model (e.g. the cluster centers for KMeans).",
     direction=OUTPUT)
public OS extends ModelOutputSchema<O,OS> 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 PS createParametersSchema()

Factory method to create the model-specific parameters schema.

createOutputSchema

public OS createOutputSchema()

Factory method to create the model-specific output schema.

fillFromImpl

public S fillFromImpl(M m)

Description copied from class: Schema

Fill this Schema from the given implementation object. If a schema doesn't need to adapt any fields if does not need to override this method.

Overrides:

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

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.