gemseo.algos.opt.base_gradient_based_algorithm_settings module#

Settings for gradient-based optimization algorithms.

Settings BaseGradientBasedAlgorithmSettings(*, kkt_tol_abs=inf, kkt_tol_rel=inf)[source]#

Bases: BaseModel

The settings for gradient-based optimization algorithms.

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:
  • kkt_tol_abs (Annotated[float, Ge(ge=0)]) --

    By default it is set to inf.

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

    By default it is set to inf.

Return type:

None

kkt_tol_abs: NonNegativeFloat = inf#

The absolute tolerance on the KKT residual norm.

If inf this criterion is not activated.

Constraints:
  • ge = 0

kkt_tol_rel: NonNegativeFloat = inf#

The relative tolerance on the KKT residual norm.

If inf this criterion is not activated.

Constraints:
  • ge = 0