water.api

Class ModelOutputSchema<O extends Model.Output,S extends ModelOutputSchema<O,S>>

java.lang.Object

water.Iced

water.api.Schema<O,S>

water.api.ModelOutputSchema<O,S>

All Implemented Interfaces:

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

public class ModelOutputSchema<O extends Model.Output,S extends ModelOutputSchema<O,S>>
extends Schema<O,S>

An instance of a ModelOutput schema contains the Model build output (e.g., the cluster centers for KMeans). NOTE: use subclasses, not this class directly. It is not abstract only so that we can instantiate it to generate metadata for it for the metadata API.

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
java.lang.String[][]	domains
IcedHashMap.IcedHashMapStringString	help
hex.ModelCategory	model_category
java.lang.String[]	names

Fields inherited from class water.api.Schema

__meta, _impl_class, _version_pattern, EXCLUDE_FIELDS, INCLUDE_FIELDS

Constructor Summary

Constructors

Constructor and Description
ModelOutputSchema()

Method Summary

Methods

Modifier and Type	Method and Description
S	fillFromImpl(O impl) Version and Schema-specific filling from the implementation object.

Methods inherited from class water.api.Schema

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

names

@API(help="Column names.",
     direction=OUTPUT)
public java.lang.String[] names

domains

@API(help="Domains for categorical (enum) columns.",
     direction=OUTPUT,
     level=expert)
public java.lang.String[][] domains

model_category

@API(help="Category of the model (e.g., Binomial).",
     values={"Unknown","Binomial","Multinomial","Regression","Clustering","AutoEncoder","DimReduction"},
     direction=OUTPUT)
public hex.ModelCategory model_category

help

@API(help="Help information for output fields",
     direction=OUTPUT)
public IcedHashMap.IcedHashMapStringString help

Constructor Detail

ModelOutputSchema

public ModelOutputSchema()

Method Detail

fillFromImpl

public S fillFromImpl(O impl)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<O extends Model.Output,S extends ModelOutputSchema<O,S>>