..
   Copyright 2021 IRT Saint-Exupéry, https://www.irt-saintexupery.com

   This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
   International License. To view a copy of this license, visit
   http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative
   Commons, PO Box 1866, Mountain View, CA 94042, USA.

.. _gen_regression_algos:

Options for Regression algorithms
=================================


.. _GaussianProcessRegression_options:

GaussianProcessRegression
-------------------------

Module: :class:`gemseo.mlearning.regression.gpr`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**alpha** (*Union[float,ndarray]*)

The nugget effect to regularize the model.


By default it is set to 1e-10.


.. raw:: html

    </li>


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**kernel** (*Optional[openturns*)

The kernel function. If None, use a ``Matern(2.5)``.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**n_restarts_optimizer** (*int*)

The number of restarts of the optimizer.


By default it is set to 10.


.. raw:: html

    </li>


    <li>

**optimizer** (*Union[str,Callable]*)

The optimization algorithm to find the hyperparameters.


By default it is set to fmin_l_bfgs_b.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**random_state** (*Optional[int]*)

The seed used to initialize the centers. If None, the random number generator is the RandomState instance used by `numpy.random`.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>


.. _LinearRegression_options:

LinearRegression
----------------

Module: :class:`gemseo.mlearning.regression.linreg`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****parameters** (*Optional[Union[float,int,str,bool]]*)

The parameters of the machine learning algorithm.



.. raw:: html

    </li>


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**fit_intercept** (*bool*)

Whether to fit the intercept.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**l2_penalty_ratio** (*float*)

The penalty ratio related to the l2 regularization. If 1, use the Ridge penalty. If 0, use the Lasso penalty. Between 0 and 1, use the ElasticNet penalty.


By default it is set to 1.0.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**penalty_level** (*float*)

The penalty level greater or equal to 0. If 0, there is no penalty.


By default it is set to 0.0.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>


.. _MixtureOfExperts_options:

MixtureOfExperts
----------------

Module: :class:`gemseo.mlearning.regression.moe`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**hard** (*bool*)

Whether clustering/classification should be hard or soft.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>


.. _PCERegression_options:

PCERegression
-------------

Module: :class:`gemseo.mlearning.regression.pce`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**degree** (*int*)

The polynomial degree of the PCE.


By default it is set to 2.


.. raw:: html

    </li>


    <li>

**discipline** (*Optional[MDODiscipline]*)

The discipline to evaluate with the quadrature strategy if the learning set does not have output data. If None, use the output data from the learning set.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**n_quad** (*Optional[int]*)

The total number of quadrature points used by the quadrature strategy to compute the marginal number of points by input dimension. If None, this degree will be set equal to the polynomial degree of the PCE plus one.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**probability_space** (*ParameterSpace*)

The probability space defining the probability distributions of the model inputs.



.. raw:: html

    </li>


    <li>

**sparse_param** (*Optional[Mapping[str,Union[int,float]]]*)

The parameters for the Sparse Cleaning Truncation Strategy and/or hyperbolic truncation of the initial basis: - **max_considered_terms** (int) -- The maximum considered terms (default: 120), - **most_significant** (int) -- The most Significant number to retain (default: 30), - **significance_factor** (float) -- Significance Factor (default: 1e-3), - **hyper_factor** (float) -- The factor for the hyperbolic truncation strategy (default: 1.0). If None, use default values.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**stieltjes** (*bool*)

Whether to use the Stieltjes method.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**strategy** (*str*)

The strategy to compute the parameters of the PCE, either 'LS' for *least-square*, 'Quad' for *quadrature* or 'SparseLS' for *sparse least-square*.


By default it is set to LS.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>


.. _PolynomialRegression_options:

PolynomialRegression
--------------------

Module: :class:`gemseo.mlearning.regression.polyreg`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****parameters** (*Optional[Union[float,int,str,bool]]*)

The parameters of the machine learning algorithm.



.. raw:: html

    </li>


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**degree** (*int*)

The polynomial degree.



.. raw:: html

    </li>


    <li>

**fit_intercept** (*bool*)

Whether to fit the intercept.


By default it is set to True.


.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**l2_penalty_ratio** (*float*)

The penalty ratio related to the l2 regularization. If 1, the penalty is the Ridge penalty. If 0, this is the Lasso penalty. Between 0 and 1, the penalty is the ElasticNet penalty.


By default it is set to 1.0.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**penalty_level** (*float*)

The penalty level greater or equal to 0. If 0, there is no penalty.


By default it is set to 0.0.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>


.. _RBFRegression_options:

RBFRegression
-------------

Module: :class:`gemseo.mlearning.regression.rbf`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**der_function** (*Optional[Callable[[ndarray],ndarray]]*)

The derivative of the radial basis function, only to be provided if ``function`` is a callable and if the use of the model with its derivative is required. If ``None`` and if ``function`` is a callable, an error will be raised. If ``None`` and if ``function`` is a string, the class will look for its internal implementation and will raise an error if it is missing. The ``der_function`` shall take three arguments (``input_data``, ``norm_input_data``, ``eps``). For a RBF of the form function(:math:`r`), der_function(:math:`x`, :math:`|x|`, :math:`\epsilon`) shall return :math:`\epsilon^{-1} x/|x| f'(|x|/\epsilon)`.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**epsilon** (*Optional[float]*)

An adjustable constant for Gaussian or multiquadric functions. If ``None``, use the average distance between input data.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**function** (*Union[str,*)

The radial basis function taking a radius ``r`` as input, representing a distance between two points. If string, then it must be one of the following: .. code:: 'multiquadric': sqrt((r/self.epsilon)**2 + 1) 'inverse': 1.0/sqrt((r/self.epsilon)**2 + 1) 'gaussian': exp(-(r/self.epsilon)**2) 'linear': r 'cubic': r**3 'quintic': r**5 'thin_plate': r**2 * log(r) If callable, then it must take two arguments ``(self, r)``, e.g. ``lambda self, r: return sqrt((r/self.epsilon)**2 + 1)`` for the multiquadric function. The epsilon parameter will be available as ``self.epsilon``. Other keyword arguments passed in will be available as well.


By default it is set to multiquadric.


.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**norm** (*Union[str,Callable[[ndarray,ndarray],float]]*)

The distance metric to be used, either a distance function name `known by SciPy <https://docs.scipy.org/doc/scipy/reference/generated/ scipy.spatial.distance.cdist.html>`_ or a function that computes the distance between two points.


By default it is set to euclidean.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**smooth** (*float*)

The degree of smoothness, ``0`` involving an interpolation of the learning points.


By default it is set to 0.0.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>


.. _RandomForestRegressor_options:

RandomForestRegressor
---------------------

Module: :class:`gemseo.mlearning.regression.random_forest`





Here are the options available in |g|:

.. raw:: html

    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
    <link rel="stylesheet" href="../_static/css/gemseo.css" type="text/css" />

    <dl class="field-list simple">
    <dt class="field-odd">Options</dt>
    <dd class="field-odd"><ul class="simple">


    <li>

****parameters** (*Optional[Union[bool,int,float,str]]*)

The parameters of the machine learning algorithm.



.. raw:: html

    </li>


    <li>

**data** (*Dataset*)

The learning dataset.



.. raw:: html

    </li>


    <li>

**input_names** (*Optional[Iterable[str]]*)

The names of the input variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**n_estimators** (*int*)

The number of trees in the forest.


By default it is set to 100.


.. raw:: html

    </li>


    <li>

**output_names** (*Optional[Iterable[str]]*)

The names of the output variables. If None, consider all input variables mentioned in the learning dataset.


By default it is set to None.


.. raw:: html

    </li>


    <li>

**transformer** (*Optional[TransformerType]*)

The strategies to transform the variables. The values are instances of :class:`.Transformer` while the keys are the names of either the variables or the groups of variables, e.g. "inputs" or "outputs" in the case of the regression algorithms. If a group is specified, the :class:`.Transformer` will be applied to all the variables of this group. If None, do not transform the variables.


By default it is set to None.


.. raw:: html

    </li>



    </ul>
    </dd>
    </dl>