automation.parameters.ParameterSet

class trains.automation.parameters.ParameterSet

Discrete randomly sampled Hyper-Parameter object.

Uniformly sample values form a list of discrete options (combinations) of parameters.

Parameters

parameter_combinations (list) –

The list/tuple of valid parameter combinations.

For example, two combinations with three specific parameters per combination:

[ {'opt1': 10, 'arg2': 20, 'arg2': 30},
   {'opt2': 11, 'arg2': 22, 'arg2': 33}, ]
 

Two complex combination each one sampled from a different range:

[ {'opt1': UniformParameterRange('arg1',0,1) , 'arg2': 20},
   {'opt2': UniformParameterRange('arg1',11,12), 'arg2': 22},]
 

classmethod from_dict(a_dict)

Construct Parameter object from a dict representation (deserialize from dict).

Returns

The Parameter object.

static get_random_seed()

Get the global seed for all hyper-parameter strategy random number sampling.

Returns

The random seed.

get_value()

Return uniformly sampled value from the valid list of values.

Returns

{self.name: random entry from self.value}

static set_random_seed(seed=1337)

Set global seed for all hyper-parameter strategy random number sampling.

Parameters

seed (int) – The random seed.

to_dict()

Return a dict representation of the Parameter object. Used for serialization of the Parameter object.

Returns

dict representation of the object (serialization).

to_list()

Return a list of all the valid values of the Parameter.

Returns

list of dicts {name: value}