hex.kmeans

Class KMeansGrid

java.lang.Object

water.Iced<T>

water.Keyed<T>

water.Lockable<G>

hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

hex.kmeans.KMeansGrid

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, water.Freezable<KMeansGrid>

public class KMeansGrid
extends hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

A Grid of Models Used to explore Model hyper-parameter space. Lazily filled in, this object represents the potentially infinite variety of hyperparameters of a given model & dataset. One subclass per kind of Model, e.g. KMeans or GLM or GBM or DL. The Grid tracks Models and their hyperparameters, and will allow discovery of existing Models by hyperparameter, or building Models on demand by hyperparameter. The Grid can manage a (simplistic) hyperparameter search space. Hyperparameter values are limited to doubles in the API, but can be anything the subclass Grid desires internally. E.g. the Grid for KMeans will convert the initial center selection Enum to and from a simple integer value internally.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class hex.Grid

hex.Grid.GridSearch

Nested classes/interfaces inherited from class water.Keyed

water.Keyed.BinarySerializer<X extends water.Keyed>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODEL_NAME

Fields inherited from class hex.Grid

_fr

Fields inherited from class water.Lockable

_lockers

Fields inherited from class water.Keyed

_key, EMPTY_KEY_LIST

Constructor Summary

Constructors

Constructor and Description
KMeansGrid() FIXME: Rest API requirement - do not call directly

Method Summary

Methods

Modifier and Type	Method and Description
protected KMeansModel.KMeansParameters	applyHypers(KMeansModel.KMeansParameters params, double[] hypers)
protected hex.ModelBuilder	createBuilder(KMeansModel.KMeansParameters params)
static KMeansGrid	get(water.fvec.Frame fr)
double[]	getHypers(KMeansModel.KMeansParameters params)
protected double[]	hyperDefaults()
protected java.lang.String[]	hyperNames()
protected java.lang.String	modelName()
protected double	suggestedNextHyperValue(int h, hex.Model m, double[] hyperLimits)

Methods inherited from class hex.Grid

checksum_impl, getBuilder, keyName, model, model, remove_impl, startGridSearch, trainingFrame

Methods inherited from class water.Lockable

delete_and_lock, delete, delete, delete, read_lock, read_lock, unlock_all, unlock, update, write_lock

Methods inherited from class water.Keyed

checksum, getBinarySerializer, getPublishedKeys, remove, remove, remove, remove

Methods inherited from class water.Iced

clone, frozenType, read_impl, read, readExternal, readJSON_impl, readJSON, toJsonString, 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_NAME

public static final java.lang.String MODEL_NAME

See Also:

Constant Field Values

Constructor Detail

KMeansGrid

public KMeansGrid()

FIXME: Rest API requirement - do not call directly

Method Detail

modelName

protected java.lang.String modelName()

Overrides:

modelName in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

hyperNames

protected java.lang.String[] hyperNames()

Overrides:

hyperNames in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

hyperDefaults

protected double[] hyperDefaults()

Overrides:

hyperDefaults in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

suggestedNextHyperValue

protected double suggestedNextHyperValue(int h,
                             hex.Model m,
                             double[] hyperLimits)

Overrides:

suggestedNextHyperValue in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

createBuilder

protected hex.ModelBuilder createBuilder(KMeansModel.KMeansParameters params)

Overrides:

createBuilder in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

applyHypers

protected KMeansModel.KMeansParameters applyHypers(KMeansModel.KMeansParameters params,
                                       double[] hypers)

Overrides:

applyHypers in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

getHypers

public double[] getHypers(KMeansModel.KMeansParameters params)

Overrides:

getHypers in class hex.Grid<KMeansModel.KMeansParameters,KMeansGrid>

get

public static KMeansGrid get(water.fvec.Frame fr)