automation.parameters.DiscreteParameterRange

class trains.automation.parameters.DiscreteParameterRange

Discrete randomly sampled hyper-parameter object.

Uniformly sample values form a list of discrete options.

Parameters
  • name (str) – The parameter name. Match the task hyper-parameter name.

  • values (list) – The list/tuple of valid parameter values to sample from.

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}