hex.schemas

Class GridSchemaV99

java.lang.Object

water.Iced

water.api.Schema<I,S>

water.api.schemas3.SchemaV3<Grid,GridSchemaV99>

hex.schemas.GridSchemaV99

All Implemented Interfaces:

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

public class GridSchemaV99
extends SchemaV3<Grid,GridSchemaV99>

REST endpoint representing single grid object. FIXME: Grid should contain also grid definition - model parameters and definition of hyper parameters.

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
ModelMetricsBaseV3[]	cross_validation_metrics
TwoDimTableV3[]	cross_validation_metrics_summary
boolean	decreasing
ModelParametersSchemaV3[]	failed_params
java.lang.String[][]	failed_raw_params
java.lang.String[]	failure_details
java.lang.String[]	failure_stack_traces
KeyV3.GridKeyV3	grid_id
java.lang.String[]	hyper_names
KeyV3.ModelKeyV3[]	model_ids
java.lang.String	sort_by
ModelMetricsBaseV3[]	training_metrics
ModelMetricsBaseV3[]	validation_metrics

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
GridSchemaV99()

Method Summary

Methods

Modifier and Type	Method and Description
Grid	createImpl() Create an appropriate implementation object and any child objects but does not fill them.
GridSchemaV99	fillFromImpl(Grid grid) 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, extractVersionFromSchemaName, fillFromImpl, 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

grid_id

@API(help="Grid id")
public KeyV3.GridKeyV3 grid_id

sort_by

@API(help="Model performance metric to sort by. Examples: logloss, residual_deviance, mse, rmse, mae,rmsle, auc, r2, f1, recall, precision, accuracy, mcc, err, err_count, lift_top_group, max_per_class_error",
     required=false,
     direction=INOUT)
public java.lang.String sort_by

decreasing

@API(help="Specify whether sort order should be decreasing.",
     required=false,
     direction=INOUT)
public boolean decreasing

model_ids

@API(help="Model IDs built by a grid search")
public KeyV3.ModelKeyV3[] model_ids

hyper_names

@API(help="Used hyper parameters.",
     direction=OUTPUT)
public java.lang.String[] hyper_names

failed_params

@API(help="List of failed parameters",
     direction=OUTPUT)
public ModelParametersSchemaV3[] failed_params

failure_details

@API(help="List of detailed failure messages",
     direction=OUTPUT)
public java.lang.String[] failure_details

failure_stack_traces

@API(help="List of detailed failure stack traces",
     direction=OUTPUT)
public java.lang.String[] failure_stack_traces

failed_raw_params

@API(help="List of raw parameters causing model building failure",
     direction=OUTPUT)
public java.lang.String[][] failed_raw_params

training_metrics

@API(help="Training model metrics for the returned models; only returned if sort_by is set",
     direction=OUTPUT)
public ModelMetricsBaseV3[] training_metrics

validation_metrics

@API(help="Validation model metrics for the returned models; only returned if sort_by is set",
     direction=OUTPUT)
public ModelMetricsBaseV3[] validation_metrics

cross_validation_metrics

@API(help="Cross validation model metrics for the returned models; only returned if sort_by is set",
     direction=OUTPUT)
public ModelMetricsBaseV3[] cross_validation_metrics

cross_validation_metrics_summary

@API(help="Cross validation model metrics summary for the returned models; only returned if sort_by is set",
     direction=OUTPUT)
public TwoDimTableV3[] cross_validation_metrics_summary

Constructor Detail

GridSchemaV99

public GridSchemaV99()

Method Detail

createImpl

public Grid createImpl()

Description copied from class: Schema

Create an appropriate implementation object and any child objects but does not fill them. The standard 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<Grid,GridSchemaV99>

fillFromImpl

public GridSchemaV99 fillFromImpl(Grid grid)

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<Grid,GridSchemaV99>