hex.schemas

Class GridSearchSchema<G extends Grid<MP>,S extends GridSearchSchema<G,S,MP,P>,MP extends Model.Parameters,P extends ModelParametersSchemaV3>

java.lang.Object

water.Iced

water.api.Schema<I,S>

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

hex.schemas.GridSearchSchema<G,S,MP,P>

Type Parameters:

G - a specific implementation type for GridSearch holding results of grid search (model list)

S - self type

MP - actual model parameters type

P - a specific model builder parameters schema, since we cannot derive it from P

All Implemented Interfaces:

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

public class GridSearchSchema<G extends Grid<MP>,S extends GridSearchSchema<G,S,MP,P>,MP extends Model.Parameters,P extends ModelParametersSchemaV3>
extends SchemaV3<G,S>

This is a common grid search schema composed of two parameters: default parameters for a builder and hyper parameters which are given as a mapping from parameter name to list of possible values.

TODO: this needs a V99 subclass for bindings generation.

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.GridKeyV3	grid_id
IcedHashMap<java.lang.String,java.lang.Object[]>	hyper_parameters
JobV3	job
P	parameters
HyperSpaceSearchCriteriaV99	search_criteria
int	total_models

Fields inherited from class water.api.schemas3.SchemaV3

__meta

Constructor Summary

Constructors

Constructor and Description
GridSearchSchema()

Method Summary

Methods

Modifier and Type	Method and Description
S	fillFromImpl(G impl) Fill this Schema from the given implementation object.
S	fillFromParms(java.util.Properties parms) Fill this Schema object from a set of parameters.

Methods inherited from class water.api.schemas3.SchemaV3

writeJSON

Methods inherited from class water.api.Schema

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

parameters

@API(help="Basic model builder parameters.",
     direction=INPUT)
public P extends ModelParametersSchemaV3 parameters

hyper_parameters

@API(help="Grid search parameters.",
     direction=INOUT)
public IcedHashMap<java.lang.String,java.lang.Object[]> hyper_parameters

grid_id

@API(help="Destination id for this grid; auto-generated if not specified.",
     required=false,
     direction=INOUT)
public KeyV3.GridKeyV3 grid_id

search_criteria

@API(help="Hyperparameter search criteria, including strategy and early stopping directives.  If it is not given, exhaustive Cartesian is used.",
     required=false,
     direction=INOUT)
public HyperSpaceSearchCriteriaV99 search_criteria

total_models

@API(help="Number of all models generated by grid search.",
     direction=OUTPUT)
public int total_models

job

@API(help="Job Key.",
     direction=OUTPUT)
public JobV3 job

Constructor Detail

GridSearchSchema

public GridSearchSchema()

Method Detail

fillFromParms

public S fillFromParms(java.util.Properties parms)

Description copied from class: Schema

Fill this Schema object from a set of parameters.

Overrides:

fillFromParms in class Schema<G extends Grid<MP>,S extends GridSearchSchema<G,S,MP,P>>

Parameters:

parms - parameters - set of tuples (parameter name, parameter value)

Returns:

this schema

See Also:

Schema.fillFromParms(Properties, boolean)

fillFromImpl

public S fillFromImpl(G 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<G extends Grid<MP>,S extends GridSearchSchema<G,S,MP,P>>