lib_surrogate_based module¶

A library for surrogate-based optimization.

class gemseo_mlearning.algos.opt.lib_surrogate_based.SurrogateBasedAlgorithmDescription(algorithm_name, internal_algorithm_name, library_name='gemseo-mlearning', description='', website='', handle_integer_variables=False, require_gradient=False, handle_equality_constraints=False, handle_inequality_constraints=False, handle_multiobjective=False, positive_constraints=False, problem_type=ProblemType.NON_LINEAR)[source]

Bases: OptimizationAlgorithmDescription

The description of a surrogate-based optimization algorithm.

Parameters:

algorithm_name (str) –
internal_algorithm_name (str) –
library_name (str) –

By default it is set to “gemseo-mlearning”.
description (str) –

By default it is set to “”.
website (str) –

By default it is set to “”.
handle_integer_variables (bool) –

By default it is set to False.
require_gradient (bool) –

By default it is set to False.
handle_equality_constraints (bool) –

By default it is set to False.
handle_inequality_constraints (bool) –

By default it is set to False.
handle_multiobjective (bool) –

By default it is set to False.
positive_constraints (bool) –

By default it is set to False.
problem_type (OptimizationProblem.ProblemType) –

By default it is set to “non-linear”.

algorithm_name: str: The name of the algorithm in GEMSEO.

internal_algorithm_name: str: The name of the algorithm in the wrapped library.

library_name: str = 'gemseo-mlearning': The name of the wrapped library.

class gemseo_mlearning.algos.opt.lib_surrogate_based.SurrogateBasedOptimization[source]

Bases: OptimizationLibrary

A wrapper for surrogate-based optimization.

Note

The missing current values of the DesignSpace attached to the OptimizationProblem are automatically initialized with the method DesignSpace.initialize_missing_current_values().

LIBRARY_NAME: ClassVar[str | None] = 'gemseo-mlearning': The name of the interfaced library.

algo_name: str | None: The name of the algorithm used currently.

descriptions: dict[str, AlgorithmDescription]: The description of the algorithms contained in the library.

internal_algo_name: str | None

The internal name of the algorithm used currently.

It typically corresponds to the name of the algorithm in the wrapped library if any.

opt_grammar: JSONGrammar | None: The grammar defining the options of the current algorithm.

problem: Any | None: The problem to be solved.