distributions

Classes

BaseDistribution()

Base distribution.

CategoricalDistribution(choices)

Categorical distribution.

FloatDistribution(low, high[, step, log])

Float-based distribution.

IntDistribution(low, high[, step, log])

Integer-based distribution.

class BaseDistribution[source]

Base distribution.

Return type

None

class CategoricalDistribution(choices: Sequence[Union[None, bool, int, float, str]])[source]

Categorical distribution.

The input parameters aren’t validated.

Look at suggest_categorical() to find more about the meaning of parameters.

Parameters

choices (Sequence[Union[None, bool, int, float, str]]) –

Return type

None

choices

Possible values to take.

Type

Sequence[Union[None, bool, int, float, str]]

class FloatDistribution(low: float, high: float, step: Optional[float] = None, log: bool = False)[source]

Float-based distribution.

Look at suggest_float() to find more about the meaning of parameters.

Parameters
  • low (float) –

  • high (float) –

  • step (Optional[float]) –

  • log (bool) –

Return type

None

low

The lower bound.

Type

float

high

The upper bound.

Type

float

step

The space between possible values.

Type

Optional[float]

log

The flag of using log domain.

Type

bool

class IntDistribution(low: int, high: int, step: int = 1, log: bool = False)[source]

Integer-based distribution.

The input parameters aren’t validated.

Look at suggest_int() to find more about the meaning of parameters.

Parameters
  • low (int) –

  • high (int) –

  • step (int) –

  • log (bool) –

Return type

None

low

The lower bound.

Type

int

high

The upper bound.

Type

int

step

The space between possible values.

Type

int

log

The flag of using log domain.

Type

bool