gemseo / mlearning / regression

regression module

This module contains the baseclass for regression algorithms.

The regression module implements regression algorithms, where the goal is to find relationships between continuous input and output variables. After being fitted to a learning set, the regression algorithms can predict output values of new input data.

A regression algorithm consists of identifying a function \(f: \mathbb{R}^{n_{\textrm{inputs}}} \to \mathbb{R}^{n_{\textrm{outputs}}}\). Given an input point \(x \in \mathbb{R}^{n_{\textrm{inputs}}}\), the predict method of the regression algorithm will return the output point \(y = f(x) \in \mathbb{R}^{n_{\textrm{outputs}}}\). See supervised for more information.

Wherever possible, the regression algorithms should also be able to compute the Jacobian matrix of the function it has learned to represent. Thus, given an input point \(x \in \mathbb{R}^{n_{\textrm{inputs}}}\), the Jacobian prediction method of the regression algorithm should return the matrix

\[\begin{split}J_f(x) = \frac{\partial f}{\partial x} = \begin{pmatrix} \frac{\partial f_1}{\partial x_1} & \cdots & \frac{\partial f_1} {\partial x_{n_{\textrm{inputs}}}}\\ \vdots & \ddots & \vdots\\ \frac{\partial f_{n_{\textrm{outputs}}}}{\partial x_1} & \cdots & \frac{\partial f_{n_{\textrm{outputs}}}} {\partial x_{n_{\textrm{inputs}}}} \end{pmatrix} \in \mathbb{R}^{n_{\textrm{outputs}}\times n_{\textrm{inputs}}}.\end{split}\]

This concept is implemented through the MLRegressionAlgo class which inherits from the MLSupervisedAlgo class.

Classes:

MLRegressionAlgo(data[, transformer, ...])

Machine Learning Regression Model Algorithm.

class gemseo.mlearning.regression.regression.MLRegressionAlgo(data, transformer={'inputs': <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object>, 'outputs': <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object>}, input_names=None, output_names=None, **parameters)

Bases: gemseo.mlearning.core.supervised.MLSupervisedAlgo

Machine Learning Regression Model Algorithm.

Inheriting classes shall implement the MLSupervisedAlgo._fit() and MLSupervisedAlgo._predict() methods, and MLRegressionAlgo._predict_jacobian() method if possible.

learning_set

The learning dataset.

Type

Dataset

parameters

The parameters of the machine learning algorithm.

Type

Dict[str,MLAlgoParameterType]

transformer

The strategies to transform the variables. The values are instances of 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 Transformer will be applied to all the variables of this group. If None, do not transform the variables.

Type

Dict[str,Transformer]

algo

The interfaced machine learning algorithm.

Type

Any

input_names

The names of the input variables.

Type

List[str]

output_names

The names of the output variables.

Type

List[str]

input_space_center

The center of the input space.

Type

Dict[str,ndarray]

Initialize self. See help(type(self)) for accurate signature.

Parameters

• data (Dataset) – The learning dataset.

• transformer (TransformerType) –

  The strategies to transform the variables. The values are instances of 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 Transformer will be applied to all the variables of this group. If None, do not transform the variables.

  By default it is set to {‘inputs’: <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object at 0x7fb78e151e20>, ‘outputs’: <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object at 0x7fb78e151e80>}.

• 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.

• 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.

• **parameters (MLAlgoParameterType) – The parameters of the machine learning algorithm.

Return type

None

Attributes:

ABBR
DEFAULT_TRANSFORMER
FILENAME
LIBRARY
input_data	The input data matrix.
input_shape	The dimension of the input variables before applying the transformers.
is_trained	Return whether the algorithm is trained.
learning_samples_indices	The indices of the learning samples used for the training.
output_data	The output data matrix.
output_shape	The dimension of the output variables before applying the transformers.

Classes:

DataFormatters()

Machine learning regression model decorators.

Methods:

learn([samples])	Train the machine learning algorithm from the learning dataset.
load_algo(directory)	Load a machine learning algorithm from a directory.
predict(input_data, *args, **kwargs)	Evaluate 'predict' with either array or dictionary-based input data.
predict_jacobian(input_data, *args, **kwargs)	Evaluate 'predict_jac' with either array or dictionary-based data.
predict_raw(input_data)	Predict output data from input data.
save([directory, path, save_learning_set])	Save the machine learning algorithm.

ABBR = 'MLSupervisedAlgo'

DEFAULT_TRANSFORMER = {'inputs': <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object>, 'outputs': <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object>}

class DataFormatters

Bases: gemseo.mlearning.core.supervised.MLSupervisedAlgo.DataFormatters

Machine learning regression model decorators.

Methods:

format_dict(predict)	Make an array-based function be called with a dictionary of NumPy arrays.
format_dict_jacobian(predict_jac)	Wrap an array-based function to make it callable with a dictionary of NumPy arrays.
format_input_output(predict)	Make a function robust to type, array shape and data transformation.
format_samples(predict)	Make a 2D NumPy array-based function work with 1D NumPy array.
format_transform([transform_inputs, ...])	Force a function to transform its input and/or output variables.
transform_jacobian(predict_jac)	Apply transformation to inputs and inverse transformation to outputs.

classmethod format_dict(predict)

Make an array-based function be called with a dictionary of NumPy arrays.

Parameters

predict (Callable[[numpy.ndarray], numpy.ndarray]) – The function to be called; it takes a NumPy array in input and returns a NumPy array.

Returns

A function making the function ‘predict’ work with either a NumPy data array or a dictionary of NumPy data arrays indexed by variables names. The evaluation will have the same type as the input data.

Return type

Callable[[Union[numpy.ndarray, Mapping[str, numpy.ndarray]]], Union[numpy.ndarray, Mapping[str, numpy.ndarray]]]

classmethod format_dict_jacobian(predict_jac)

Wrap an array-based function to make it callable with a dictionary of NumPy arrays.

Parameters

predict_jac (Callable[[numpy.ndarray], numpy.ndarray]) – The function to be called; it takes a NumPy array in input and returns a NumPy array.

Returns

The wrapped ‘predict_jac’ function, callable with either a NumPy data array or a dictionary of numpy data arrays indexed by variables names. The return value will have the same type as the input data.

Return type

Callable[[Union[numpy.ndarray, Mapping[str, numpy.ndarray]]], Union[numpy.ndarray, Mapping[str, numpy.ndarray]]]

classmethod format_input_output(predict)

Make a function robust to type, array shape and data transformation.

Parameters

predict (Callable[[numpy.ndarray], numpy.ndarray]) – The function of interest to be called.

Returns

A function calling the function of interest ‘predict’, while guaranteeing consistency in terms of data type and array shape, and applying input and/or output data transformation if required.

Return type

Callable[[Union[numpy.ndarray, Mapping[str, numpy.ndarray]]], Union[numpy.ndarray, Mapping[str, numpy.ndarray]]]

classmethod format_samples(predict)

Make a 2D NumPy array-based function work with 1D NumPy array.

Parameters

predict (Callable[[numpy.ndarray], numpy.ndarray]) – The function to be called; it takes a 2D NumPy array in input and returns a 2D NumPy array. The first dimension represents the samples while the second one represents the components of the variables.

Returns

A function making the function ‘predict’ work with either a 1D NumPy array or a 2D NumPy array. The evaluation will have the same dimension as the input data.

Return type

Callable[[numpy.ndarray], numpy.ndarray]

classmethod format_transform(transform_inputs=True, transform_outputs=True)

Force a function to transform its input and/or output variables.

Parameters

• transform_inputs (bool) –

  Whether to transform the input variables.

  By default it is set to True.

• transform_outputs (bool) –

  Whether to transform the output variables.

  By default it is set to True.

Returns

A function evaluating a function of interest, after transforming its input data and/or before transforming its output data.

Return type

Callable[[numpy.ndarray], numpy.ndarray]

classmethod transform_jacobian(predict_jac)

Apply transformation to inputs and inverse transformation to outputs.

Parameters

predict_jac (Callable[[numpy.ndarray], numpy.ndarray]) – The function of interest to be called.

Returns

A function evaluating the function ‘predict_jac’, after transforming its input data and/or before transforming its output data.

Return type

Callable[[numpy.ndarray], numpy.ndarray]

FILENAME = 'ml_algo.pkl'

LIBRARY = None

property input_data

The input data matrix.

property input_shape

The dimension of the input variables before applying the transformers.

property is_trained

Return whether the algorithm is trained.

learn(samples=None)

Train the machine learning algorithm from the learning dataset.

Parameters

samples (Optional[Sequence[int]]) –

The indices of the learning samples. If None, use the whole learning dataset.

By default it is set to None.

Return type

None

property learning_samples_indices

The indices of the learning samples used for the training.

load_algo(directory)

Load a machine learning algorithm from a directory.

Parameters

directory (Union[str, pathlib.Path]) – The path to the directory where the machine learning algorithm is saved.

Return type

None

property output_data

The output data matrix.

property output_shape

The dimension of the output variables before applying the transformers.

predict(input_data, *args, **kwargs)

Evaluate ‘predict’ with either array or dictionary-based input data.

Firstly, the pre-processing stage converts the input data to a NumPy data array, if these data are expressed as a dictionary of NumPy data arrays.

Then, the processing evaluates the function ‘predict’ from this NumPy input data array.

Lastly, the post-processing transforms the output data to a dictionary of output NumPy data array if the input data were passed as a dictionary of NumPy data arrays.

Parameters

• input_data (Union[numpy.ndarray, Mapping[str, numpy.ndarray]]) – The input data.

• *args – The positional arguments of the function ‘predict’.

• **kwargs – The keyword arguments of the function ‘predict’.

Returns

The output data with the same type as the input one.

Return type

Union[numpy.ndarray, Mapping[str, numpy.ndarray]]

predict_jacobian(input_data, *args, **kwargs)

Evaluate ‘predict_jac’ with either array or dictionary-based data.

Firstly, the pre-processing stage converts the input data to a NumPy data array, if these data are expressed as a dictionary of NumPy data arrays.

Then, the processing evaluates the function ‘predict_jac’ from this NumPy input data array.

Lastly, the post-processing transforms the output data to a dictionary of output NumPy data array if the input data were passed as a dictionary of NumPy data arrays.

Parameters

• input_data – The input data.

• *args – The positional arguments of the function ‘predict_jac’.

• **kwargs – The keyword arguments of the function ‘predict_jac’.

Returns

The output data with the same type as the input one.

predict_raw(input_data)

Predict output data from input data.

Parameters

input_data (numpy.ndarray) – The input data with shape (n_samples, n_inputs).

Returns

The predicted output data with shape (n_samples, n_outputs).

Return type

numpy.ndarray

save(directory=None, path='.', save_learning_set=False)

Save the machine learning algorithm.

Parameters

• directory (Optional[str]) –

  The name of the directory to save the algorithm.

  By default it is set to None.

• path (Union[str, pathlib.Path]) –

  The path to parent directory where to create the directory.

  By default it is set to ..

• save_learning_set (bool) –

  Whether to save the learning set or get rid of it to lighten the saved files.

  By default it is set to False.

Returns

The path to the directory where the algorithm is saved.

Return type

str