Package ai.djl.training.hyperparameter.param

Class HpSet

java.lang.Object

ai.djl.training.hyperparameter.param.Hyperparameter<HpSet>

ai.djl.training.hyperparameter.param.HpSet

public final class HpSet
extends Hyperparameter<HpSet>

A nestable set of Hyperparameters.

Field Summary

Fields inherited from class ai.djl.training.hyperparameter.param.Hyperparameter

name

Constructor Summary

Constructors

Constructor	Description
HpSet(String name)	Cosntructs a new empty HpSet.
HpSet(String name, List<Hyperparameter<?>> hyperParams)	Cosntructs a new HpSet.

Method Summary

Modifier and Type	Method	Description
void	add(Hyperparameter<?> hparam)	Adds a hyperparameter to the set.
Hyperparameter<?>	getHParam(String name)	Returns the hyperparameter in the set with the given name.
HpSet	random()	Returns a random value for the hyperparameter for a range of a fixed value if it is a HpVal.
String	toString()

Methods inherited from class ai.djl.training.hyperparameter.param.Hyperparameter

getName

Methods inherited from class java.lang.Object

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

Constructor Details

HpSet

public HpSet(String name,
 List<Hyperparameter<?>> hyperParams)

Cosntructs a new HpSet.

Parameters:

name - the name of the hyperparameter set

hyperParams - the included hyperparameters in the set

HpSet

public HpSet(String name)

Cosntructs a new empty HpSet.

Parameters:

name - the name of the hyperparameter set

Method Details

add

public void add(Hyperparameter<?> hparam)

Adds a hyperparameter to the set.

Parameters:

hparam - the hyperparameter to add

getHParam

public Hyperparameter<?> getHParam(String name)

Returns the hyperparameter in the set with the given name.

Parameters:

name - the name of the hyperparameter to return

Returns:

the hyperparameter

random

public HpSet random()

Returns a random value for the hyperparameter for a range of a fixed value if it is a HpVal.

Specified by:

random in class Hyperparameter<HpSet>

Returns:

a random value for the hyperparameter for a range of a fixed value if it is a HpVal

toString

public String toString()

Overrides:

toString in class Object