Post-processing

In this example, we will discover the different functions of the API related to graphical post-processing of scenarios.

from gemseo.api import configure_logger
from gemseo.api import create_discipline
from gemseo.api import create_scenario
from gemseo.api import execute_post
from gemseo.api import get_available_post_processings
from gemseo.api import get_post_processing_options_schema
from gemseo.problems.sellar.sellar_design_space import SellarDesignSpace
from matplotlib import pyplot as plt

configure_logger()

Out:

<RootLogger root (INFO)>

Get available DOE algorithms

The get_available_post_processings() function returns the list of post-processing algorithms available in GEMSEO or in external modules

print(get_available_post_processings())

Out:

['BasicHistory', 'Compromise', 'ConstraintsHistory', 'Correlations', 'GradientSensitivity', 'HighTradeOff', 'KMeans', 'MultiObjectiveDiagram', 'ObjConstrHist', 'OptHistoryView', 'ParallelCoordinates', 'ParetoFront', 'Petal', 'QuadApprox', 'Radar', 'RadarChart', 'Robustness', 'SOM', 'ScatterPareto', 'ScatterPlotMatrix', 'VariableInfluence']

Get options schema

For a given post-processing algorithm, e.g. "RadarChart", we can get the options; e.g.

print(get_post_processing_options_schema("RadarChart"))

Out:

{'$schema': 'http://json-schema.org/draft-04/schema', 'additionalProperties': False, 'type': 'object', 'properties': {'save': {'description': 'If True, save the figure.', 'type': 'boolean'}, 'show': {'description': 'If True, display the figure.', 'type': 'boolean'}, 'file_path': {'anyOf': [{'description': 'The path of the file to save the figures. If the extension is missing, use ``file_extension``. If None, create a file path from ``directory_path``, ``file_name`` and ``file_extension``.', 'type': 'string'}, {'description': 'The path of the file to save the figures. If the extension is missing, use ``file_extension``. If None, create a file path from ``directory_path``, ``file_name`` and ``file_extension``.', 'type': 'null'}]}, 'file_extension': {'anyOf': [{'description': "A file extension, e.g. 'png', 'pdf', 'svg', ... If None, use a default file extension.", 'type': 'string'}, {'description': "A file extension, e.g. 'png', 'pdf', 'svg', ... If None, use a default file extension.", 'type': 'null'}]}, 'file_name': {'anyOf': [{'description': 'The name of the file to save the figures. If None, use a default one generated by the post-processing.', 'type': 'string'}, {'description': 'The name of the file to save the figures. If None, use a default one generated by the post-processing.', 'type': 'null'}]}, 'directory_path': {'anyOf': [{'description': 'The path of the directory to save the figures. If None, use the current working directory.', 'type': 'string'}, {'description': 'The path of the directory to save the figures. If None, use the current working directory.', 'type': 'null'}]}, 'fig_size': {'anyOf': [{'type': 'null'}, {'minItems': 2, 'maxItems': 2, 'type': 'array', 'items': {'type': 'number'}}]}, 'iteration': {'anyOf': [{'type': 'integer'}, {'enum': ['opt'], 'type': 'string'}]}, 'constraint_names': {'anyOf': [{'type': 'null'}, {'type': 'array', 'items': {'minItems': 1, 'type': 'string'}}]}, 'show_names_radially': {'description': '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.', 'type': 'boolean'}}, 'required': []}

Post-process a scenario

The API function execute_post() can generate visualizations of the optimization or DOE results. For that, it consider the object to post-process to_post_proc, the post processing post_name with its **options. E.g.

disciplines = create_discipline(["Sellar1", "Sellar2", "SellarSystem"])
design_space = SellarDesignSpace()
scenario = create_scenario(
    disciplines, "MDF", "obj", design_space, "SellarMDFScenario", "MDO"
)
scenario.execute({"algo": "NLOPT_SLSQP", "max_iter": 100})
execute_post(scenario, "OptHistoryView", show=False, save=False)
# Workaround for HTML rendering, instead of ``show=True``
plt.show()
  • Evolution of the optimization variables
  • Evolution of the objective value
  • Distance to the optimum
  • Hessian diagonal approximation

Out:

/home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/stable/lib/python3.9/site-packages/gemseo/algos/design_space.py:448: ComplexWarning: Casting complex values to real discards the imaginary part
  self.__current_value[name] = array_value.astype(
    INFO - 10:09:00:
    INFO - 10:09:00: *** Start SellarMDFScenario execution ***
    INFO - 10:09:00: SellarMDFScenario
    INFO - 10:09:00:    Disciplines: Sellar1 Sellar2 SellarSystem
    INFO - 10:09:00:    MDO formulation: MDF
    INFO - 10:09:00: Optimization problem:
    INFO - 10:09:00:    minimize obj(x_local, x_shared)
    INFO - 10:09:00:    with respect to x_local, x_shared
    INFO - 10:09:00:    over the design space:
    INFO - 10:09:00:    +----------+-------------+-------+-------------+-------+
    INFO - 10:09:00:    | name     | lower_bound | value | upper_bound | type  |
    INFO - 10:09:00:    +----------+-------------+-------+-------------+-------+
    INFO - 10:09:00:    | x_local  |      0      |   1   |      10     | float |
    INFO - 10:09:00:    | x_shared |     -10     |   4   |      10     | float |
    INFO - 10:09:00:    | x_shared |      0      |   3   |      10     | float |
    INFO - 10:09:00:    +----------+-------------+-------+-------------+-------+
    INFO - 10:09:00: Solving optimization problem with algorithm NLOPT_SLSQP:
    INFO - 10:09:00: ...   0%|          | 0/100 [00:00<?, ?it]
 WARNING - 10:09:00: MDAJacobi has reached its maximum number of iterations but the normed residual 0.0217151501538871 is still above the tolerance 1e-06.
    INFO - 10:09:00: ...   4%|▍         | 4/100 [00:00<00:00, 846.25 it/sec, obj=4.79+j]
    INFO - 10:09:00: ...   9%|▉         | 9/100 [00:00<00:00, 446.16 it/sec, obj=0.571+j]
    INFO - 10:09:01: ...  15%|█▌        | 15/100 [00:00<00:00, 303.18 it/sec, obj=0.527+j]
    INFO - 10:09:01: ...  20%|██        | 20/100 [00:00<00:00, 261.42 it/sec, obj=0.527+j]
    INFO - 10:09:01: Optimization result:
    INFO - 10:09:01:    Optimizer info:
    INFO - 10:09:01:       Status: None
    INFO - 10:09:01:       Message: Successive iterates of the design variables are closer than xtol_rel or xtol_abs. GEMSEO Stopped the driver
    INFO - 10:09:01:       Number of calls to the objective function by the optimizer: 24
    INFO - 10:09:01:    Solution:
    INFO - 10:09:01:       Objective: (0.5272881447376523+0j)
    INFO - 10:09:01:       Design space:
    INFO - 10:09:01:       +----------+-------------+-----------------------+-------------+-------+
    INFO - 10:09:01:       | name     | lower_bound |         value         | upper_bound | type  |
    INFO - 10:09:01:       +----------+-------------+-----------------------+-------------+-------+
    INFO - 10:09:01:       | x_local  |      0      | 3.544728527328585e-13 |      10     | float |
    INFO - 10:09:01:       | x_shared |     -10     |   0.5816393541920579  |      10     | float |
    INFO - 10:09:01:       | x_shared |      0      |           0           |      10     | float |
    INFO - 10:09:01:       +----------+-------------+-----------------------+-------------+-------+
    INFO - 10:09:01: *** End SellarMDFScenario execution (time: 0:00:00.392973) ***

Total running time of the script: ( 0 minutes 1.259 seconds)

Gallery generated by Sphinx-Gallery