This documentation is for scikit-learn version 0.10Other versions

Citing

If you use the software, please consider citing scikit-learn.

This page

8.5.9. sklearn.decomposition.MiniBatchSparsePCA

class sklearn.decomposition.MiniBatchSparsePCA(n_components, alpha=1, ridge_alpha=0.01, n_iter=100, callback=None, chunk_size=3, verbose=False, shuffle=True, n_jobs=1, method='lars', random_state=None)

Mini-batch Sparse Principal Components Analysis

Finds the set of sparse components that can optimally reconstruct the data. The amount of sparseness is controllable by the coefficient of the L1 penalty, given by the parameter alpha.

Parameters :

n_components : int,

number of sparse atoms to extract

alpha : int,

Sparsity controlling parameter. Higher values lead to sparser components.

ridge_alpha : float,

Amount of ridge shrinkage to apply in order to improve conditioning when calling the transform method.

n_iter : int,

number of iterations to perform for each mini batch

callback : callable,

callable that gets invoked every five iterations

chunk_size : int,

the number of features to take in each mini batch

verbose : :

degree of output the procedure will print

shuffle : boolean,

whether to shuffle the data before splitting it in batches

n_jobs : int,

number of parallel jobs to run, or -1 to autodetect.

method : {‘lars’, ‘cd’}

lars: uses the least angle regression method to solve the lasso problem (linear_model.lars_path) cd: uses the coordinate descent method to compute the Lasso solution (linear_model.Lasso). Lars will be faster if the estimated components are sparse.

random_state : int or RandomState

Pseudo number generator state used for random sampling.

Attributes

components_ array, [n_components, n_features] Sparse components extracted from the data.
error_ array Vector of errors at each iteration.

Methods

fit(X[, y]) Fit the model from data in X.
fit_transform(X[, y]) Fit to data, then transform it
set_params(**params) Set the parameters of the estimator.
transform(X[, ridge_alpha]) Least Squares projection of the data onto the sparse components.
__init__(n_components, alpha=1, ridge_alpha=0.01, n_iter=100, callback=None, chunk_size=3, verbose=False, shuffle=True, n_jobs=1, method='lars', random_state=None)
fit(X, y=None)

Fit the model from data in X.

Parameters :

X: array-like, shape (n_samples, n_features) :

Training vector, where n_samples in the number of samples and n_features is the number of features.

Returns :

self : object

Returns the instance itself.

fit_transform(X, y=None, **fit_params)

Fit to data, then transform it

Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.

Parameters :

X : numpy array of shape [n_samples, n_features]

Training set.

y : numpy array of shape [n_samples]

Target values.

Returns :

X_new : numpy array of shape [n_samples, n_features_new]

Transformed array.

Notes

This method just calls fit and transform consecutively, i.e., it is not an optimized implementation of fit_transform, unlike other transformers such as PCA.

set_params(**params)

Set the parameters of the estimator.

The method works on simple estimators as well as on nested objects (such as pipelines). The former have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Returns :self :
transform(X, ridge_alpha=None)

Least Squares projection of the data onto the sparse components.

To avoid instability issues in case the system is under-determined, regularization can be applied (Ridge regression) via the ridge_alpha parameter.

Note that Sparse PCA components orthogonality is not enforced as in PCA hence one cannot use a simple linear projection.

Parameters :

X: array of shape (n_samples, n_features) :

Test data to be transformed, must have the same number of features as the data used to train the model.

ridge_alpha: float, default: 0.01 :

Amount of ridge shrinkage to apply in order to improve conditioning.

Returns :

X_new array, shape (n_samples, n_components) :

Transformed data.