Linear regression model.
The linear regression model expresses the output variables as a weighted sum of the input ones:
where the coefficients \((w_1, w_2, ..., w_d)\) and the intercept
\(w_0\) are estimated by least square regression. They are easily
accessible via the arguments coefficients
and intercept
.
The penalty level \(\alpha\) is a non-negative parameter intended to prevent overfitting, while the penalty ratio \(\lambda\in [0, 1]\) expresses the ratio between \(\ell_2\)- and \(\ell_1\)-regularization. When \(\lambda=1\), there is no \(\ell_1\)-regularization, and a Ridge regression is performed. When \(\lambda=0\), there is no \(\ell_2\)-regularization, and a Lasso regression is performed. For \(\lambda\) between 0 and 1, an Elastic Net regression is performed.
One may also choose not to penalize the regression at all, by setting \(\alpha=0\). In this case, a simple least squares regression is performed.
Dependence¶
The linear model relies on the LinearRegression
,
Ridge
, Lasso
and ElasticNet
classes of the scikit-learn library.
- class gemseo.mlearning.regression.linreg.LinearRegressor(data, transformer=None, input_names=None, output_names=None, fit_intercept=True, penalty_level=0.0, l2_penalty_ratio=1.0, **parameters)[source]
Linear regression model.
- Parameters
data (Dataset) – The learning dataset.
transformer (Mapping[str, TransformerType] | None) –
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, theTransformer
will be applied to all the variables of this group. If None, do not transform the variables.By default it is set to None.
input_names (Iterable[str] | None) –
The names of the input variables. If
None
, consider all the input variables of the learning dataset.By default it is set to None.
output_names (Iterable[str] | None) –
The names of the output variables. If
None
, consider all the output variables of the learning dataset.By default it is set to None.
fit_intercept (bool) –
Whether to fit the intercept.
By default it is set to True.
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.
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.
**parameters (float | int | str | bool | None) – The parameters of the machine learning algorithm.
- Raises
ValueError – When both the variable and the group it belongs to have a transformer.
- class DataFormatters
Machine learning regression model decorators.
- 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
- 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]
- get_coefficients(as_dict=True)[source]
Return the regression coefficients of the linear model.
- Parameters
as_dict (bool) –
If True, return the coefficients as a dictionary. Otherwise, return the coefficients as a numpy.array
By default it is set to True.
- Returns
The regression coefficients of the linear model.
- Raises
ValueError – If the coefficients are required as a dictionary even though the transformers change the variables dimensions.
- Return type
Union[numpy.ndarray, Mapping[str, numpy.ndarray]]
- get_intercept(as_dict=True)[source]
Return the regression intercepts of the linear model.
- Parameters
as_dict (bool) –
If True, return the intercepts as a dictionary. Otherwise, return the intercepts as a numpy.array
By default it is set to True.
- Returns
The regression intercepts of the linear model.
- Raises
ValueError – If the coefficients are required as a dictionary even though the transformers change the variables dimensions.
- Return type
Union[numpy.ndarray, Mapping[str, numpy.ndarray]]
- learn(samples=None, fit_transformers=True)
Train the machine learning algorithm from the learning dataset.
- load_algo(directory)
Load a machine learning algorithm from a directory.
- Parameters
directory (str | Path) – The path to the directory where the machine learning algorithm is saved.
- Return type
None
- 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
- save(directory=None, path='.', save_learning_set=False)
Save the machine learning algorithm.
- Parameters
directory (str | None) –
The name of the directory to save the algorithm.
By default it is set to None.
path (str | 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
- property coefficients: numpy.ndarray
The regression coefficients of the linear model.
- property input_data: numpy.ndarray
The input data matrix.
- property input_dimension: int
The input space dimension.
- property intercept: numpy.ndarray
The regression intercepts of the linear model.
- property is_trained: bool
Return whether the algorithm is trained.
- property learning_samples_indices: Sequence[int]
The indices of the learning samples used for the training.
- property output_data: numpy.ndarray
The output data matrix.
- property output_dimension: int
The output space dimension.