Skip to main content

DiscreteParameterRange

class automation.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.


DiscreteParameterRange.from_dict#

classmethod from_dict(a_dict)

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

  • Return type

    Parameter

  • Returns

    The Parameter object.

  • Parameters

    a_dict (Mapping [ str , str ] ) โ€“


get_random_seed#

static get_random_seed()

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

  • Return type

    int

  • Returns

    The random seed.


get_value#

get_value()

Return uniformly sampled value from the valid list of values.

  • Return type

    Mapping[str, Any]

  • Returns

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


set_random_seed#

static set_random_seed(seed=1337)

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

  • Parameters

    seed (int ) โ€“ The random seed.

  • Return type

    ()


to_dict#

to_dict()

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

  • Return type

    Mapping[str, Union[str, Parameter]]

  • Returns

    dict representation of the object (serialization).


to_list#

to_list()

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

  • Return type

    Sequence[Mapping[str, Any]]

  • Returns

    list of dicts {name: value}