We want to build a regression model and save it on the disk.

This regression model is an approximation of the following discipline with two inputs and two outputs:

• $$y_1=1+2x_1+3x_2$$

• $$y_2=-1-2x_1-3x_2$$

over the unit hypercube $$[0,1]\times[0,1]$$.

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.mlearning import create_regression_model
from gemseo.mlearning import import_regression_model
from numpy import array

configure_logger()

<RootLogger root (INFO)>


## Create the discipline to learn¶

We can implement this analytic discipline by means of the AnalyticDiscipline class.

expressions = {"y_1": "1+2*x_1+3*x_2", "y_2": "-1-2*x_1-3*x_2"}
discipline = create_discipline(
"AnalyticDiscipline", name="func", expressions=expressions
)


## Create the input sampling space¶

We create the input sampling space by adding the variables one by one.

design_space = create_design_space()


## Create the learning set¶

We can build a learning set by means of a DOEScenario with a full factorial design of experiments. The number of samples can be equal to 9 for example.

scenario = create_scenario(
[discipline], "DisciplinaryOpt", "y_1", design_space, scenario_type="DOE"
)
scenario.execute({"algo": "fullfact", "n_samples": 9})

    INFO - 16:29:01:
INFO - 16:29:01: *** Start DOEScenario execution ***
INFO - 16:29:01: DOEScenario
INFO - 16:29:01:    Disciplines: func
INFO - 16:29:01:    MDO formulation: DisciplinaryOpt
INFO - 16:29:01: Optimization problem:
INFO - 16:29:01:    minimize y_1(x_1, x_2)
INFO - 16:29:01:    with respect to x_1, x_2
INFO - 16:29:01:    over the design space:
INFO - 16:29:01:    +------+-------------+-------+-------------+-------+
INFO - 16:29:01:    | name | lower_bound | value | upper_bound | type  |
INFO - 16:29:01:    +------+-------------+-------+-------------+-------+
INFO - 16:29:01:    | x_1  |      0      |  None |      1      | float |
INFO - 16:29:01:    | x_2  |      0      |  None |      1      | float |
INFO - 16:29:01:    +------+-------------+-------+-------------+-------+
INFO - 16:29:01: Solving optimization problem with algorithm fullfact:
INFO - 16:29:01: ...   0%|          | 0/9 [00:00<?, ?it]
INFO - 16:29:01: ...  11%|█         | 1/9 [00:00<00:00, 291.47 it/sec, obj=1]
INFO - 16:29:01: ...  22%|██▏       | 2/9 [00:00<00:00, 480.47 it/sec, obj=2]
INFO - 16:29:01: ...  33%|███▎      | 3/9 [00:00<00:00, 612.87 it/sec, obj=3]
INFO - 16:29:01: ...  44%|████▍     | 4/9 [00:00<00:00, 714.96 it/sec, obj=2.5]
INFO - 16:29:01: ...  56%|█████▌    | 5/9 [00:00<00:00, 801.02 it/sec, obj=3.5]
INFO - 16:29:01: ...  67%|██████▋   | 6/9 [00:00<00:00, 870.07 it/sec, obj=4.5]
INFO - 16:29:01: ...  78%|███████▊  | 7/9 [00:00<00:00, 928.97 it/sec, obj=4]
INFO - 16:29:01: ...  89%|████████▉ | 8/9 [00:00<00:00, 979.75 it/sec, obj=5]
INFO - 16:29:01: ... 100%|██████████| 9/9 [00:00<00:00, 1023.28 it/sec, obj=6]
INFO - 16:29:01: Optimization result:
INFO - 16:29:01:    Optimizer info:
INFO - 16:29:01:       Status: None
INFO - 16:29:01:       Message: None
INFO - 16:29:01:       Number of calls to the objective function by the optimizer: 9
INFO - 16:29:01:    Solution:
INFO - 16:29:01:       Objective: 1.0
INFO - 16:29:01:       Design space:
INFO - 16:29:01:       +------+-------------+-------+-------------+-------+
INFO - 16:29:01:       | name | lower_bound | value | upper_bound | type  |
INFO - 16:29:01:       +------+-------------+-------+-------------+-------+
INFO - 16:29:01:       | x_1  |      0      |   0   |      1      | float |
INFO - 16:29:01:       | x_2  |      0      |   0   |      1      | float |
INFO - 16:29:01:       +------+-------------+-------+-------------+-------+
INFO - 16:29:01: *** End DOEScenario execution (time: 0:00:00.021199) ***

{'eval_jac': False, 'n_samples': 9, 'algo': 'fullfact'}


## Create the regression model¶

Then, we build the linear regression model from the database and displays this model.

dataset = scenario.to_dataset(opt_naming=False)
model = create_regression_model("RBFRegressor", data=dataset)
model.learn()


## Use it for prediction¶

input_value = {"x_1": array([1.0]), "x_2": array([2.0])}
print(model.predict(input_value))

{'y_1': array([6.45029404])}


## Save the regression model¶

Lastly, we save the model.

directory = model.to_pickle()
print(directory)

/home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/5.0.0/lib/python3.9/site-packages/gemseo/mlearning/core/ml_algo.py:327: UserWarning: Pandas doesn't allow columns to be created via a new attribute name - see https://pandas.pydata.org/pandas-docs/stable/indexing.html#attribute-access
self.learning_set.data = {}
r_b_f_regressor_DOEScenario


In an other study, we could load this model.

loaded_model = import_regression_model(directory)

RBFRegressor(epsilon=None, function=multiquadric, norm=euclidean, smooth=0.0)
based on the SciPy library
built from 9 learning samples


## Use the loaded regression model¶

And use it!

print(loaded_model.predict(input_value))

{'y_1': array([6.45029404])}


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

Gallery generated by Sphinx-Gallery