Note
Go to the end to download the full example code
Create a DOE Scenario¶
from __future__ import annotations
from gemseo import configure_logger
from gemseo import create_design_space
from gemseo import create_discipline
from gemseo import create_scenario
from gemseo import get_available_doe_algorithms
from gemseo import get_available_post_processings
configure_logger()
<RootLogger root (INFO)>
Let \((P)\) be a simple optimization problem:
\[\begin{split}(P) = \left\{
\begin{aligned}
& \underset{x\in\mathbb{N}^2}{\text{minimize}}
& & f(x) = x_1 + x_2 \\
& \text{subject to}
& & -5 \leq x \leq 5
\end{aligned}
\right.\end{split}\]
In this example, we will see how to use GEMSEO to solve this problem \((P)\) by means of a Design Of Experiments (DOE)
Define the discipline¶
Firstly, by means of the create_discipline() API function,
we create an MDODiscipline of AnalyticDiscipline type
from a Python function:
expressions = {"y": "x1+x2"}
discipline = create_discipline("AnalyticDiscipline", expressions=expressions)
Now, we want to minimize this MDODiscipline
over a design of experiments (DOE).
Define the design space¶
For that, by means of the create_design_space() API function,
we define the DesignSpace \([-5, 5]\times[-5, 5]\)
by using its DesignSpace.add_variable() method.
design_space = create_design_space()
design_space.add_variable("x1", l_b=-5, u_b=5, var_type="integer")
design_space.add_variable("x2", l_b=-5, u_b=5, var_type="integer")
Define the DOE scenario¶
Then, by means of the create_scenario() API function,
we define a DOEScenario from the MDODiscipline
and the DesignSpace defined above:
scenario = create_scenario(
discipline, "DisciplinaryOpt", "y", design_space, scenario_type="DOE"
)
Execute the DOE scenario¶
Lastly, we solve the OptimizationProblem included in the
DOEScenario defined above by minimizing the objective function
over a design of experiments included in the DesignSpace.
Precisely, we choose a full factorial design of size \(11^2\):
scenario.execute({"algo": "fullfact", "n_samples": 11**2})
INFO - 08:56:11:
INFO - 08:56:11: *** Start DOEScenario execution ***
INFO - 08:56:11: DOEScenario
INFO - 08:56:11: Disciplines: AnalyticDiscipline
INFO - 08:56:11: MDO formulation: DisciplinaryOpt
INFO - 08:56:11: Optimization problem:
INFO - 08:56:11: minimize y(x1, x2)
INFO - 08:56:11: with respect to x1, x2
INFO - 08:56:11: over the design space:
INFO - 08:56:11: +------+-------------+-------+-------------+---------+
INFO - 08:56:11: | Name | Lower bound | Value | Upper bound | Type |
INFO - 08:56:11: +------+-------------+-------+-------------+---------+
INFO - 08:56:11: | x1 | -5 | None | 5 | integer |
INFO - 08:56:11: | x2 | -5 | None | 5 | integer |
INFO - 08:56:11: +------+-------------+-------+-------------+---------+
INFO - 08:56:11: Solving optimization problem with algorithm fullfact:
INFO - 08:56:11: 1%| | 1/121 [00:00<00:00, 454.32 it/sec, obj=-10]
INFO - 08:56:11: 2%|▏ | 2/121 [00:00<00:00, 699.75 it/sec, obj=-9]
INFO - 08:56:11: 2%|▏ | 3/121 [00:00<00:00, 878.94 it/sec, obj=-8]
INFO - 08:56:11: 3%|▎ | 4/121 [00:00<00:00, 1010.55 it/sec, obj=-7]
INFO - 08:56:11: 4%|▍ | 5/121 [00:00<00:00, 1111.02 it/sec, obj=-6]
INFO - 08:56:11: 5%|▍ | 6/121 [00:00<00:00, 1190.49 it/sec, obj=-5]
INFO - 08:56:11: 6%|▌ | 7/121 [00:00<00:00, 1254.97 it/sec, obj=-4]
INFO - 08:56:11: 7%|▋ | 8/121 [00:00<00:00, 1296.89 it/sec, obj=-3]
INFO - 08:56:11: 7%|▋ | 9/121 [00:00<00:00, 1330.02 it/sec, obj=-2]
INFO - 08:56:11: 8%|▊ | 10/121 [00:00<00:00, 1367.65 it/sec, obj=-1]
INFO - 08:56:11: 9%|▉ | 11/121 [00:00<00:00, 1400.61 it/sec, obj=0]
INFO - 08:56:11: 10%|▉ | 12/121 [00:00<00:00, 1424.82 it/sec, obj=-9]
INFO - 08:56:11: 11%|█ | 13/121 [00:00<00:00, 1445.89 it/sec, obj=-8]
INFO - 08:56:11: 12%|█▏ | 14/121 [00:00<00:00, 1464.56 it/sec, obj=-7]
INFO - 08:56:11: 12%|█▏ | 15/121 [00:00<00:00, 1485.55 it/sec, obj=-6]
INFO - 08:56:11: 13%|█▎ | 16/121 [00:00<00:00, 1500.08 it/sec, obj=-5]
INFO - 08:56:11: 14%|█▍ | 17/121 [00:00<00:00, 1514.77 it/sec, obj=-4]
INFO - 08:56:11: 15%|█▍ | 18/121 [00:00<00:00, 1530.09 it/sec, obj=-3]
INFO - 08:56:11: 16%|█▌ | 19/121 [00:00<00:00, 1544.83 it/sec, obj=-2]
INFO - 08:56:11: 17%|█▋ | 20/121 [00:00<00:00, 1558.03 it/sec, obj=-1]
INFO - 08:56:11: 17%|█▋ | 21/121 [00:00<00:00, 1558.53 it/sec, obj=0]
INFO - 08:56:11: 18%|█▊ | 22/121 [00:00<00:00, 1568.82 it/sec, obj=1]
INFO - 08:56:11: 19%|█▉ | 23/121 [00:00<00:00, 1575.96 it/sec, obj=-8]
INFO - 08:56:11: 20%|█▉ | 24/121 [00:00<00:00, 1583.83 it/sec, obj=-7]
INFO - 08:56:11: 21%|██ | 25/121 [00:00<00:00, 1592.81 it/sec, obj=-6]
INFO - 08:56:11: 21%|██▏ | 26/121 [00:00<00:00, 1601.84 it/sec, obj=-5]
INFO - 08:56:11: 22%|██▏ | 27/121 [00:00<00:00, 1610.26 it/sec, obj=-4]
INFO - 08:56:11: 23%|██▎ | 28/121 [00:00<00:00, 1617.88 it/sec, obj=-3]
INFO - 08:56:11: 24%|██▍ | 29/121 [00:00<00:00, 1625.09 it/sec, obj=-2]
INFO - 08:56:11: 25%|██▍ | 30/121 [00:00<00:00, 1629.55 it/sec, obj=-1]
INFO - 08:56:11: 26%|██▌ | 31/121 [00:00<00:00, 1632.70 it/sec, obj=0]
INFO - 08:56:11: 26%|██▋ | 32/121 [00:00<00:00, 1638.04 it/sec, obj=1]
INFO - 08:56:11: 27%|██▋ | 33/121 [00:00<00:00, 1643.81 it/sec, obj=2]
INFO - 08:56:11: 28%|██▊ | 34/121 [00:00<00:00, 1649.43 it/sec, obj=-7]
INFO - 08:56:11: 29%|██▉ | 35/121 [00:00<00:00, 1654.67 it/sec, obj=-6]
INFO - 08:56:11: 30%|██▉ | 36/121 [00:00<00:00, 1659.65 it/sec, obj=-5]
INFO - 08:56:11: 31%|███ | 37/121 [00:00<00:00, 1664.73 it/sec, obj=-4]
INFO - 08:56:11: 31%|███▏ | 38/121 [00:00<00:00, 1666.09 it/sec, obj=-3]
INFO - 08:56:11: 32%|███▏ | 39/121 [00:00<00:00, 1670.39 it/sec, obj=-2]
INFO - 08:56:11: 33%|███▎ | 40/121 [00:00<00:00, 1674.47 it/sec, obj=-1]
INFO - 08:56:11: 34%|███▍ | 41/121 [00:00<00:00, 1678.66 it/sec, obj=0]
INFO - 08:56:11: 35%|███▍ | 42/121 [00:00<00:00, 1682.45 it/sec, obj=1]
INFO - 08:56:11: 36%|███▌ | 43/121 [00:00<00:00, 1686.05 it/sec, obj=2]
INFO - 08:56:11: 36%|███▋ | 44/121 [00:00<00:00, 1689.63 it/sec, obj=3]
INFO - 08:56:11: 37%|███▋ | 45/121 [00:00<00:00, 1691.37 it/sec, obj=-6]
INFO - 08:56:11: 38%|███▊ | 46/121 [00:00<00:00, 1692.71 it/sec, obj=-5]
INFO - 08:56:11: 39%|███▉ | 47/121 [00:00<00:00, 1695.62 it/sec, obj=-4]
INFO - 08:56:11: 40%|███▉ | 48/121 [00:00<00:00, 1698.51 it/sec, obj=-3]
INFO - 08:56:11: 40%|████ | 49/121 [00:00<00:00, 1701.68 it/sec, obj=-2]
INFO - 08:56:11: 41%|████▏ | 50/121 [00:00<00:00, 1704.53 it/sec, obj=-1]
INFO - 08:56:11: 42%|████▏ | 51/121 [00:00<00:00, 1707.41 it/sec, obj=0]
INFO - 08:56:11: 43%|████▎ | 52/121 [00:00<00:00, 1708.80 it/sec, obj=1]
INFO - 08:56:11: 44%|████▍ | 53/121 [00:00<00:00, 1710.34 it/sec, obj=2]
INFO - 08:56:11: 45%|████▍ | 54/121 [00:00<00:00, 1712.82 it/sec, obj=3]
INFO - 08:56:11: 45%|████▌ | 55/121 [00:00<00:00, 1715.19 it/sec, obj=4]
INFO - 08:56:11: 46%|████▋ | 56/121 [00:00<00:00, 1717.52 it/sec, obj=-5]
INFO - 08:56:11: 47%|████▋ | 57/121 [00:00<00:00, 1719.68 it/sec, obj=-4]
INFO - 08:56:11: 48%|████▊ | 58/121 [00:00<00:00, 1721.78 it/sec, obj=-3]
INFO - 08:56:11: 49%|████▉ | 59/121 [00:00<00:00, 1723.99 it/sec, obj=-2]
INFO - 08:56:11: 50%|████▉ | 60/121 [00:00<00:00, 1723.45 it/sec, obj=-1]
INFO - 08:56:11: 50%|█████ | 61/121 [00:00<00:00, 1725.38 it/sec, obj=0]
INFO - 08:56:11: 51%|█████ | 62/121 [00:00<00:00, 1727.45 it/sec, obj=1]
INFO - 08:56:11: 52%|█████▏ | 63/121 [00:00<00:00, 1729.45 it/sec, obj=2]
INFO - 08:56:11: 53%|█████▎ | 64/121 [00:00<00:00, 1731.41 it/sec, obj=3]
INFO - 08:56:11: 54%|█████▎ | 65/121 [00:00<00:00, 1733.25 it/sec, obj=4]
INFO - 08:56:11: 55%|█████▍ | 66/121 [00:00<00:00, 1735.02 it/sec, obj=5]
INFO - 08:56:11: 55%|█████▌ | 67/121 [00:00<00:00, 1735.56 it/sec, obj=-4]
INFO - 08:56:11: 56%|█████▌ | 68/121 [00:00<00:00, 1736.38 it/sec, obj=-3]
INFO - 08:56:11: 57%|█████▋ | 69/121 [00:00<00:00, 1737.92 it/sec, obj=-2]
INFO - 08:56:11: 58%|█████▊ | 70/121 [00:00<00:00, 1739.33 it/sec, obj=-1]
INFO - 08:56:11: 59%|█████▊ | 71/121 [00:00<00:00, 1740.92 it/sec, obj=0]
INFO - 08:56:11: 60%|█████▉ | 72/121 [00:00<00:00, 1742.51 it/sec, obj=1]
INFO - 08:56:11: 60%|██████ | 73/121 [00:00<00:00, 1744.08 it/sec, obj=2]
INFO - 08:56:11: 61%|██████ | 74/121 [00:00<00:00, 1744.67 it/sec, obj=3]
INFO - 08:56:11: 62%|██████▏ | 75/121 [00:00<00:00, 1745.30 it/sec, obj=4]
INFO - 08:56:11: 63%|██████▎ | 76/121 [00:00<00:00, 1746.55 it/sec, obj=5]
INFO - 08:56:11: 64%|██████▎ | 77/121 [00:00<00:00, 1747.93 it/sec, obj=6]
INFO - 08:56:11: 64%|██████▍ | 78/121 [00:00<00:00, 1749.20 it/sec, obj=-3]
INFO - 08:56:11: 65%|██████▌ | 79/121 [00:00<00:00, 1750.53 it/sec, obj=-2]
INFO - 08:56:11: 66%|██████▌ | 80/121 [00:00<00:00, 1751.78 it/sec, obj=-1]
INFO - 08:56:11: 67%|██████▋ | 81/121 [00:00<00:00, 1753.12 it/sec, obj=0]
INFO - 08:56:11: 68%|██████▊ | 82/121 [00:00<00:00, 1752.72 it/sec, obj=1]
INFO - 08:56:11: 69%|██████▊ | 83/121 [00:00<00:00, 1753.86 it/sec, obj=2]
INFO - 08:56:11: 69%|██████▉ | 84/121 [00:00<00:00, 1755.04 it/sec, obj=3]
INFO - 08:56:11: 70%|███████ | 85/121 [00:00<00:00, 1756.26 it/sec, obj=4]
INFO - 08:56:11: 71%|███████ | 86/121 [00:00<00:00, 1757.42 it/sec, obj=5]
INFO - 08:56:11: 72%|███████▏ | 87/121 [00:00<00:00, 1758.53 it/sec, obj=6]
INFO - 08:56:11: 73%|███████▎ | 88/121 [00:00<00:00, 1759.62 it/sec, obj=7]
INFO - 08:56:11: 74%|███████▎ | 89/121 [00:00<00:00, 1759.71 it/sec, obj=-2]
INFO - 08:56:11: 74%|███████▍ | 90/121 [00:00<00:00, 1760.04 it/sec, obj=-1]
INFO - 08:56:11: 75%|███████▌ | 91/121 [00:00<00:00, 1761.07 it/sec, obj=0]
INFO - 08:56:11: 76%|███████▌ | 92/121 [00:00<00:00, 1762.14 it/sec, obj=1]
INFO - 08:56:11: 77%|███████▋ | 93/121 [00:00<00:00, 1763.19 it/sec, obj=2]
INFO - 08:56:11: 78%|███████▊ | 94/121 [00:00<00:00, 1764.23 it/sec, obj=3]
INFO - 08:56:11: 79%|███████▊ | 95/121 [00:00<00:00, 1765.28 it/sec, obj=4]
INFO - 08:56:11: 79%|███████▉ | 96/121 [00:00<00:00, 1765.33 it/sec, obj=5]
INFO - 08:56:11: 80%|████████ | 97/121 [00:00<00:00, 1765.53 it/sec, obj=6]
INFO - 08:56:11: 81%|████████ | 98/121 [00:00<00:00, 1766.36 it/sec, obj=7]
INFO - 08:56:11: 82%|████████▏ | 99/121 [00:00<00:00, 1767.30 it/sec, obj=8]
INFO - 08:56:11: 83%|████████▎ | 100/121 [00:00<00:00, 1768.12 it/sec, obj=-1]
INFO - 08:56:11: 83%|████████▎ | 101/121 [00:00<00:00, 1768.95 it/sec, obj=0]
INFO - 08:56:11: 84%|████████▍ | 102/121 [00:00<00:00, 1769.78 it/sec, obj=1]
INFO - 08:56:11: 85%|████████▌ | 103/121 [00:00<00:00, 1768.65 it/sec, obj=2]
INFO - 08:56:11: 86%|████████▌ | 104/121 [00:00<00:00, 1767.84 it/sec, obj=3]
INFO - 08:56:11: 87%|████████▋ | 105/121 [00:00<00:00, 1768.54 it/sec, obj=4]
INFO - 08:56:11: 88%|████████▊ | 106/121 [00:00<00:00, 1769.26 it/sec, obj=5]
INFO - 08:56:11: 88%|████████▊ | 107/121 [00:00<00:00, 1770.04 it/sec, obj=6]
INFO - 08:56:11: 89%|████████▉ | 108/121 [00:00<00:00, 1769.32 it/sec, obj=7]
INFO - 08:56:11: 90%|█████████ | 109/121 [00:00<00:00, 1769.85 it/sec, obj=8]
INFO - 08:56:11: 91%|█████████ | 110/121 [00:00<00:00, 1770.56 it/sec, obj=9]
INFO - 08:56:11: 92%|█████████▏| 111/121 [00:00<00:00, 1770.21 it/sec, obj=0]
INFO - 08:56:11: 93%|█████████▎| 112/121 [00:00<00:00, 1770.70 it/sec, obj=1]
INFO - 08:56:11: 93%|█████████▎| 113/121 [00:00<00:00, 1771.41 it/sec, obj=2]
INFO - 08:56:11: 94%|█████████▍| 114/121 [00:00<00:00, 1772.08 it/sec, obj=3]
INFO - 08:56:11: 95%|█████████▌| 115/121 [00:00<00:00, 1770.46 it/sec, obj=4]
INFO - 08:56:11: 96%|█████████▌| 116/121 [00:00<00:00, 1770.91 it/sec, obj=5]
INFO - 08:56:11: 97%|█████████▋| 117/121 [00:00<00:00, 1771.60 it/sec, obj=6]
INFO - 08:56:11: 98%|█████████▊| 118/121 [00:00<00:00, 1771.59 it/sec, obj=7]
INFO - 08:56:11: 98%|█████████▊| 119/121 [00:00<00:00, 1771.82 it/sec, obj=8]
INFO - 08:56:11: 99%|█████████▉| 120/121 [00:00<00:00, 1772.45 it/sec, obj=9]
INFO - 08:56:11: 100%|██████████| 121/121 [00:00<00:00, 1773.14 it/sec, obj=10]
INFO - 08:56:11: Optimization result:
INFO - 08:56:11: Optimizer info:
INFO - 08:56:11: Status: None
INFO - 08:56:11: Message: None
INFO - 08:56:11: Number of calls to the objective function by the optimizer: 121
INFO - 08:56:11: Solution:
INFO - 08:56:11: Objective: -10.0
INFO - 08:56:11: Design space:
INFO - 08:56:11: +------+-------------+-------+-------------+---------+
INFO - 08:56:11: | Name | Lower bound | Value | Upper bound | Type |
INFO - 08:56:11: +------+-------------+-------+-------------+---------+
INFO - 08:56:11: | x1 | -5 | -5 | 5 | integer |
INFO - 08:56:11: | x2 | -5 | -5 | 5 | integer |
INFO - 08:56:11: +------+-------------+-------+-------------+---------+
INFO - 08:56:11: *** End DOEScenario execution (time: 0:00:00.079325) ***
{'eval_jac': False, 'n_samples': 121, 'algo': 'fullfact'}
The optimum results can be found in the execution log. It is also possible to
access them with Scenario.optimization_result:
optimization_result = scenario.optimization_result
f"The solution of P is (x*, f(x*)) = ({optimization_result.x_opt}, {optimization_result.f_opt})"
'The solution of P is (x*, f(x*)) = ([-5. -5.], -10.0)'
Available DOE algorithms¶
In order to get the list of available DOE algorithms, use:
get_available_doe_algorithms()
['CustomDOE', 'DiagonalDOE', 'OT_SOBOL', 'OT_RANDOM', 'OT_HASELGROVE', 'OT_REVERSE_HALTON', 'OT_HALTON', 'OT_FAURE', 'OT_MONTE_CARLO', 'OT_FACTORIAL', 'OT_COMPOSITE', 'OT_AXIAL', 'OT_OPT_LHS', 'OT_LHS', 'OT_LHSC', 'OT_FULLFACT', 'OT_SOBOL_INDICES', 'fullfact', 'ff2n', 'pbdesign', 'bbdesign', 'ccdesign', 'lhs', 'Halton', 'LHS', 'MC', 'PoissonDisk', 'Sobol']
Available post-processing¶
In order to get the list of available post-processing algorithms, use:
get_available_post_processings()
['Animation', 'BasicHistory', 'Compromise', 'ConstraintsHistory', 'Correlations', 'DataVersusModel', 'GradientSensitivity', 'HighTradeOff', 'MultiObjectiveDiagram', 'ObjConstrHist', 'OptHistoryView', 'ParallelCoordinates', 'ParetoFront', 'Petal', 'QuadApprox', 'Radar', 'RadarChart', 'Robustness', 'SOM', 'ScatterPareto', 'ScatterPlotMatrix', 'TopologyView', 'VariableInfluence']
You can also look at the examples:
Total running time of the script: (0 minutes 0.092 seconds)