gemseo.algos.doe.oat_doe.settings.oat_doe_settings module

Settings of the OAT DOE.

Settings OATDOE_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_jac=False, n_processes=1, wait_time_between_samples=0.0, callbacks=(), initial_point, step=0.05)

Bases: BaseDOESettings

The settings of the OAT DOE.

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)]) --

  By default it is set to 0.01.

• ineq_tolerance (Annotated[float, 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)]) --

  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_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 ().

• initial_point (_NDArrayPydantic[Any, dtype[_ScalarType_co]])

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

  By default it is set to 0.05.

Return type:

None

initial_point: NDArrayPydantic [Required]

The initial point of the OAT DOE.

step: PositiveFloat = 0.05

The relative step of the OAT DOE.

The step in the x direction is step*(max_x-min_x)`` if x+step*(max_x-min_x)<=max_x and -step*(max_x- min_x) otherwise.

Constraints:

• gt = 0

model_post_init(context, /)

We need to both initialize private attributes and call the user-defined model_post_init method.

Parameters:

• self (BaseModel)

• context (Any)

Return type:

None