hex.grid

Class HyperSpaceWalker.BaseWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

java.lang.Object

hex.grid.HyperSpaceWalker.BaseWalker<MP,C>

All Implemented Interfaces:

HyperSpaceWalker<MP,C>

Direct Known Subclasses:

HyperSpaceWalker.CartesianWalker, HyperSpaceWalker.RandomDiscreteValueWalker

Enclosing interface:

HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

public abstract static class HyperSpaceWalker.BaseWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>
extends java.lang.Object
implements HyperSpaceWalker<MP,C>

Superclass for for all hyperparameter space walkers.

The external Grid / Hyperparameter search API uses a HashMap to describe a set of hyperparameter values, where the String is a valid field name in the corresponding Model.Parameter, and the Object is the field value (boxed as needed).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HyperSpaceWalker.BaseWalker.WalkerFactory<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria> Java hackery so we can have a factory method on a class with type params.

Nested classes/interfaces inherited from interface hex.grid.HyperSpaceWalker

HyperSpaceWalker.BaseWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>, HyperSpaceWalker.CartesianWalker<MP extends Model.Parameters>, HyperSpaceWalker.HyperSpaceIterator<MP extends Model.Parameters>, HyperSpaceWalker.RandomDiscreteValueWalker<MP extends Model.Parameters>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	_hyperParamNames Cached names of used hyper parameters.
protected java.lang.String[]	_hyperParamNamesSubspace
protected java.util.Map<java.lang.String,java.lang.Object[]>	_hyperParams Hyper space description - in this case only dimension and possible values.
protected java.util.Map<java.lang.String,java.lang.Object[]>[]	_hyperParamSubspaces
protected long	_maxHyperSpaceSize Compute max size of hyper space to walk.
protected C	_search_criteria
static java.lang.String	SUBSPACES

Constructor Summary

Constructors

Constructor and Description
BaseWalker(MP params, java.util.Map<java.lang.String,java.lang.Object[]> hyperParams, ModelParametersBuilderFactory<MP> paramsBuilderFactory, C search_criteria)

Method Summary

Modifier and Type	Method and Description
protected long	computeMaxSizeOfHyperSpace()
java.lang.String[]	getAllHyperParamNamesInSubspaces()
java.lang.String[]	getHyperParamNames() Returns hyper parameters names which are used for walking the hyper parameters space.
java.util.Map<java.lang.String,java.lang.Object[]>	getHyperParams()
long	getMaxHyperSpaceSize() Return estimated maximum size of hyperspace, not subject to any early stopping criteria.
protected MP	getModelParams(MP params, java.lang.Object[] hyperParams, java.lang.String[] hyperParamNames)
ModelParametersBuilderFactory<MP>	getParametersBuilderFactory()
MP	getParams() Return initial model parameters for search.
protected java.lang.Object[]	hypers(java.util.Map<java.lang.String,java.lang.Object[]> hyperParams, java.lang.String[] hyperParamNames, int[] hidx) Given a list of indices for the hyperparameter values return an Object[] of the actual values.
protected int	integerHash(java.util.Map<java.lang.String,java.lang.Object[]> hyperParams, java.lang.String[] hyperParamNames, int[] ar, int subspaceNum)
protected java.util.Map<java.lang.String,java.lang.Object[]>	mergeHashMaps(java.util.Map<java.lang.String,java.lang.Object[]> hyperparams, java.util.Map<java.lang.String,java.lang.Object[]> subspace)
C	search_criteria() Search criteria for the hyperparameter search including directives for how to search and when to stop the search.
boolean	stopEarly(Model model, ScoringInfo[] sk) Based on the last model, the given array of ScoringInfo, and our stopping criteria should we stop early?

Methods inherited from class java.lang.Object

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

Methods inherited from interface hex.grid.HyperSpaceWalker

estimateGridWork, getAllHyperParamNames, iterator

Field Detail

_search_criteria

protected final C extends HyperSpaceSearchCriteria _search_criteria

See Also:

search_criteria()

SUBSPACES

public static final java.lang.String SUBSPACES

See Also:

Constant Field Values

_hyperParams

protected final java.util.Map<java.lang.String,java.lang.Object[]> _hyperParams

Hyper space description - in this case only dimension and possible values.

_hyperParamNames

protected final java.lang.String[] _hyperParamNames

Cached names of used hyper parameters.

_hyperParamNamesSubspace

protected final java.lang.String[] _hyperParamNamesSubspace

_hyperParamSubspaces

protected java.util.Map<java.lang.String,java.lang.Object[]>[] _hyperParamSubspaces

_maxHyperSpaceSize

protected final long _maxHyperSpaceSize

Compute max size of hyper space to walk. May include duplicates if points in space are specified multiple times.

Constructor Detail

BaseWalker

public BaseWalker(MP params,
                  java.util.Map<java.lang.String,java.lang.Object[]> hyperParams,
                  ModelParametersBuilderFactory<MP> paramsBuilderFactory,
                  C search_criteria)

Parameters:

paramsBuilderFactory -

hyperParams -

Method Detail

search_criteria

public C search_criteria()

Search criteria for the hyperparameter search including directives for how to search and when to stop the search.

Specified by:

search_criteria in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

stopEarly

public boolean stopEarly(Model model,
                         ScoringInfo[] sk)

Based on the last model, the given array of ScoringInfo, and our stopping criteria should we stop early?

Specified by:

stopEarly in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

getHyperParamNames

public java.lang.String[] getHyperParamNames()

Description copied from interface: HyperSpaceWalker

Returns hyper parameters names which are used for walking the hyper parameters space. The names have to match the names of attributes in model parameters MP.

Specified by:

getHyperParamNames in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

Returns:

names of used hyper parameters

getAllHyperParamNamesInSubspaces

public java.lang.String[] getAllHyperParamNamesInSubspaces()

Specified by:

getAllHyperParamNamesInSubspaces in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

getHyperParams

public java.util.Map<java.lang.String,java.lang.Object[]> getHyperParams()

Specified by:

getHyperParams in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

getMaxHyperSpaceSize

public long getMaxHyperSpaceSize()

Description copied from interface: HyperSpaceWalker

Return estimated maximum size of hyperspace, not subject to any early stopping criteria. Can return -1 if estimate is not available.

Specified by:

getMaxHyperSpaceSize in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

Returns:

size of hyper space to explore

getParams

public MP getParams()

Description copied from interface: HyperSpaceWalker

Return initial model parameters for search.

Specified by:

getParams in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

Returns:

return model parameters

getParametersBuilderFactory

public ModelParametersBuilderFactory<MP> getParametersBuilderFactory()

Specified by:

getParametersBuilderFactory in interface HyperSpaceWalker<MP extends Model.Parameters,C extends HyperSpaceSearchCriteria>

getModelParams

protected MP getModelParams(MP params,
                            java.lang.Object[] hyperParams,
                            java.lang.String[] hyperParamNames)

computeMaxSizeOfHyperSpace

protected long computeMaxSizeOfHyperSpace()

mergeHashMaps

protected java.util.Map<java.lang.String,java.lang.Object[]> mergeHashMaps(java.util.Map<java.lang.String,java.lang.Object[]> hyperparams,
                                                                           java.util.Map<java.lang.String,java.lang.Object[]> subspace)

hypers

protected java.lang.Object[] hypers(java.util.Map<java.lang.String,java.lang.Object[]> hyperParams,
                                    java.lang.String[] hyperParamNames,
                                    int[] hidx)

Given a list of indices for the hyperparameter values return an Object[] of the actual values.

integerHash

protected int integerHash(java.util.Map<java.lang.String,java.lang.Object[]> hyperParams,
                          java.lang.String[] hyperParamNames,
                          int[] ar,
                          int subspaceNum)