gemseo.post.pareto_front_settings module#

Settings for post-processing.

Settings ParetoFront_Settings(*, save=True, show=False, file_path='', directory_path='', file_name='', file_extension='', fig_size=(10.0, 10.0), show_non_feasible=True, objectives=(), objectives_labels=())[source]#

Bases: BasePostSettings

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:

  • save (bool) --

    By default it is set to True.

  • show (bool) --

    By default it is set to False.

  • file_path (Path | str) --

    By default it is set to "".

  • directory_path (Path | str) --

    By default it is set to "".

  • file_name (str) --

    By default it is set to "".

  • file_extension (str) --

    By default it is set to "".

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

    By default it is set to (10.0, 10.0).

  • show_non_feasible (bool) --

    By default it is set to True.

  • objectives (Sequence[str]) --

    By default it is set to ().

  • objectives_labels (Sequence[str]) --

    By default it is set to ().

Return type:

None

objectives: Sequence[str] = ()#

The functions names or design variables to plot. If empty, use the objective function (maybe a vector).

objectives_labels: Sequence[str] = ()#

The labels of the objective components. If empty, use the objective name suffixed by an index.

show_non_feasible: bool = True#

Whether to show the non-feasible points in the plot.

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