water.api

Class ModelMetricsBase

java.lang.Object

water.Iced

water.api.Schema<ModelMetrics,ModelMetricsBase>

water.api.ModelMetricsBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ModelMetricsV3

public abstract class ModelMetricsBase
extends Schema<ModelMetrics,ModelMetricsBase>

Base Schema for individual instances of ModelMetrics objects.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
AUCBase	auc
ConfusionMatrixBase	cm
long	duration_in_ms
water.api.FrameV2	frame
long	frame_checksum
ModelSchema	model
Model.ModelCategory	model_category
long	model_checksum
water.api.FrameV2	predictions
long	scoring_time

Fields inherited from class water.api.Schema

_version_pattern, schema_name, schema_type, schema_version

Constructor Summary

Constructors

Constructor and Description
ModelMetricsBase()

Method Summary

Methods

Modifier and Type	Method and Description
ModelMetrics	createImpl() Create an implementation object and any child objects but DO NOT fill them.
ModelMetricsBase	fillFromImpl(ModelMetrics modelMetrics) Version and Schema-specific filling from the implementation object.
ModelMetrics	fillImpl(ModelMetrics m) Fill an impl object and any children from this schema and its children.
static ModelMetricsBase	schema(int version)

Methods inherited from class water.api.Schema

acceptsFrame, createAndFillImpl, extractVersion, fillFromParms, 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_impl, writeJSON

Methods inherited from class java.lang.Object

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

Field Detail

model

@API(help="The model used for this scoring run.",
     direction=INOUT)
public ModelSchema model

model_checksum

@API(help="The checksum for the model used for this scoring run.",
     direction=INOUT)
public long model_checksum

frame

@API(help="The frame used for this scoring run.",
     direction=INOUT)
public water.api.FrameV2 frame

frame_checksum

@API(help="The checksum for the frame used for this scoring run.",
     direction=INOUT)
public long frame_checksum

model_category

@API(help="The category (e.g., Clustering) for the model used for this scoring run.",
     direction=OUTPUT)
public Model.ModelCategory model_category

duration_in_ms

@API(help="The duration in mS for this scoring run.",
     direction=OUTPUT)
public long duration_in_ms

scoring_time

@API(help="The time in mS since the epoch for the start of this scoring run.",
     direction=OUTPUT)
public long scoring_time

auc

@API(help="The AUC object for this scoring run.",
     direction=OUTPUT)
public AUCBase auc

cm

@API(help="The ConfusionMatrix object for this scoring run.",
     direction=OUTPUT)
public ConfusionMatrixBase cm

predictions

@API(help="Predictions Frame.",
     direction=OUTPUT)
public water.api.FrameV2 predictions

Constructor Detail

ModelMetricsBase

public ModelMetricsBase()

Method Detail

createImpl

public ModelMetrics createImpl()

Description copied from class: Schema

Create an implementation object and any child objects but DO NOT fill them. The purpose of a createImpl without a fillImpl is to be able to get the default values for all the impl's fields.

For objects without children this method does all the required work. For objects with children the subclass will need to override, e.g. by calling super.createImpl() and then calling createImpl() on its children.

Note that impl objects for schemas which override this method don't need to have a default constructor (e.g., a Keyed object constructor can still create and set the Key), but they must not fill any fields which can be filled later from the schema.

TODO: We *could* handle the common case of children with the same field names here by finding all of our fields that are themselves Schemas.

Overrides:

createImpl in class Schema<ModelMetrics,ModelMetricsBase>

fillImpl

public ModelMetrics fillImpl(ModelMetrics m)

Description copied from class: Schema

Fill an impl object and any children from this schema and its children.

Overrides:

fillImpl in class Schema<ModelMetrics,ModelMetricsBase>

fillFromImpl

public ModelMetricsBase fillFromImpl(ModelMetrics modelMetrics)

Description copied from class: Schema

Version and Schema-specific filling from the implementation object.

Overrides:

fillFromImpl in class Schema<ModelMetrics,ModelMetricsBase>

schema

public static ModelMetricsBase schema(int version)