species

Specifies a variable of a problem task.

class Species(name: str, distribution: Distribution[float], contained_in_output: bool = True, min_value: Optional[float] = None, max_value: Optional[float] = None)

Bases: object

Specifies a variable of a problem task.

name

The name of the variable.

distribution

A condition determining the value of the parameter at the start.

contained_in_output

Whether or not this object should be included in the final output data.

min_value

Minimal allowed value for this species. If None, the species is considered to have not minimal value.

max_value

Maximal allowed value for this species. If None, the species is considered to have not maximal value.

Inits Species with the provided params.

Parameters:

• name – The name of the variable.

• distribution – A condition determining the value of the parameter at the start.

• contained_in_output – Whether this object should be included in the final output data.

• min_value – Minimal allowed value for this species. If None, the species is considered to have not minimal value.

• max_value – Maximal allowed value for this species. If None, the species is considered to have not maximal value.

Raises:

ValueError – If min_value is greater than max_value.

get_initial_values_from_hypercube_sampling(n: int) → List[float]

Creates a config for hypercube sampling.

Parameters:

n – Number of samples to create.

Returns:

A list of samples.