water.api.schemas3

Class ModelSchemaBaseV3<M extends Model<M,?,?>,S extends ModelSchemaBaseV3<M,S>>

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<M,S>

water.api.schemas3.ModelSchemaBaseV3<M,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

ModelSchemaV3, ModelSynopsisV3

public class ModelSchemaBaseV3<M extends Model<M,?,?>,S extends ModelSchemaBaseV3<M,S>>
extends SchemaV3<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.schemas3.SchemaV3

SchemaV3.Meta

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

Schema.AutoParseable

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	algo
java.lang.String	algo_full_name
KeyV3.FrameKeyV3	data_frame
boolean	have_mojo
boolean	have_pojo
KeyV3.ModelKeyV3<M>	model_id
java.lang.String	response_column_name
long	timestamp
java.lang.String	treatment_column_name

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
ModelSchemaBaseV3()
ModelSchemaBaseV3(M m)

Method Summary

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromAny, fillFromBody, fillFromImpl, fillFromImpl, fillFromImpl, fillFromParms, fillFromParms, fillFromParms, fillImpl, fillImpl, getImplClass, getImplClass, getSchemaName, getSchemaType, getSchemaVersion, init_meta, markdown, markdown, newInstance, newInstance, setField, setSchemaType_doNotCall

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonBytes, toJsonString, write, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

model_id

@API(help="Model key",
     required=true,
     direction=INOUT)
public KeyV3.ModelKeyV3<M extends Model<M,?,?>> model_id

algo

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

algo_full_name

@API(help="The pretty algo name for this Model (e.g., Generalized Linear Model, rather than GLM).",
     direction=OUTPUT)
public java.lang.String algo_full_name

response_column_name

@API(help="The response column name for this Model (if applicable). Is null otherwise.",
     direction=OUTPUT)
public java.lang.String response_column_name

treatment_column_name

@API(help="The treatment column name for this Model (if applicable). Is null otherwise.",
     direction=OUTPUT)
public java.lang.String treatment_column_name

data_frame

@API(help="The Model\'s training frame key",
     direction=OUTPUT)
public KeyV3.FrameKeyV3 data_frame

timestamp

@API(help="Timestamp for when this model was completed",
     direction=OUTPUT)
public long timestamp

have_pojo

@API(help="Indicator, whether export to POJO is available",
     direction=OUTPUT)
public boolean have_pojo

have_mojo

@API(help="Indicator, whether export to MOJO is available",
     direction=OUTPUT)
public boolean have_mojo

Constructor Detail

ModelSchemaBaseV3

public ModelSchemaBaseV3()

ModelSchemaBaseV3

public ModelSchemaBaseV3(M m)