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 - 13:53:19:
INFO - 13:53:19: *** Start DOEScenario execution ***
INFO - 13:53:19: DOEScenario
INFO - 13:53:19: Disciplines: AnalyticDiscipline
INFO - 13:53:19: MDO formulation: DisciplinaryOpt
INFO - 13:53:19: Optimization problem:
INFO - 13:53:19: minimize y(x1, x2)
INFO - 13:53:19: with respect to x1, x2
INFO - 13:53:19: over the design space:
INFO - 13:53:19: +------+-------------+-------+-------------+---------+
INFO - 13:53:19: | Name | Lower bound | Value | Upper bound | Type |
INFO - 13:53:19: +------+-------------+-------+-------------+---------+
INFO - 13:53:19: | x1 | -5 | None | 5 | integer |
INFO - 13:53:19: | x2 | -5 | None | 5 | integer |
INFO - 13:53:19: +------+-------------+-------+-------------+---------+
INFO - 13:53:19: Solving optimization problem with algorithm fullfact:
INFO - 13:53:19: 1%| | 1/121 [00:00<00:00, 423.88 it/sec, obj=-10]
INFO - 13:53:19: 2%|▏ | 2/121 [00:00<00:00, 653.47 it/sec, obj=-9]
INFO - 13:53:19: 2%|▏ | 3/121 [00:00<00:00, 801.82 it/sec, obj=-8]
INFO - 13:53:19: 3%|▎ | 4/121 [00:00<00:00, 915.09 it/sec, obj=-7]
INFO - 13:53:19: 4%|▍ | 5/121 [00:00<00:00, 1001.07 it/sec, obj=-6]
INFO - 13:53:19: 5%|▍ | 6/121 [00:00<00:00, 1069.07 it/sec, obj=-5]
INFO - 13:53:19: 6%|▌ | 7/121 [00:00<00:00, 1122.67 it/sec, obj=-4]
INFO - 13:53:19: 7%|▋ | 8/121 [00:00<00:00, 1166.42 it/sec, obj=-3]
INFO - 13:53:19: 7%|▋ | 9/121 [00:00<00:00, 1203.76 it/sec, obj=-2]
INFO - 13:53:19: 8%|▊ | 10/121 [00:00<00:00, 1224.90 it/sec, obj=-1]
INFO - 13:53:19: 9%|▉ | 11/121 [00:00<00:00, 1252.20 it/sec, obj=0]
INFO - 13:53:19: 10%|▉ | 12/121 [00:00<00:00, 1276.55 it/sec, obj=-9]
INFO - 13:53:19: 11%|█ | 13/121 [00:00<00:00, 1297.37 it/sec, obj=-8]
INFO - 13:53:19: 12%|█▏ | 14/121 [00:00<00:00, 1316.04 it/sec, obj=-7]
INFO - 13:53:19: 12%|█▏ | 15/121 [00:00<00:00, 1332.82 it/sec, obj=-6]
INFO - 13:53:19: 13%|█▎ | 16/121 [00:00<00:00, 1341.59 it/sec, obj=-5]
INFO - 13:53:19: 14%|█▍ | 17/121 [00:00<00:00, 1354.36 it/sec, obj=-4]
INFO - 13:53:19: 15%|█▍ | 18/121 [00:00<00:00, 1366.72 it/sec, obj=-3]
INFO - 13:53:19: 16%|█▌ | 19/121 [00:00<00:00, 1377.94 it/sec, obj=-2]
INFO - 13:53:19: 17%|█▋ | 20/121 [00:00<00:00, 1388.34 it/sec, obj=-1]
INFO - 13:53:19: 17%|█▋ | 21/121 [00:00<00:00, 1382.91 it/sec, obj=0]
INFO - 13:53:19: 18%|█▊ | 22/121 [00:00<00:00, 1386.71 it/sec, obj=1]
INFO - 13:53:19: 19%|█▉ | 23/121 [00:00<00:00, 1394.44 it/sec, obj=-8]
INFO - 13:53:19: 20%|█▉ | 24/121 [00:00<00:00, 1402.52 it/sec, obj=-7]
INFO - 13:53:19: 21%|██ | 25/121 [00:00<00:00, 1409.87 it/sec, obj=-6]
INFO - 13:53:19: 21%|██▏ | 26/121 [00:00<00:00, 1416.59 it/sec, obj=-5]
INFO - 13:53:19: 22%|██▏ | 27/121 [00:00<00:00, 1423.12 it/sec, obj=-4]
INFO - 13:53:19: 23%|██▎ | 28/121 [00:00<00:00, 1429.10 it/sec, obj=-3]
INFO - 13:53:19: 24%|██▍ | 29/121 [00:00<00:00, 1431.49 it/sec, obj=-2]
INFO - 13:53:19: 25%|██▍ | 30/121 [00:00<00:00, 1436.64 it/sec, obj=-1]
INFO - 13:53:19: 26%|██▌ | 31/121 [00:00<00:00, 1441.73 it/sec, obj=0]
INFO - 13:53:19: 26%|██▋ | 32/121 [00:00<00:00, 1446.90 it/sec, obj=1]
INFO - 13:53:19: 27%|██▋ | 33/121 [00:00<00:00, 1451.67 it/sec, obj=2]
INFO - 13:53:19: 28%|██▊ | 34/121 [00:00<00:00, 1456.10 it/sec, obj=-7]
INFO - 13:53:19: 29%|██▉ | 35/121 [00:00<00:00, 1457.71 it/sec, obj=-6]
INFO - 13:53:19: 30%|██▉ | 36/121 [00:00<00:00, 1463.60 it/sec, obj=-5]
INFO - 13:53:19: 31%|███ | 37/121 [00:00<00:00, 1466.96 it/sec, obj=-4]
INFO - 13:53:19: 31%|███▏ | 38/121 [00:00<00:00, 1470.37 it/sec, obj=-3]
INFO - 13:53:19: 32%|███▏ | 39/121 [00:00<00:00, 1473.90 it/sec, obj=-2]
INFO - 13:53:19: 33%|███▎ | 40/121 [00:00<00:00, 1477.24 it/sec, obj=-1]
INFO - 13:53:19: 34%|███▍ | 41/121 [00:00<00:00, 1478.29 it/sec, obj=0]
INFO - 13:53:19: 35%|███▍ | 42/121 [00:00<00:00, 1482.54 it/sec, obj=1]
INFO - 13:53:19: 36%|███▌ | 43/121 [00:00<00:00, 1484.48 it/sec, obj=2]
INFO - 13:53:19: 36%|███▋ | 44/121 [00:00<00:00, 1487.04 it/sec, obj=3]
INFO - 13:53:19: 37%|███▋ | 45/121 [00:00<00:00, 1489.82 it/sec, obj=-6]
INFO - 13:53:19: 38%|███▊ | 46/121 [00:00<00:00, 1492.33 it/sec, obj=-5]
INFO - 13:53:19: 39%|███▉ | 47/121 [00:00<00:00, 1494.76 it/sec, obj=-4]
INFO - 13:53:19: 40%|███▉ | 48/121 [00:00<00:00, 1494.92 it/sec, obj=-3]
INFO - 13:53:19: 40%|████ | 49/121 [00:00<00:00, 1496.99 it/sec, obj=-2]
INFO - 13:53:19: 41%|████▏ | 50/121 [00:00<00:00, 1499.15 it/sec, obj=-1]
INFO - 13:53:19: 42%|████▏ | 51/121 [00:00<00:00, 1501.41 it/sec, obj=0]
INFO - 13:53:19: 43%|████▎ | 52/121 [00:00<00:00, 1503.61 it/sec, obj=1]
INFO - 13:53:19: 44%|████▍ | 53/121 [00:00<00:00, 1505.53 it/sec, obj=2]
INFO - 13:53:19: 45%|████▍ | 54/121 [00:00<00:00, 1504.97 it/sec, obj=3]
INFO - 13:53:19: 45%|████▌ | 55/121 [00:00<00:00, 1506.46 it/sec, obj=4]
INFO - 13:53:19: 46%|████▋ | 56/121 [00:00<00:00, 1508.10 it/sec, obj=-5]
INFO - 13:53:19: 47%|████▋ | 57/121 [00:00<00:00, 1510.02 it/sec, obj=-4]
INFO - 13:53:19: 48%|████▊ | 58/121 [00:00<00:00, 1511.73 it/sec, obj=-3]
INFO - 13:53:19: 49%|████▉ | 59/121 [00:00<00:00, 1513.45 it/sec, obj=-2]
INFO - 13:53:19: 50%|████▉ | 60/121 [00:00<00:00, 1515.17 it/sec, obj=-1]
INFO - 13:53:19: 50%|█████ | 61/121 [00:00<00:00, 1514.92 it/sec, obj=0]
INFO - 13:53:19: 51%|█████ | 62/121 [00:00<00:00, 1516.33 it/sec, obj=1]
INFO - 13:53:19: 52%|█████▏ | 63/121 [00:00<00:00, 1517.88 it/sec, obj=2]
INFO - 13:53:19: 53%|█████▎ | 64/121 [00:00<00:00, 1519.38 it/sec, obj=3]
INFO - 13:53:19: 54%|█████▎ | 65/121 [00:00<00:00, 1521.00 it/sec, obj=4]
INFO - 13:53:19: 55%|█████▍ | 66/121 [00:00<00:00, 1522.37 it/sec, obj=5]
INFO - 13:53:19: 55%|█████▌ | 67/121 [00:00<00:00, 1522.30 it/sec, obj=-4]
INFO - 13:53:19: 56%|█████▌ | 68/121 [00:00<00:00, 1523.56 it/sec, obj=-3]
INFO - 13:53:19: 57%|█████▋ | 69/121 [00:00<00:00, 1524.87 it/sec, obj=-2]
INFO - 13:53:19: 58%|█████▊ | 70/121 [00:00<00:00, 1526.16 it/sec, obj=-1]
INFO - 13:53:19: 59%|█████▊ | 71/121 [00:00<00:00, 1527.55 it/sec, obj=0]
INFO - 13:53:19: 60%|█████▉ | 72/121 [00:00<00:00, 1528.83 it/sec, obj=1]
INFO - 13:53:19: 60%|██████ | 73/121 [00:00<00:00, 1528.65 it/sec, obj=2]
INFO - 13:53:19: 61%|██████ | 74/121 [00:00<00:00, 1530.71 it/sec, obj=3]
INFO - 13:53:19: 62%|██████▏ | 75/121 [00:00<00:00, 1532.32 it/sec, obj=4]
INFO - 13:53:19: 63%|██████▎ | 76/121 [00:00<00:00, 1533.42 it/sec, obj=5]
INFO - 13:53:19: 64%|██████▎ | 77/121 [00:00<00:00, 1533.84 it/sec, obj=6]
INFO - 13:53:19: 64%|██████▍ | 78/121 [00:00<00:00, 1535.26 it/sec, obj=-3]
INFO - 13:53:19: 65%|██████▌ | 79/121 [00:00<00:00, 1536.28 it/sec, obj=-2]
INFO - 13:53:19: 66%|██████▌ | 80/121 [00:00<00:00, 1535.56 it/sec, obj=-1]
INFO - 13:53:19: 67%|██████▋ | 81/121 [00:00<00:00, 1536.42 it/sec, obj=0]
INFO - 13:53:19: 68%|██████▊ | 82/121 [00:00<00:00, 1537.27 it/sec, obj=1]
INFO - 13:53:19: 69%|██████▊ | 83/121 [00:00<00:00, 1538.19 it/sec, obj=2]
INFO - 13:53:19: 69%|██████▉ | 84/121 [00:00<00:00, 1539.18 it/sec, obj=3]
INFO - 13:53:19: 70%|███████ | 85/121 [00:00<00:00, 1540.11 it/sec, obj=4]
INFO - 13:53:19: 71%|███████ | 86/121 [00:00<00:00, 1539.77 it/sec, obj=5]
INFO - 13:53:19: 72%|███████▏ | 87/121 [00:00<00:00, 1540.49 it/sec, obj=6]
INFO - 13:53:19: 73%|███████▎ | 88/121 [00:00<00:00, 1541.17 it/sec, obj=7]
INFO - 13:53:19: 74%|███████▎ | 89/121 [00:00<00:00, 1541.95 it/sec, obj=-2]
INFO - 13:53:19: 74%|███████▍ | 90/121 [00:00<00:00, 1542.70 it/sec, obj=-1]
INFO - 13:53:19: 75%|███████▌ | 91/121 [00:00<00:00, 1543.59 it/sec, obj=0]
INFO - 13:53:19: 76%|███████▌ | 92/121 [00:00<00:00, 1544.42 it/sec, obj=1]
INFO - 13:53:19: 77%|███████▋ | 93/121 [00:00<00:00, 1544.06 it/sec, obj=2]
INFO - 13:53:19: 78%|███████▊ | 94/121 [00:00<00:00, 1544.72 it/sec, obj=3]
INFO - 13:53:19: 79%|███████▊ | 95/121 [00:00<00:00, 1545.44 it/sec, obj=4]
INFO - 13:53:19: 79%|███████▉ | 96/121 [00:00<00:00, 1546.20 it/sec, obj=5]
INFO - 13:53:19: 80%|████████ | 97/121 [00:00<00:00, 1546.90 it/sec, obj=6]
INFO - 13:53:19: 81%|████████ | 98/121 [00:00<00:00, 1547.61 it/sec, obj=7]
INFO - 13:53:19: 82%|████████▏ | 99/121 [00:00<00:00, 1547.29 it/sec, obj=8]
INFO - 13:53:19: 83%|████████▎ | 100/121 [00:00<00:00, 1547.85 it/sec, obj=-1]
INFO - 13:53:19: 83%|████████▎ | 101/121 [00:00<00:00, 1548.43 it/sec, obj=0]
INFO - 13:53:19: 84%|████████▍ | 102/121 [00:00<00:00, 1549.07 it/sec, obj=1]
INFO - 13:53:19: 85%|████████▌ | 103/121 [00:00<00:00, 1549.10 it/sec, obj=2]
INFO - 13:53:19: 86%|████████▌ | 104/121 [00:00<00:00, 1549.05 it/sec, obj=3]
INFO - 13:53:19: 87%|████████▋ | 105/121 [00:00<00:00, 1547.69 it/sec, obj=4]
INFO - 13:53:19: 88%|████████▊ | 106/121 [00:00<00:00, 1548.05 it/sec, obj=5]
INFO - 13:53:19: 88%|████████▊ | 107/121 [00:00<00:00, 1548.71 it/sec, obj=6]
INFO - 13:53:19: 89%|████████▉ | 108/121 [00:00<00:00, 1549.29 it/sec, obj=7]
INFO - 13:53:19: 90%|█████████ | 109/121 [00:00<00:00, 1544.37 it/sec, obj=8]
INFO - 13:53:19: 91%|█████████ | 110/121 [00:00<00:00, 1543.59 it/sec, obj=9]
INFO - 13:53:19: 92%|█████████▏| 111/121 [00:00<00:00, 1543.12 it/sec, obj=0]
INFO - 13:53:19: 93%|█████████▎| 112/121 [00:00<00:00, 1543.53 it/sec, obj=1]
INFO - 13:53:19: 93%|█████████▎| 113/121 [00:00<00:00, 1544.11 it/sec, obj=2]
INFO - 13:53:19: 94%|█████████▍| 114/121 [00:00<00:00, 1544.73 it/sec, obj=3]
INFO - 13:53:19: 95%|█████████▌| 115/121 [00:00<00:00, 1542.78 it/sec, obj=4]
INFO - 13:53:19: 96%|█████████▌| 116/121 [00:00<00:00, 1543.09 it/sec, obj=5]
INFO - 13:53:19: 97%|█████████▋| 117/121 [00:00<00:00, 1542.83 it/sec, obj=6]
INFO - 13:53:19: 98%|█████████▊| 118/121 [00:00<00:00, 1543.34 it/sec, obj=7]
INFO - 13:53:19: 98%|█████████▊| 119/121 [00:00<00:00, 1543.34 it/sec, obj=8]
INFO - 13:53:19: 99%|█████████▉| 120/121 [00:00<00:00, 1543.78 it/sec, obj=9]
INFO - 13:53:19: 100%|██████████| 121/121 [00:00<00:00, 1544.09 it/sec, obj=10]
INFO - 13:53:19: Optimization result:
INFO - 13:53:19: Optimizer info:
INFO - 13:53:19: Status: None
INFO - 13:53:19: Message: None
INFO - 13:53:19: Number of calls to the objective function by the optimizer: 121
INFO - 13:53:19: Solution:
INFO - 13:53:19: Objective: -10.0
INFO - 13:53:19: Design space:
INFO - 13:53:19: +------+-------------+-------+-------------+---------+
INFO - 13:53:19: | Name | Lower bound | Value | Upper bound | Type |
INFO - 13:53:19: +------+-------------+-------+-------------+---------+
INFO - 13:53:19: | x1 | -5 | -5 | 5 | integer |
INFO - 13:53:19: | x2 | -5 | -5 | 5 | integer |
INFO - 13:53:19: +------+-------------+-------+-------------+---------+
INFO - 13:53:19: *** End DOEScenario execution (time: 0:00:00.090516) ***
{'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.104 seconds)