.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "examples/surrogate/plot_surrogate_discipline.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_examples_surrogate_plot_surrogate_discipline.py>`
        to download the full example code

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_examples_surrogate_plot_surrogate_discipline.py:


Create a surrogate discipline
=============================

We want to build an :class:`.MDODiscipline`
based on a regression model approximating the following discipline
with two inputs and two outputs:

- :math:`y_1=1+2x_1+3x_2`
- :math:`y_2=-1-2x_1-3x_2`

over the unit hypercube :math:`[0,1]\times[0,1]`.
For that,
we use a :class:`.SurrogateDiscipline` relying on an :class:`.BaseMLRegressionAlgo`.

.. GENERATED FROM PYTHON SOURCE LINES 36-47

.. code-block:: Python


    from __future__ import annotations

    from numpy import array

    from gemseo import configure_logger
    from gemseo import create_design_space
    from gemseo import create_discipline
    from gemseo import create_scenario
    from gemseo import create_surrogate








.. GENERATED FROM PYTHON SOURCE LINES 48-50

Import
------

.. GENERATED FROM PYTHON SOURCE LINES 50-54

.. code-block:: Python


    configure_logger()






.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    <RootLogger root (INFO)>



.. GENERATED FROM PYTHON SOURCE LINES 55-59

Create the discipline to learn
------------------------------
We can implement this analytic discipline by means of the
:class:`~gemseo.disciplines.analytic.AnalyticDiscipline` class.

.. GENERATED FROM PYTHON SOURCE LINES 59-64

.. code-block:: Python

    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
    )








.. GENERATED FROM PYTHON SOURCE LINES 65-68

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

.. GENERATED FROM PYTHON SOURCE LINES 68-72

.. code-block:: Python

    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)








.. GENERATED FROM PYTHON SOURCE LINES 73-78

Create the learning set
-----------------------
We can build a learning set by means of a
:class:`~gemseo.core.doe_scenario.DOEScenario` with a full factorial design of
experiments. The number of samples can be equal to 9 for example.

.. GENERATED FROM PYTHON SOURCE LINES 78-83

.. code-block:: Python

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





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

        INFO - 08:57:37:  
        INFO - 08:57:37: *** Start DOEScenario execution ***
        INFO - 08:57:37: DOEScenario
        INFO - 08:57:37:    Disciplines: func
        INFO - 08:57:37:    MDO formulation: DisciplinaryOpt
        INFO - 08:57:37: Optimization problem:
        INFO - 08:57:37:    minimize y_1(x_1, x_2)
        INFO - 08:57:37:    with respect to x_1, x_2
        INFO - 08:57:37:    over the design space:
        INFO - 08:57:37:       +------+-------------+-------+-------------+-------+
        INFO - 08:57:37:       | Name | Lower bound | Value | Upper bound | Type  |
        INFO - 08:57:37:       +------+-------------+-------+-------------+-------+
        INFO - 08:57:37:       | x_1  |      0      |  None |      1      | float |
        INFO - 08:57:37:       | x_2  |      0      |  None |      1      | float |
        INFO - 08:57:37:       +------+-------------+-------+-------------+-------+
        INFO - 08:57:37: Solving optimization problem with algorithm fullfact:
        INFO - 08:57:37:     11%|█         | 1/9 [00:00<00:00, 395.80 it/sec, obj=1]
        INFO - 08:57:37:     22%|██▏       | 2/9 [00:00<00:00, 628.27 it/sec, obj=2]
        INFO - 08:57:37:     33%|███▎      | 3/9 [00:00<00:00, 803.81 it/sec, obj=3]
        INFO - 08:57:37:     44%|████▍     | 4/9 [00:00<00:00, 935.92 it/sec, obj=2.5]
        INFO - 08:57:37:     56%|█████▌    | 5/9 [00:00<00:00, 1038.61 it/sec, obj=3.5]
        INFO - 08:57:37:     67%|██████▋   | 6/9 [00:00<00:00, 1121.42 it/sec, obj=4.5]
        INFO - 08:57:37:     78%|███████▊  | 7/9 [00:00<00:00, 1184.83 it/sec, obj=4]
        INFO - 08:57:37:     89%|████████▉ | 8/9 [00:00<00:00, 1239.77 it/sec, obj=5]
        INFO - 08:57:37:    100%|██████████| 9/9 [00:00<00:00, 1276.55 it/sec, obj=6]
        INFO - 08:57:37: Optimization result:
        INFO - 08:57:37:    Optimizer info:
        INFO - 08:57:37:       Status: None
        INFO - 08:57:37:       Message: None
        INFO - 08:57:37:       Number of calls to the objective function by the optimizer: 9
        INFO - 08:57:37:    Solution:
        INFO - 08:57:37:       Objective: 1.0
        INFO - 08:57:37:       Design space:
        INFO - 08:57:37:          +------+-------------+-------+-------------+-------+
        INFO - 08:57:37:          | Name | Lower bound | Value | Upper bound | Type  |
        INFO - 08:57:37:          +------+-------------+-------+-------------+-------+
        INFO - 08:57:37:          | x_1  |      0      |   0   |      1      | float |
        INFO - 08:57:37:          | x_2  |      0      |   0   |      1      | float |
        INFO - 08:57:37:          +------+-------------+-------+-------------+-------+
        INFO - 08:57:37: *** End DOEScenario execution (time: 0:00:00.018157) ***

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



.. GENERATED FROM PYTHON SOURCE LINES 84-88

Create the surrogate discipline
-------------------------------
Then, we build the Gaussian process regression model from the database and
displays this model.

.. GENERATED FROM PYTHON SOURCE LINES 88-91

.. code-block:: Python

    dataset = scenario.to_dataset(opt_naming=False)
    model = create_surrogate("GaussianProcessRegressor", data=dataset)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

        INFO - 08:57:37: Build the surrogate discipline: GPR_DOEScenario
        INFO - 08:57:37:    Dataset size: 9
        INFO - 08:57:37:    Surrogate model: GaussianProcessRegressor
        INFO - 08:57:37: Use the surrogate discipline: GPR_DOEScenario
        INFO - 08:57:37:    Inputs: x_1, x_2
        INFO - 08:57:37:    Outputs: y_1
        INFO - 08:57:37:    Jacobian: use finite differences




.. GENERATED FROM PYTHON SOURCE LINES 92-95

Predict output
--------------
Once it is built, we can use it for prediction, either with default inputs

.. GENERATED FROM PYTHON SOURCE LINES 95-96

.. code-block:: Python

    model.execute()




.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    {'x_1': array([0.5]), 'x_2': array([0.5]), 'y_1': array([3.49999999])}



.. GENERATED FROM PYTHON SOURCE LINES 97-98

or with user-defined ones.

.. GENERATED FROM PYTHON SOURCE LINES 98-99

.. code-block:: Python

    model.execute({"x_1": array([1.0]), "x_2": array([2.0])})




.. rst-class:: sphx-glr-script-out

 .. code-block:: none


    {'x_1': array([1.]), 'x_2': array([2.]), 'y_1': array([8.50166028])}




.. rst-class:: sphx-glr-timing

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


.. _sphx_glr_download_examples_surrogate_plot_surrogate_discipline.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_surrogate_discipline.ipynb <plot_surrogate_discipline.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_surrogate_discipline.py <plot_surrogate_discipline.py>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_