water.api.schemas3

Class ModelMetricsBaseV3<I extends ModelMetrics,S extends ModelMetricsBaseV3<I,S>>

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

water.api.schemas3.ModelMetricsBaseV3<I,S>

All Implemented Interfaces:

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

Direct Known Subclasses:

ModelMetricsAutoEncoderV3, ModelMetricsBinomialUpliftV3, ModelMetricsBinomialV3, ModelMetricsClusteringV3, ModelMetricsHGLMV3, ModelMetricsMultinomialV3, ModelMetricsOrdinalGenericV3, ModelMetricsOrdinalV3, ModelMetricsRegressionGenericV3, ModelMetricsRegressionV3

public class ModelMetricsBaseV3<I extends ModelMetrics,S extends ModelMetricsBaseV3<I,S>>
extends SchemaV3<I,S>

Base Schema for individual instances of ModelMetrics objects. Note: this class should not be used directly.

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	custom_metric_name
double	custom_metric_value
java.lang.String	description
KeyV3.FrameKeyV3	frame
long	frame_checksum
KeyV3.ModelKeyV3	model
hex.ModelCategory	model_category
long	model_checksum
double	MSE
long	nobs
FrameV3	predictions
double	RMSE
long	scoring_time

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
ModelMetricsBaseV3()
ModelMetricsBaseV3(I impl)

Method Summary

Modifier and Type	Method and Description
S	fillFromImpl(ModelMetrics modelMetrics) 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, fillFromAny, fillFromBody, 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

@API(help="The model used for this scoring run.",
     direction=INOUT)
public KeyV3.ModelKeyV3 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 KeyV3.FrameKeyV3 frame

frame_checksum

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

description

@API(help="Optional description for this scoring run (to note out-of-bag, sampled data, etc.)",
     direction=OUTPUT)
public java.lang.String description

model_category

@API(help="The category (e.g., Clustering) for the model used for this scoring run.",
     values={"Unknown","Binomial","BinomialUplift","Ordinal","Multinomial","Regression","Clustering"},
     direction=OUTPUT)
public hex.ModelCategory model_category

scoring_time

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

predictions

@API(help="Predictions Frame.",
     direction=OUTPUT)
public FrameV3 predictions

MSE

@API(help="The Mean Squared Error of the prediction for this scoring run.",
     direction=OUTPUT)
public double MSE

RMSE

@API(help="The Root Mean Squared Error of the prediction for this scoring run.",
     direction=OUTPUT)
public double RMSE

nobs

@API(help="Number of observations.")
public long nobs

custom_metric_name

@API(help="Name of custom metric",
     direction=OUTPUT)
public java.lang.String custom_metric_name

custom_metric_value

@API(help="Value of custom metric",
     direction=OUTPUT)
public double custom_metric_value

Constructor Detail

ModelMetricsBaseV3

public ModelMetricsBaseV3()

ModelMetricsBaseV3

public ModelMetricsBaseV3(I impl)

Method Detail

fillFromImpl

public S fillFromImpl(ModelMetrics modelMetrics)

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<I extends ModelMetrics,S extends ModelMetricsBaseV3<I,S>>