Post-processing algorithms#

Warning

Some capabilities may require the installation of GEMSEO with all its features and some others may depend on plugins.

Warning

All the features of the wrapped libraries may not be exposed through GEMSEO.

Note

The algorithm settings can be passed to a function of the form

function(..., settings_model: AlgorithmSettings | None = None, **settings: Any)

either one by one:

function(..., setting_name_1=setting_name_1, setting_name_2=setting_name_2, ...)

or using the argument name "settings_model" and the Pydantic model associated with the algorithm:

settings_model = AlgorithmSettings(setting_name_1=setting_name_1, setting_name_2=setting_name_2, ...)
function(..., settings_model=settings_model)

Animation#

Module: gemseo.post.animation

Pydantic model of the settings for Animation#

from gemseo.settings.post import Animation_Settings

Required settings

post_processing : gemseo.post.base_post.BasePost[typing.Any]

The post processing object.
post_processing_settings : <class 'gemseo.post.base_post_settings.BasePostSettings'>

The settings for the post processing object.

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 11.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
first_iteration : <class 'int'>, optional

The iteration to begin the animation.

By default it is set to -1.
frame_rate : <class 'int'>, optional

The number of iterations per time step.

By default it is set to 1.
gif_file_path : str | pathlib.Path, optional

The path to the GIF file.

By default it is set to animated_gif.
n_repetitions : <class 'int'>, optional

The number of times the animation is played. If 0, play infinitely.

By default it is set to 0.
remove_frames : <class 'bool'>, optional

Whether to remove the frame images after the GIF generation.

By default it is set to True.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
temporary_database_path : str | pathlib.Path

The path to a temporary database to avoid deepcopy memory errors.If empty, deepcopy is used instead.

By default it is set to .
time_step : <class 'float'>, optional

The time step between two frames in milliseconds.

By default it is set to 100.

BasicHistory#

Module: gemseo.post.basic_history

Pydantic model of the settings for BasicHistory#

from gemseo.settings.post import BasicHistory_Settings

Required settings

variable_names : collections.abc.Sequence[str]

The names of the variables.

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 6.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
normalize : <class 'bool'>, optional

Whether to normalize the data.

By default it is set to False.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

Compromise#

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.compromise

Optional settings

beta : <class 'float'>, optional

By default it is set to 0.0.
decomposition : typing.Any | None, optional

The instance of the scalarization function to use. If None, use a weighted sum.

By default it is set to None.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 11.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
normalize_each_objective : <class 'bool'>, optional

Whether the objectives should be normalized.

By default it is set to True.
plot_arrow : <class 'bool'>, optional

Whether to plot arrows connecting the utopia point to the compromise points. The arrows are annotated with the 2-norm (Euclidian distance) of the vector represented by the arrow.

By default it is set to False.
plot_extra : <class 'bool'>, optional

Whether to plot the extra pareto related points,i.e. utopia, nadir and anchor points.

By default it is set to True.
plot_legend : <class 'bool'>, optional

Whether to show the legend.

By default it is set to True.
rho : <class 'float'>, optional

By default it is set to 0.0.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
theta : <class 'float'>, optional

By default it is set to 0.0.
weights : gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]] | gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]]]] | None, optional

The weights for the scalarization function. If None, a normalized array is used, e.g. [1./n, 1./n, ..., 1./n] for an optimization problem with n-objectives.

By default it is set to None.

ConstraintsHistory#

Module: gemseo.post.constraints_history

Pydantic model of the settings for ConstraintsHistory#

from gemseo.settings.post import ConstraintsHistory_Settings

Required settings

constraint_names : collections.abc.Sequence[str]

The names of the constraints.

Optional settings

add_points : <class 'bool'>, optional

Whether to add one point per iteration on the line.

By default it is set to True.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 11.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
line_style : <class 'str'>, optional

The style of the line, e.g. "-" or "--". ""If "", do not plot the line.

By default it is set to --.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

Correlations#

Module: gemseo.post.correlations

Pydantic model of the settings for Correlations#

from gemseo.settings.post import Correlations_Settings

Optional settings

coeff_limit : <class 'float'>, optional

The minimum correlation coefficient below which the variable is not plotted.

By default it is set to 0.95.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (15.0, 10.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
func_names : collections.abc.Sequence[str], optional

The names of the functions to be considered. If empty, all the functions are considered.

By default it is set to ().
n_plots_x : <class 'int'>, optional

The number of horizontal plots.

By default it is set to 5.
n_plots_y : <class 'int'>, optional

The number of vertical plots.

By default it is set to 5.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

DataVersusModel#

Note

The plugin gemseo_calibration is required.

Module: gemseo_calibration.post.data_versus_model.post

Required settings

output : <class 'str'>

The names of the output of interest.

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (6.4, 4.8).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

GradientSensitivity#

Module: gemseo.post.gradient_sensitivity

Pydantic model of the settings for GradientSensitivity#

from gemseo.settings.post import GradientSensitivity_Settings

Optional settings

compute_missing_gradients : <class 'bool'>, optional

Whether to compute the gradients at the selected iteration if they were not computed by the algorithm.nn.. warning::nActivating this option may add considerable computation time depending on the cost of the gradient evaluation. This option will not compute the gradients if the OptimizationProblem instance was imported from an HDF5 file. This option requires an OptimizationProblem with a gradient-based algorithm.

By default it is set to False.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10.0, 10.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
iteration : typing.Union[typing.Annotated[int, Lt(lt=0)], typing.Annotated[int, Gt(gt=0)], NoneType], optional

The iteration to plot the sensitivities. Can use either positive or negative indexing, e.g. 5 for the 5-th iteration or -2 for the penultimate one. If None, use the iteration of the optimum.

By default it is set to None.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
scale_gradients : <class 'bool'>, optional

Whether to normalize each gradient w.r.t. the design variables.

By default it is set to False.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

HessianHistory#

Module: gemseo.post.hessian_history

Pydantic model of the settings for HessianHistory#

from gemseo.settings.post import HessianHistory_Settings

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 6.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
variable_names : collections.abc.Sequence[str], optional

The names of the variables.

By default it is set to ().

HighTradeOff#

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.high_tradeoff

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
epsilon : <class 'float'>, optional

By default it is set to 0.0.
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 11.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
plot_arrow : <class 'bool'>, optional

Whether to plot arrows connecting the utopia point to the compromise points. The arrows are annotated with the 2-norm (Euclidian distance) of the vector represented by the arrow.

By default it is set to False.
plot_extra : <class 'bool'>, optional

Whether to plot the extra pareto related points,i.e. utopia, nadir and anchor points.

By default it is set to True.
plot_legend : <class 'bool'>, optional

Whether to show the legend.

By default it is set to True.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

MultiObjectiveDiagram#

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.core.multi_objective_diagram

Optional settings

beta : <class 'float'>, optional

By default it is set to 0.0.
decomposition : typing.Any | None, optional

The instance of the scalarization function to use. If None, use a weighted sum.

By default it is set to None.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10, 6).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
normalize_each_objective : <class 'bool'>, optional

Whether the objectives should be normalized.

By default it is set to True.
rho : <class 'float'>, optional

By default it is set to 0.0.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
theta : <class 'float'>, optional

By default it is set to 0.0.
weights : gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]] | gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]]]] | None, optional

The weights for the scalarization function. If None, a normalized array is used, e.g. [1./n, 1./n, ..., 1./n] for an optimization problem with n-objectives.

By default it is set to None.

ObjConstrHist#

Module: gemseo.post.obj_constr_hist

Pydantic model of the settings for ObjConstrHist#

from gemseo.settings.post import ObjConstrHist_Settings

Optional settings

constraint_names : collections.abc.Sequence[str], optional

The names of the constraints to plot. If empty, use all the constraints.

By default it is set to ().
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 6.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

OptHistoryView#

Module: gemseo.post.opt_history_view

Pydantic model of the settings for OptHistoryView#

from gemseo.settings.post import OptHistoryView_Settings

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 6.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
obj_max : float | None, optional

The upper limit of the y-axis on which the objective is plotted. This limit must be greater than or equal to the maximum value of the objective history. If None, use the maximum value of the objective history.

By default it is set to None.
obj_min : float | None, optional

The lower limit of the y-axis on which the objective is plotted. This limit must be less than or equal to the minimum value of the objective history. If None, use the minimum value of the objective history.

By default it is set to None.
obj_relative : <class 'bool'>, optional

Whether the difference between the objective and its initial value is plotted instead of the objective.

By default it is set to False.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
variable_names : collections.abc.Sequence[str], optional

The names of the variables to display. If empty, use all design variables.

By default it is set to ().

ParallelCoordinates#

Module: gemseo.post.parallel_coordinates

Pydantic model of the settings for ParallelCoordinates#

from gemseo.settings.post import ParallelCoordinates_Settings

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10.0, 5.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

ParetoFront#

Module: gemseo.post.pareto_front

Pydantic model of the settings for ParetoFront#

from gemseo.settings.post import ParetoFront_Settings

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10.0, 10.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
objectives : collections.abc.Sequence[str], optional

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

By default it is set to ().
objectives_labels : collections.abc.Sequence[str], optional

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

By default it is set to ().
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
show_non_feasible : <class 'bool'>, optional

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

By default it is set to True.

Petal#

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.petal

Optional settings

beta : <class 'float'>, optional

By default it is set to 0.0.
decomposition : typing.Any | None, optional

The instance of the scalarization function to use. If None, use a weighted sum.

By default it is set to None.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10, 6).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
normalize_each_objective : <class 'bool'>, optional

Whether the objectives should be normalized.

By default it is set to True.
rho : <class 'float'>, optional

By default it is set to 0.0.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
theta : <class 'float'>, optional

By default it is set to 0.0.
weights : gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]] | gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]]]] | None, optional

The weights for the scalarization function. If None, a normalized array is used, e.g. [1./n, 1./n, ..., 1./n] for an optimization problem with n-objectives.

By default it is set to None.

QuadApprox#

Module: gemseo.post.quad_approx

Pydantic model of the settings for QuadApprox#

from gemseo.settings.post import QuadApprox_Settings

Required settings

function : <class 'str'>

The function name to build the quadratic approximation.

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (9.0, 6.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
func_index : typing.Optional[typing.Annotated[int, Ge(ge=0)]], optional

The index of the output of interest to be defined if the function has a multidimensional output. If None and if the output is multidimensional, an error is raised.

By default it is set to None.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

Radar#

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.radar

Optional settings

beta : <class 'float'>, optional

By default it is set to 0.0.
decomposition : typing.Any | None, optional

The instance of the scalarization function to use. If None, use a weighted sum.

By default it is set to None.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10, 6).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
normalize_each_objective : <class 'bool'>, optional

Whether the objectives should be normalized.

By default it is set to True.
rho : <class 'float'>, optional

By default it is set to 0.0.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
theta : <class 'float'>, optional

By default it is set to 0.0.
weights : gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]] | gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[+_ScalarType_co]]]] | None, optional

The weights for the scalarization function. If None, a normalized array is used, e.g. [1./n, 1./n, ..., 1./n] for an optimization problem with n-objectives.

By default it is set to None.

RadarChart#

Module: gemseo.post.radar_chart

Pydantic model of the settings for RadarChart#

from gemseo.settings.post import RadarChart_Settings

Optional settings

constraint_names : collections.abc.Sequence[str], optional

The names of the constraints. If empty, use all the constraints.

By default it is set to ().
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (6.4, 4.8).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
iteration : int | None, optional

Either an iteration in \(\{-N,\ldots,-1,1,\ldots,N\}\) or None for the iteration at which the optimum is located, where \(N\) is the length of the database.

By default it is set to None.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
show_names_radially : <class 'bool'>, optional

Whether to write the names of the constraints in the radial direction. Otherwise, write them horizontally. The radial direction can be useful for a high number of constraints.

By default it is set to False.

Robustness#

Module: gemseo.post.robustness

Pydantic model of the settings for Robustness#

from gemseo.settings.post import Robustness_Settings

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (8.0, 5.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
stddev : <class 'float'>, optional

The standard deviation of the normal uncertain variable to be added to the optimal design value; expressed as a fraction of the bounds of the design variables.

By default it is set to 0.01.

SOM#

Module: gemseo.post.som

Pydantic model of the settings for SOM#

from gemseo.settings.post import SOM_Settings

Optional settings

annotate : <class 'bool'>, optional

Whether to show the label of the neuron value.

By default it is set to False.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (12.0, 18.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
n_x : <class 'int'>, optional

The number of grids in x.

By default it is set to 4.
n_y : <class 'int'>, optional

The number of grids in y.

By default it is set to 4.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

ScatterPareto#

Note

The plugin gemseo_pymoo is required.

Module: gemseo_pymoo.post.scatter_pareto

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 11.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
plot_arrow : <class 'bool'>, optional

Whether to plot arrows connecting the utopia point to the compromise points. The arrows are annotated with the 2-norm (Euclidian distance) of the vector represented by the arrow.

By default it is set to False.
plot_extra : <class 'bool'>, optional

Whether to plot the extra pareto related points,i.e. utopia, nadir and anchor points.

By default it is set to True.
plot_legend : <class 'bool'>, optional

Whether to show the legend.

By default it is set to True.
points : gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[float]] | gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[gemseo.utils.pydantic_ndarray._NDArrayPydantic[typing.Any, numpy.dtype[float]]]], optional

The points of interest to be plotted. If None, only the pareto front is plot along with extra point (depending on plot_extra value).

By default it is set to [].
points_labels : collections.abc.Sequence[str], optional

The label of the points of interest. If a list is provided, it must contain as many labels as the points of interest. Moreover, in the last case, each point will have a different color.

By default it is set to points.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

ScatterPlotMatrix#

Module: gemseo.post.scatter_plot_matrix

Pydantic model of the settings for ScatterPlotMatrix#

from gemseo.settings.post import ScatterPlotMatrix_Settings

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (10.0, 10.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
filter_non_feasible : <class 'bool'>, optional

Whether to remove the non-feasible points from the data.

By default it is set to False.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.
variable_names : collections.abc.Sequence[str], optional

The functions names or design variables to plot. If empty, plot all design variables.

By default it is set to ().

TopologyView#

Module: gemseo.post.topology_view

Pydantic model of the settings for TopologyView#

from gemseo.settings.post import TopologyView_Settings

Required settings

n_x : <class 'int'>

The number of elements in the horizontal direction.
n_y : <class 'int'>

The number of elements in the vertical direction.

Optional settings

directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (6.4, 4.8).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
iterations : int | collections.abc.Sequence[int], optional

The iterations of the optimization history. If empty, the last iteration is taken.

By default it is set to ().
observable : <class 'str'>

The name of the observable to be plotted. It should be of size n_x*n_y.

By default it is set to .
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

VariableInfluence#

Module: gemseo.post.variable_influence

Pydantic model of the settings for VariableInfluence#

from gemseo.settings.post import VariableInfluence_Settings

Optional settings

absolute_value : <class 'bool'>, optional

Whether to plot the absolute value of the influence.

By default it is set to False.
directory_path : pathlib.Path | str

The path of the directory to save the figures. If empty, use the current working directory.

By default it is set to .
fig_size : tuple[typing.Annotated[float, Gt(gt=0)], typing.Annotated[float, Gt(gt=0)]], optional

The width and height of the figure in inches, e.g. (w, h).

By default it is set to (11.0, 11.0).
file_extension : <class 'str'>

A file extension, e.g. 'png', 'pdf', 'svg', ... If empty, use a default file extension.

By default it is set to .
file_name : <class 'str'>

The name of the file to save the figures. If empty, use a default one generated by the post-processing.

By default it is set to .
file_path : pathlib.Path | str

The path of the file to save the figures. If the extension is missing, use file_extension. If empty, create a file path from directory_path, file_name and file_extension.

By default it is set to .
level : <class 'float'>, optional

The proportion of the total sensitivity to use as a threshold to filter the variables.

By default it is set to 0.99.
log_scale : <class 'bool'>, optional

Whether to set the y-axis as log scale.

By default it is set to False.
save : <class 'bool'>, optional

Whether to save the figure.

By default it is set to True.
save_var_files : <class 'bool'>, optional

Whether to save the influential variables indices to a NumPy file.

By default it is set to False.
show : <class 'bool'>, optional

Whether to display the figure.

By default it is set to False.

Post-processing algorithms#

Animation#

BasicHistory#

Compromise#

ConstraintsHistory#

Correlations#

DataVersusModel#

GradientSensitivity#

HessianHistory#

HighTradeOff#

MultiObjectiveDiagram#

ObjConstrHist#

OptHistoryView#

ParallelCoordinates#

ParetoFront#

Petal#

QuadApprox#

Radar#

RadarChart#

Robustness#

SOM#

ScatterPareto#

ScatterPlotMatrix#

TopologyView#

VariableInfluence#

This Page