water.api.schemas3

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

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

water.api.schemas3.ModelOutputSchemaV3<O,S>

All Implemented Interfaces:

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

public class ModelOutputSchemaV3<O extends Model.Output,S extends ModelOutputSchemaV3<O,S>>
extends SchemaV3<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.schemas3.SchemaV3

SchemaV3.Meta

Field Summary

Fields

Modifier and Type	Field and Description
KeyV3.FrameKeyV3	cross_validation_fold_assignment_frame_id
KeyV3.FrameKeyV3	cross_validation_holdout_predictions_frame_id
ModelMetricsBaseV3	cross_validation_metrics
TwoDimTableV3	cross_validation_metrics_summary
KeyV3.ModelKeyV3[]	cross_validation_models
KeyV3.FrameKeyV3[]	cross_validation_predictions
java.lang.String[][]	domains
long	end_time
IcedHashMap.IcedHashMapStringString	help
hex.ModelCategory	model_category
TwoDimTableV3	model_summary
java.lang.String[]	names
long	run_time
TwoDimTableV3	scoring_history
long	start_time
java.lang.String	status
ModelMetricsBaseV3	training_metrics
ModelMetricsBaseV3	validation_metrics

Fields inherited from class water.api.schemas3.SchemaV3

__meta, _exclude_fields

Constructor Summary

Constructors

Constructor and Description
ModelOutputSchemaV3()

Method Summary

Methods

Modifier and Type	Method and Description
S	fillFromImpl(O impl) Fill this Schema from the given implementation object.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

createAndFillImpl, createImpl, extractVersionFromSchemaName, fillFromImpl, 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, toJsonString, write, writeExternal

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 columns",
     direction=OUTPUT,
     level=expert)
public java.lang.String[][] domains

cross_validation_models

@API(help="Cross-validation models (model ids)",
     direction=OUTPUT,
     level=expert)
public KeyV3.ModelKeyV3[] cross_validation_models

cross_validation_predictions

@API(help="Cross-validation predictions, one per cv model (deprecated, use cross_validation_holdout_predictions_frame_id instead)",
     direction=OUTPUT,
     level=expert)
public KeyV3.FrameKeyV3[] cross_validation_predictions

cross_validation_holdout_predictions_frame_id

@API(help="Cross-validation holdout predictions (full out-of-sample predictions on training data)",
     direction=OUTPUT,
     level=expert)
public KeyV3.FrameKeyV3 cross_validation_holdout_predictions_frame_id

cross_validation_fold_assignment_frame_id

@API(help="Cross-validation fold assignment (each row is assigned to one holdout fold)",
     direction=OUTPUT,
     level=expert)
public KeyV3.FrameKeyV3 cross_validation_fold_assignment_frame_id

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

model_summary

@API(help="Model summary",
     direction=OUTPUT,
     level=critical)
public TwoDimTableV3 model_summary

scoring_history

@API(help="Scoring history",
     direction=OUTPUT,
     level=secondary)
public TwoDimTableV3 scoring_history

training_metrics

@API(help="Training data model metrics",
     direction=OUTPUT,
     level=critical)
public ModelMetricsBaseV3 training_metrics

validation_metrics

@API(help="Validation data model metrics",
     direction=OUTPUT,
     level=critical)
public ModelMetricsBaseV3 validation_metrics

cross_validation_metrics

@API(help="Cross-validation model metrics",
     direction=OUTPUT,
     level=critical)
public ModelMetricsBaseV3 cross_validation_metrics

cross_validation_metrics_summary

@API(help="Cross-validation model metrics summary",
     direction=OUTPUT,
     level=critical)
public TwoDimTableV3 cross_validation_metrics_summary

status

@API(help="Job status",
     direction=OUTPUT,
     level=secondary)
public java.lang.String status

start_time

@API(help="Start time in milliseconds",
     direction=OUTPUT,
     level=secondary)
public long start_time

end_time

@API(help="End time in milliseconds",
     direction=OUTPUT,
     level=secondary)
public long end_time

run_time

@API(help="Runtime in milliseconds",
     direction=OUTPUT,
     level=secondary)
public long run_time

help

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

Constructor Detail

ModelOutputSchemaV3

public ModelOutputSchemaV3()

Method Detail

fillFromImpl

public S fillFromImpl(O impl)

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<O extends Model.Output,S extends ModelOutputSchemaV3<O,S>>