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

.. only:: html

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

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

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

.. _sphx_glr_examples_dataset_creation_plot_dataset_from_array.py:


Dataset from a NumPy array
==========================

In this example, we will see how to build a :class:`.Dataset` from an NumPy array.

.. GENERATED FROM PYTHON SOURCE LINES 27-40

.. code-block:: Python


    from __future__ import annotations

    from numpy import concatenate
    from numpy.random import default_rng

    from gemseo import configure_logger
    from gemseo.datasets.dataset import Dataset

    configure_logger()

    rng = default_rng(1)








.. GENERATED FROM PYTHON SOURCE LINES 41-49

Let us consider three parameters :math:`x_1`, :math:`x_2` and :math:`x_3`
of size 1, 2 and 3 respectively.
We generate 5 random samples of the inputs where

- x_1 is stored in the first column,
- x_2 is stored in the 2nd and 3rd columns

and 5 random samples of the outputs:

.. GENERATED FROM PYTHON SOURCE LINES 49-54

.. code-block:: Python

    n_samples = 5
    inputs = rng.random((n_samples, 3))
    outputs = rng.random((n_samples, 3))
    data = concatenate((inputs, outputs), 1)








.. GENERATED FROM PYTHON SOURCE LINES 55-59

A dataset with default names
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We create a :class:`.Dataset` from the NumPy array only
and let GEMSEO give default names to its columns:

.. GENERATED FROM PYTHON SOURCE LINES 59-62

.. code-block:: Python

    dataset = Dataset.from_array(data)
    dataset






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead tr th {
            text-align: left;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr>
          <th>GROUP</th>
          <th colspan="6" halign="left">parameters</th>
        </tr>
        <tr>
          <th>VARIABLE</th>
          <th>x_0</th>
          <th>x_1</th>
          <th>x_2</th>
          <th>x_3</th>
          <th>x_4</th>
          <th>x_5</th>
        </tr>
        <tr>
          <th>COMPONENT</th>
          <th>0</th>
          <th>0</th>
          <th>0</th>
          <th>0</th>
          <th>0</th>
          <th>0</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.511822</td>
          <td>0.950464</td>
          <td>0.144160</td>
          <td>0.453498</td>
          <td>0.134042</td>
          <td>0.403113</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.948649</td>
          <td>0.311831</td>
          <td>0.423326</td>
          <td>0.203455</td>
          <td>0.262313</td>
          <td>0.750365</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.827703</td>
          <td>0.409199</td>
          <td>0.549594</td>
          <td>0.280409</td>
          <td>0.485191</td>
          <td>0.980737</td>
        </tr>
        <tr>
          <th>3</th>
          <td>0.027559</td>
          <td>0.753513</td>
          <td>0.538143</td>
          <td>0.961657</td>
          <td>0.724790</td>
          <td>0.541227</td>
        </tr>
        <tr>
          <th>4</th>
          <td>0.329732</td>
          <td>0.788429</td>
          <td>0.303195</td>
          <td>0.276891</td>
          <td>0.160652</td>
          <td>0.969925</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 63-66

A dataset with custom names
~~~~~~~~~~~~~~~~~~~~~~~~~~~
We can also pass the names and sizes of the variables:

.. GENERATED FROM PYTHON SOURCE LINES 66-70

.. code-block:: Python

    names_to_sizes = {"x_1": 1, "x_2": 2, "y_1": 3}
    dataset = Dataset.from_array(data, ["x_1", "x_2", "y_1"], names_to_sizes)
    dataset






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead tr th {
            text-align: left;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr>
          <th>GROUP</th>
          <th colspan="6" halign="left">parameters</th>
        </tr>
        <tr>
          <th>VARIABLE</th>
          <th>x_1</th>
          <th colspan="2" halign="left">x_2</th>
          <th colspan="3" halign="left">y_1</th>
        </tr>
        <tr>
          <th>COMPONENT</th>
          <th>0</th>
          <th>0</th>
          <th>1</th>
          <th>0</th>
          <th>1</th>
          <th>2</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.511822</td>
          <td>0.950464</td>
          <td>0.144160</td>
          <td>0.453498</td>
          <td>0.134042</td>
          <td>0.403113</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.948649</td>
          <td>0.311831</td>
          <td>0.423326</td>
          <td>0.203455</td>
          <td>0.262313</td>
          <td>0.750365</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.827703</td>
          <td>0.409199</td>
          <td>0.549594</td>
          <td>0.280409</td>
          <td>0.485191</td>
          <td>0.980737</td>
        </tr>
        <tr>
          <th>3</th>
          <td>0.027559</td>
          <td>0.753513</td>
          <td>0.538143</td>
          <td>0.961657</td>
          <td>0.724790</td>
          <td>0.541227</td>
        </tr>
        <tr>
          <th>4</th>
          <td>0.329732</td>
          <td>0.788429</td>
          <td>0.303195</td>
          <td>0.276891</td>
          <td>0.160652</td>
          <td>0.969925</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 71-77

.. warning::

   The number of variables names must be equal to the number of columns of
   the data array. Otherwise, the user has to specify the sizes of the
   different variables by means of a dictionary and be careful that the
   total size is equal to this number of columns.

.. GENERATED FROM PYTHON SOURCE LINES 79-82

A dataset with custom groups
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We can also use the notions of groups of variables:

.. GENERATED FROM PYTHON SOURCE LINES 82-86

.. code-block:: Python

    groups = {"x_1": "inputs", "x_2": "inputs", "y_1": "outputs"}
    dataset = Dataset.from_array(data, ["x_1", "x_2", "y_1"], names_to_sizes, groups)
    dataset






.. raw:: html

    <div class="output_subarea output_html rendered_html output_result">
    <div>
    <style scoped>
        .dataframe tbody tr th:only-of-type {
            vertical-align: middle;
        }

        .dataframe tbody tr th {
            vertical-align: top;
        }

        .dataframe thead tr th {
            text-align: left;
        }
    </style>
    <table border="1" class="dataframe">
      <thead>
        <tr>
          <th>GROUP</th>
          <th colspan="3" halign="left">inputs</th>
          <th colspan="3" halign="left">outputs</th>
        </tr>
        <tr>
          <th>VARIABLE</th>
          <th>x_1</th>
          <th colspan="2" halign="left">x_2</th>
          <th colspan="3" halign="left">y_1</th>
        </tr>
        <tr>
          <th>COMPONENT</th>
          <th>0</th>
          <th>0</th>
          <th>1</th>
          <th>0</th>
          <th>1</th>
          <th>2</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>0.511822</td>
          <td>0.950464</td>
          <td>0.144160</td>
          <td>0.453498</td>
          <td>0.134042</td>
          <td>0.403113</td>
        </tr>
        <tr>
          <th>1</th>
          <td>0.948649</td>
          <td>0.311831</td>
          <td>0.423326</td>
          <td>0.203455</td>
          <td>0.262313</td>
          <td>0.750365</td>
        </tr>
        <tr>
          <th>2</th>
          <td>0.827703</td>
          <td>0.409199</td>
          <td>0.549594</td>
          <td>0.280409</td>
          <td>0.485191</td>
          <td>0.980737</td>
        </tr>
        <tr>
          <th>3</th>
          <td>0.027559</td>
          <td>0.753513</td>
          <td>0.538143</td>
          <td>0.961657</td>
          <td>0.724790</td>
          <td>0.541227</td>
        </tr>
        <tr>
          <th>4</th>
          <td>0.329732</td>
          <td>0.788429</td>
          <td>0.303195</td>
          <td>0.276891</td>
          <td>0.160652</td>
          <td>0.969925</td>
        </tr>
      </tbody>
    </table>
    </div>
    </div>
    <br />
    <br />

.. GENERATED FROM PYTHON SOURCE LINES 87-93

.. note::

   The groups are specified by means of a dictionary
   where indices are the variables names and values are the groups.
   If a variable is missing,
   the default group :attr:`.Dataset.DEFAULT_GROUP` is considered.


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

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


.. _sphx_glr_download_examples_dataset_creation_plot_dataset_from_array.py:

.. only:: html

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

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

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

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

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


.. only:: html

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

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