gemseo / mlearning / regression

Hide inherited members

base_random_process_regressor module

A base class for regressors based on a random process.

A class implementing a Gaussian process regressor must derive from it.

class gemseo.mlearning.regression.base_random_process_regressor.BaseRandomProcessRegressor(data, transformer=mappingproxy({}), input_names=None, output_names=None, **parameters)[source]

Bases: BaseMLRegressionAlgo

A base class for regressors base on a random process.

Parameters:

  • data (IODataset) – The learning dataset.

  • transformer (TransformerType) –

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

    By default it is set to {}.

  • input_names (Iterable[str] | None) – The names of the input variables. If None, consider all the input variables of the learning dataset.

  • output_names (Iterable[str] | None) – The names of the output variables. If None, consider all the output variables of the learning dataset.

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

Raises:

ValueError – When both the variable and the group it belongs to have a transformer.

DataFormatters

alias of RegressionDataFormatters

abstract compute_samples(input_data, n_samples, seed=0)[source]

Sample a random vector from the conditioned Gaussian process.

Parameters:

  • input_data (ndarray[Any, dtype[floating]]) – The \(N\) input points of dimension \(d\) at which to observe the conditioned Gaussian process; shaped as (N, d).

  • n_samples (int) – The number of samples M.

  • seed (int) –

    The seed for reproducible results.

    By default it is set to 0.

Returns:

The output samples per output dimension shaped as (N, M).

Return type:

list[ndarray[Any, dtype[floating]]]

learn(samples=None, fit_transformers=True)

Train the machine learning algorithm from the learning dataset.

Parameters:

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • fit_transformers (bool) –

    Whether to fit the variable transformers. Otherwise, use them as they are.

    By default it is set to True.

Return type:

None

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)

Predict output data from input data.

The user can specify these input data either as a NumPy array, e.g. array([1., 2., 3.]) or as a dictionary, e.g. {'a': array([1.]), 'b': array([2., 3.])}.

If the numpy arrays are of dimension 2, their i-th rows represent the input data of the i-th sample; while if the numpy arrays are of dimension 1, there is a single sample.

The type of the output data and the dimension of the output arrays will be consistent with the type of the input data and the size of the input arrays.

Parameters:

input_data (ndarray | Mapping[str, ndarray]) – The input data.

Returns:

The predicted output data.

Return type:

ndarray | Mapping[str, ndarray]

predict_jacobian(input_data)

Predict the Jacobians of the regression model at input_data.

The user can specify these input data either as a NumPy array, e.g. array([1., 2., 3.]) or as a dictionary, e.g. {'a': array([1.]), 'b': array([2., 3.])}.

If the NumPy arrays are of dimension 2, their i-th rows represent the input data of the i-th sample; while if the NumPy arrays are of dimension 1, there is a single sample.

The type of the output data and the dimension of the output arrays will be consistent with the type of the input data and the size of the input arrays.

Parameters:

input_data (DataType) – The input data.

Returns:

The predicted Jacobian data.

Return type:

NoReturn

predict_raw(input_data)

Predict output data from input data.

Parameters:

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

Returns:

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

Return type:

RealArray

abstract predict_std(input_data)[source]

Predict the standard deviation from input data.

The user can specify these input data either as a NumPy array, e.g. array([1., 2., 3.]) or as a dictionary of NumPy arrays, e.g. {'a': array([1.]), 'b': array([2., 3.])}.

If the NumPy arrays are of dimension 2, their i-th rows represent the input data of the i-th sample; while if the NumPy arrays are of dimension 1, there is a single sample.

Parameters:

input_data (ndarray | Iterable[Any] | Any) – The input data.

Returns:

The standard deviation at the query points.

Return type:

ndarray[Any, dtype[floating]]

Warning

This statistic is expressed in relation to the transformed output space. You can sample the predict() method to estimate it in relation to the original output space if it is different from the transformed output space.

to_pickle(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.

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

str

DEFAULT_TRANSFORMER: DefaultTransformerType = mappingproxy({'inputs': <gemseo.mlearning.transformers.scaler.min_max_scaler.MinMaxScaler object>, 'outputs': <gemseo.mlearning.transformers.scaler.min_max_scaler.MinMaxScaler object>})

The default transformer for the input and output data, if any.

FILENAME: ClassVar[str] = 'ml_algo.pkl'
IDENTITY: Final[DefaultTransformerType] = mappingproxy({})

A transformer leaving the input and output variables as they are.

LIBRARY: ClassVar[str] = ''

The name of the library of the wrapped machine learning algorithm.

SHORT_ALGO_NAME: ClassVar[str] = 'BaseMLSupervisedAlgo'

The short name of the machine learning algorithm, often an acronym.

Typically used for composite names, e.g. f"{algo.SHORT_ALGO_NAME}_{dataset.name}" or f"{algo.SHORT_ALGO_NAME}_{discipline.name}".

algo: Any

The interfaced machine learning algorithm.

property input_data: ndarray

The input data matrix.

property input_dimension: int

The input space dimension.

input_names: list[str]

The names of the input variables.

input_space_center: dict[str, ndarray]

The center of the input space.

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.

learning_set: Dataset

The learning dataset.

property output_data: ndarray

The output data matrix.

property output_dimension: int

The output space dimension.

output_names: list[str]

The names of the output variables.

parameters: dict[str, MLAlgoParameterType]

The parameters of the machine learning algorithm.

resampling_results: dict[str, tuple[BaseResampler, list[BaseMLAlgo], list[ndarray] | ndarray]]

The resampler class names bound to the resampling results.

A resampling result is formatted as (resampler, ml_algos, predictions) where resampler is a BaseResampler, ml_algos is the list of the associated machine learning algorithms built during the resampling stage and predictions are the predictions obtained with the latter.

resampling_results stores only one resampling result per resampler type (e.g., "CrossValidation", "LeaveOneOut" and "Boostrap").

transformer: dict[str, BaseTransformer]

The strategies to transform the variables, if any.

The values are instances of BaseTransformer 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 BaseTransformer will be applied to all the variables of this group.

Examples using BaseRandomProcessRegressor

Scaling

Scaling