Save and Load

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.api import configure_logger
from gemseo.api import create_design_space
from gemseo.api import create_discipline
from gemseo.api import create_scenario
from gemseo.mlearning.api import create_regression_model
from gemseo.mlearning.api 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()
design_space.add_variable("x_1", l_b=0.0, u_b=1.0)
design_space.add_variable("x_2", l_b=0.0, u_b=1.0)

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 - 11:24:56:
    INFO - 11:24:56: *** Start DOEScenario execution ***
    INFO - 11:24:56: DOEScenario
    INFO - 11:24:56:    Disciplines: func
    INFO - 11:24:56:    MDO formulation: DisciplinaryOpt
    INFO - 11:24:56: Optimization problem:
    INFO - 11:24:56:    minimize y_1(x_1, x_2)
    INFO - 11:24:56:    with respect to x_1, x_2
    INFO - 11:24:56:    over the design space:
    INFO - 11:24:56:    +------+-------------+-------+-------------+-------+
    INFO - 11:24:56:    | name | lower_bound | value | upper_bound | type  |
    INFO - 11:24:56:    +------+-------------+-------+-------------+-------+
    INFO - 11:24:56:    | x_1  |      0      |  None |      1      | float |
    INFO - 11:24:56:    | x_2  |      0      |  None |      1      | float |
    INFO - 11:24:56:    +------+-------------+-------+-------------+-------+
    INFO - 11:24:56: Solving optimization problem with algorithm fullfact:
    INFO - 11:24:56: ...   0%|          | 0/9 [00:00<?, ?it]
    INFO - 11:24:56: ... 100%|██████████| 9/9 [00:00<00:00, 1456.41 it/sec, obj=6]
    INFO - 11:24:56: Optimization result:
    INFO - 11:24:56:    Optimizer info:
    INFO - 11:24:56:       Status: None
    INFO - 11:24:56:       Message: None
    INFO - 11:24:56:       Number of calls to the objective function by the optimizer: 9
    INFO - 11:24:56:    Solution:
    INFO - 11:24:56:       Objective: 1.0
    INFO - 11:24:56:       Design space:
    INFO - 11:24:56:       +------+-------------+-------+-------------+-------+
    INFO - 11:24:56:       | name | lower_bound | value | upper_bound | type  |
    INFO - 11:24:56:       +------+-------------+-------+-------------+-------+
    INFO - 11:24:56:       | x_1  |      0      |   0   |      1      | float |
    INFO - 11:24:56:       | x_2  |      0      |   0   |      1      | float |
    INFO - 11:24:56:       +------+-------------+-------+-------------+-------+
    INFO - 11:24:56: *** End DOEScenario execution (time: 0:00:00.015734) ***

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

Create the regression model

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

dataset = scenario.export_to_dataset(opt_naming=False)
model = create_regression_model("RBFRegressor", data=dataset)
model.learn()
/home/docs/checkouts/readthedocs.org/user_builds/gemseo/envs/develop/lib/python3.9/site-packages/gemseo/mlearning/transform/scaler/min_max_scaler.py:73: RuntimeWarning: divide by zero encountered in divide
  self.coefficient = where(is_constant, nan_to_num(1 / l_b), 1 / delta)

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.save()
print(directory)
r_b_f_regressor_DOEScenario

Load the regression model

In an other study, we could load this model.

loaded_model = import_regression_model(directory)
print(loaded_model)
RBFRegressor(epsilon=None, function=multiquadric, norm=euclidean, smooth=0.0)
   based on the SciPy library
   built from 0 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.040 seconds)

Gallery generated by Sphinx-Gallery