gemseo.uncertainty.distributions.base_settings.beta_settings module#

Base settings for defining a Beta distribution.

Settings BaseBetaDistribution_Settings(*, alpha=2.0, beta=2.0, minimum=0.0, maximum=1.0)[source]#

Bases: BaseDistribution_Settings

The base settings of a Beta distribution.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

  • alpha (Annotated[float, Gt(gt=0)]) --

    By default it is set to 2.0.

  • beta (Annotated[float, Gt(gt=0)]) --

    By default it is set to 2.0.

  • minimum (float) --

    By default it is set to 0.0.

  • maximum (float) --

    By default it is set to 1.0.

Return type:

None

alpha: PositiveFloat = 2.0#

The first shape parameter of the beta random variable.

Constraints:

  • gt = 0

beta: PositiveFloat = 2.0#

The second shape parameter of the beta random variable.

Constraints:

  • gt = 0

maximum: float = 1.0#

The maximum of the beta random variable.

minimum: float = 0.0#

The second shape parameter of the beta random variable.