gemseo / algos / opt / core

trust_updater module

Updates a trust parameter according to a decreases’ ratio.

class gemseo.algos.opt.core.trust_updater.BoundsUpdater(lower_bounds, upper_bounds, normalize=False)[source]

Bases: object

Updater of the trust bounds, i.e. trust ball w.r.t.

the infinity norm.

Parameters

  • lower_bounds (numpy.ndarray) – The reference lower bounds.

  • upper_bounds (numpy.ndarray) – The reference upper bounds.

  • normalize (bool) –

    Whether to apply the radius to the normalized bounds.

    By default it is set to False.

Return type

None

update(radius, center)[source]

Update the trust bounds.

Parameters

  • radius (float) – The region radius w.r.t. the infinity norm.

  • center (numpy.ndarray) – The center of the region

Returns

The updated lower and upper bounds of the trust region.

Return type

tuple[numpy.ndarray, numpy.ndarray]

class gemseo.algos.opt.core.trust_updater.PenaltyUpdater(thresholds=(0.0, 0.25), multipliers=(0.5, 2.0), bound=1e-06)[source]

Bases: gemseo.algos.opt.core.trust_updater.TrustUpdater

Update the penalty parameter.

Parameters

  • thresholds (tuple[float, float]) –

    The thresholds for the decreases’ ratio.

    By default it is set to (0.0, 0.25).

  • multipliers (tuple[float, float]) –

    The multipliers for the trust parameter.

    By default it is set to (0.5, 2.0).

  • bound (float) –

    The absolute bound for the trust parameter.

    By default it is set to 1e-06.

Return type

None

update(ratio, parameter)[source]

Update the trust parameter relative to the decrease ratio value.

Method to be overridden by subclasses.

Parameters

  • ratio (float) – The decrease ratio.

  • parameter (float) – The trust parameter (radius or penalty).

Returns

The new trust parameter, the iteration success.

Return type

tuple[float, bool]

docstring_processor(parent_doc: Optional[str], child_func: Callable) → None: Callable[[Optional[str], Callable], str] = <docstring_inheritance.processors.google.GoogleDocstringProcessor object>
Parameters

  • parent_doc (Optional[str]) –

  • child_func (Callable) –

Return type

None

class gemseo.algos.opt.core.trust_updater.RadiusUpdater(thresholds=(0.0, 0.25), multipliers=(0.5, 2.0), bound=1000.0)[source]

Bases: gemseo.algos.opt.core.trust_updater.TrustUpdater

Update the radius of the trust region.

Parameters

  • thresholds (tuple[float, float]) –

    The thresholds for the decreases’ ratio.

    By default it is set to (0.0, 0.25).

  • multipliers (tuple[float, float]) –

    The multipliers for the trust parameter.

    By default it is set to (0.5, 2.0).

  • bound (float) –

    The absolute bound for the trust parameter.

    By default it is set to 1000.0.

Return type

None

update(ratio, parameter)[source]

Update the trust parameter relative to the decrease ratio value.

Method to be overridden by subclasses.

Parameters

  • ratio (float) – The decrease ratio.

  • parameter (float) – The trust parameter (radius or penalty).

Returns

The new trust parameter, the iteration success.

Return type

tuple[float, bool]

docstring_processor(parent_doc: Optional[str], child_func: Callable) → None: Callable[[Optional[str], Callable], str] = <docstring_inheritance.processors.google.GoogleDocstringProcessor object>
Parameters

  • parent_doc (Optional[str]) –

  • child_func (Callable) –

Return type

None

class gemseo.algos.opt.core.trust_updater.TrustUpdater(thresholds, multipliers, bound=None)[source]

Bases: object

Updater of a trust parameter.

Parameters

  • thresholds (tuple[float, float]) – The thresholds for the decreases’ ratio.

  • multipliers (tuple[float, float]) – The multipliers for the trust parameter.

  • bound –

    The absolute bound for the trust parameter.

    By default it is set to None.

Return type

None

update(ratio, parameter)[source]

Update the trust parameter relative to the decrease ratio value.

Method to be overridden by subclasses.

Parameters

  • ratio (float) – The decrease ratio.

  • parameter (float) – The trust parameter (radius or penalty).

Returns

The new trust parameter, the iteration success.

Return type

tuple[float, bool]

docstring_processor(parent_doc: Optional[str], child_func: Callable) → None: Callable[[Optional[str], Callable], str] = <docstring_inheritance.processors.google.GoogleDocstringProcessor object>
Parameters

  • parent_doc (Optional[str]) –

  • child_func (Callable) –

Return type

None