gemseo.datasets.optimization_metadata module

Optimization metadata to be passed to an optimization dataset.

class OptimizationMetadata(objective_name, standardized_objective_name, minimize_objective, use_standardized_objective, tolerances, output_names_to_constraint_names, feasible_iterations, optimum_iteration)

Bases: object

The optimization metadata to be passed to the OptimizationDataset.

Parameters:

• objective_name (str)

• standardized_objective_name (str)

• minimize_objective (bool)

• use_standardized_objective (bool)

• tolerances (ConstraintTolerances)

• output_names_to_constraint_names (Mapping[str, list[str]])

• feasible_iterations (list[int])

• optimum_iteration (int)

feasible_iterations: list[int]

The iterations of the feasible points.

minimize_objective: bool

Whether to minimize the objective.

objective_name: str

The name of the objective.

optimum_iteration: int

The iteration of the optimum solution, if any.

output_names_to_constraint_names: Mapping[str, list[str]]

The mapping from the output names to the constraint names.

standardized_objective_name: str

The name of the standardized objective.

tolerances: ConstraintTolerances

The equality and inequality constraint tolerances.

use_standardized_objective: bool

Whether to use standardized objective for logging and post-processing.

The standardized objective corresponds to the original one expressed as a cost function to minimize. A BaseDriverLibrary works with this standardized objective and the Database stores its values. However, for convenience, it may be more relevant to log the expression and the values of the original objective.