hex.grid

Class HyperSpaceWalker.CartesianWalker<MP extends Model.Parameters>

java.lang.Object

hex.grid.HyperSpaceWalker.CartesianWalker<MP>

All Implemented Interfaces:

HyperSpaceWalker<MP>

Enclosing interface:

HyperSpaceWalker<MP extends Model.Parameters>

public static class HyperSpaceWalker.CartesianWalker<MP extends Model.Parameters>
extends java.lang.Object
implements HyperSpaceWalker<MP>

The external Grid 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/interfaces inherited from interface hex.grid.HyperSpaceWalker

HyperSpaceWalker.CartesianWalker<MP extends Model.Parameters>, HyperSpaceWalker.HyperSpaceIterator<MP extends Model.Parameters>, HyperSpaceWalker.RandomWalker<MP extends Model.Parameters>

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected int	computeSizeOfHyperSpace()
java.lang.String[]	getHyperParamNames() Returns hyper parameters names which are used for walking the hyper parameters space.
int	getHyperSpaceSize() Return estimated size of hyperspace.
ModelParametersBuilderFactory<MP>	getParametersBuilderFactory()
MP	getParams() Return initial model parameters for search.
HyperSpaceWalker.HyperSpaceIterator<MP>	iterator() Returns an iterator to traverse this hyper-space.

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperSpaceWalker.CartesianWalker

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

Parameters:

paramsBuilderFactory -

hyperParams -

Method Detail

iterator

public HyperSpaceWalker.HyperSpaceIterator<MP> iterator()

Description copied from interface: HyperSpaceWalker

Returns an iterator to traverse this hyper-space.

Specified by:

iterator in interface HyperSpaceWalker<MP extends Model.Parameters>

Returns:

an iterator

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>

Returns:

names of used hyper parameters

getHyperSpaceSize

public int getHyperSpaceSize()

Description copied from interface: HyperSpaceWalker

Return estimated size of hyperspace. Can return -1 if estimate is not available.

Specified by:

getHyperSpaceSize in interface HyperSpaceWalker<MP extends Model.Parameters>

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>

Returns:

return model parameters

getParametersBuilderFactory

public ModelParametersBuilderFactory<MP> getParametersBuilderFactory()

Specified by:

getParametersBuilderFactory in interface HyperSpaceWalker<MP extends Model.Parameters>

computeSizeOfHyperSpace

protected int computeSizeOfHyperSpace()