gemseo / mlearning / transform / dimension_reduction

pls module

The Partial Least Square (PLS) regression to reduce the dimension of a variable.

The PLS class wraps the PCA from Scikit-learn.

Dependence

This dimension reduction algorithm relies on the PLSRegression class of the scikit-learn library.

class gemseo.mlearning.transform.dimension_reduction.pls.PLS(name='PLS', n_components=None, **parameters)[source]

Bases: gemseo.mlearning.transform.dimension_reduction.dimension_reduction.DimensionReduction

Partial Least Square regression.

Parameters

  • name (str) –

    A name for this transformer.

    By default it is set to PLS.

  • n_components (int | None) –

    The number of components of the latent space. If None, use the maximum number allowed by the technique, typically min(n_samples, n_features).

    By default it is set to None.

  • **parameters (float | int | bool) – The optional parameters for sklearn PCA constructor.

Return type

None

compute_jacobian(data)[source]

Compute Jacobian of transformer.transform().

Parameters

data (numpy.ndarray) – The data where the Jacobian is to be computed.

Returns

The Jacobian matrix.

Return type

NoReturn

compute_jacobian_inverse(data)[source]

Compute Jacobian of the transformer.inverse_transform().

Parameters

data (numpy.ndarray) – The data where the Jacobian is to be computed.

Returns

The Jacobian matrix.

Return type

NoReturn

duplicate()

Duplicate the current object.

Returns

A deepcopy of the current instance.

Return type

gemseo.mlearning.transform.transformer.Transformer

fit(data, *args)

Fit the transformer to the data.

Parameters
Return type

NoReturn

fit_transform(data, *args)

Fit the transformer to the data and transform the data.

Parameters
Returns

The transformed data.

Return type

numpy.ndarray

inverse_transform(data)[source]

Perform an inverse transform on the data.

Parameters

data (numpy.ndarray) – The data to be inverse transformed.

Returns

The inverse transformed data.

Return type

numpy.ndarray

transform(data)[source]

Transform the data.

Parameters

data (numpy.ndarray) – The data to be transformed.

Returns

The transformed data.

Return type

numpy.ndarray

CROSSED = True
property n_components: int

The number of components.

name: str

The name of the transformer.

parameters: str

The parameters of the transformer.