gemseo.algos.doe.pydoe.settings.pydoe_lhs module#

Settings for the LHS DOE from the pyDOE library.

class Criterion(*values)[source]#

Bases: StrEnum

The criteria for the LHS.

c = 'c'#
center = 'center'#
centermaximin = 'centermaximin'#
cm = 'cm'#
corr = 'corr'#
correlation = 'correlation'#
lhsmu = 'lhsmu'#
m = 'm'#
maximin = 'maximin'#
Settings PYDOE_LHS_Settings(*, enable_progress_bar=None, eq_tolerance=0.01, ineq_tolerance=0.0001, log_problem=True, max_time=0.0, normalize_design_space=False, reset_iteration_counters=True, round_ints=True, use_database=True, use_one_line_progress_bar=False, store_jacobian=True, eval_func=True, eval_jac=False, n_processes=1, wait_time_between_samples=0.0, callbacks=(), criterion=None, iterations=5, n_samples, random_state=None)[source]#

Bases: BasePyDOESettings

The settings for the LHS DOE from the pyDOE library.

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:

  • enable_progress_bar (bool | None)

  • eq_tolerance (Annotated[float, Ge(ge=0), Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 0.01.

  • ineq_tolerance (Annotated[float, Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 0.0001.

  • log_problem (bool) --

    By default it is set to True.

  • max_time (Annotated[float, Ge(ge=0), Ge(ge=0)]) --

    By default it is set to 0.0.

  • normalize_design_space (bool) --

    By default it is set to False.

  • reset_iteration_counters (bool) --

    By default it is set to True.

  • round_ints (bool) --

    By default it is set to True.

  • use_database (bool) --

    By default it is set to True.

  • use_one_line_progress_bar (bool) --

    By default it is set to False.

  • store_jacobian (bool) --

    By default it is set to True.

  • eval_func (bool) --

    By default it is set to True.

  • eval_jac (bool) --

    By default it is set to False.

  • n_processes (Annotated[int, Gt(gt=0)]) --

    By default it is set to 1.

  • wait_time_between_samples (Annotated[float, Ge(ge=0)]) --

    By default it is set to 0.0.

  • callbacks (Sequence[Annotated[Callable[[int, tuple[dict[str, float | ndarray[Any, dtype[floating[Any]]]], dict[str, ndarray[Any, dtype[floating[Any]]]]]], Any], WithJsonSchema(json_schema={}, mode=None)]]) --

    By default it is set to ().

  • criterion (Criterion | None)

  • iterations (Annotated[int, Gt(gt=0)]) --

    By default it is set to 5.

  • n_samples (Annotated[int, Gt(gt=0)])

  • random_state (Annotated[int, Gt(gt=0)] | None)

Return type:

None

criterion: Criterion | None = None#

The criterion to use when sampling the points.

If None, randomize the points within the intervals.

iterations: PositiveInt = 5#

The number of iterations in the correlation/maximin algorithms.

Constraints:

  • gt = 0

n_samples: PositiveInt [Required]#

The number of samples.

Constraints:

  • gt = 0

random_state: PositiveInt | None = None#

The seed used for reproducibility reasons.

If None, use seed.

model_post_init(context, /)#

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that's what pydantic-core passes when calling it.

Parameters:

  • self (BaseModel) -- The BaseModel instance.

  • context (Any) -- The context.

Return type:

None