Documentation
Classes
SparsePCA

SparsePCA

Sparse Principal Components Analysis (SparsePCA).

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.

Read more in the User Guide.

Python Reference (opens in a new tab)

Constructors

constructor()

Signature

new SparsePCA(opts?: object): SparsePCA;

Parameters

NameTypeDescription
opts?object-
opts.U_init?ArrayLike[]Initial values for the loadings for warm restart scenarios. Only used if U\_init and V\_init are not undefined.
opts.V_init?ArrayLike[]Initial values for the components for warm restart scenarios. Only used if U\_init and V\_init are not undefined.
opts.alpha?numberSparsity controlling parameter. Higher values lead to sparser components. Default Value 1
opts.max_iter?numberMaximum number of iterations to perform. Default Value 1000
opts.method?"cd" | "lars"Method to be used for optimization. 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. Default Value 'lars'
opts.n_components?numberNumber of sparse atoms to extract. If undefined, then n\_components is set to n\_features.
opts.n_jobs?numberNumber of parallel jobs to run. undefined means 1 unless in a joblib.parallel\_backend (opens in a new tab) context. \-1 means using all processors. See Glossary for more details.
opts.random_state?numberUsed during dictionary learning. Pass an int for reproducible results across multiple function calls. See Glossary.
opts.ridge_alpha?numberAmount of ridge shrinkage to apply in order to improve conditioning when calling the transform method. Default Value 0.01
opts.tol?numberTolerance for the stopping condition. Default Value 1e-8
opts.verbose?number | booleanControls the verbosity; the higher, the more messages. Defaults to 0. Default Value false

Returns

SparsePCA

Defined in: generated/decomposition/SparsePCA.ts:25 (opens in a new tab)

Methods

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/decomposition/SparsePCA.ts:161 (opens in a new tab)

fit()

Fit the model from data in X.

Signature

fit(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Training vector, where n\_samples is the number of samples and n\_features is the number of features.
opts.y?anyNot used, present here for API consistency by convention.

Returns

Promise<any>

Defined in: generated/decomposition/SparsePCA.ts:178 (opens in a new tab)

fit_transform()

Fit to data, then transform it.

Fits transformer to X and y with optional parameters fit\_params and returns a transformed version of X.

Signature

fit_transform(opts: object): Promise<any[]>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Input samples.
opts.fit_params?anyAdditional fit parameters.
opts.y?ArrayLikeTarget values (undefined for unsupervised transformations).

Returns

Promise<any[]>

Defined in: generated/decomposition/SparsePCA.ts:218 (opens in a new tab)

get_feature_names_out()

Get output feature names for transformation.

The feature names out will prefixed by the lowercased class name. For example, if the transformer outputs 3 features, then the feature names out are: \["class\_name0", "class\_name1", "class\_name2"\].

Signature

get_feature_names_out(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.input_features?anyOnly used to validate feature names with the names seen in fit.

Returns

Promise<any>

Defined in: generated/decomposition/SparsePCA.ts:267 (opens in a new tab)

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Signature

get_metadata_routing(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.routing?anyA MetadataRequest encapsulating routing information.

Returns

Promise<any>

Defined in: generated/decomposition/SparsePCA.ts:305 (opens in a new tab)

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

NameType
pyPythonBridge

Returns

Promise<void>

Defined in: generated/decomposition/SparsePCA.ts:110 (opens in a new tab)

inverse_transform()

Transform data from the latent space to the original space.

This inversion is an approximation due to the loss of information induced by the forward decomposition.

Signature

inverse_transform(opts: object): Promise<ArrayLike[]>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Data in the latent space.

Returns

Promise<ArrayLike[]>

Defined in: generated/decomposition/SparsePCA.ts:342 (opens in a new tab)

set_output()

Set output container.

See Introducing the set_output API for an example on how to use the API.

Signature

set_output(opts: object): Promise<any>;

Parameters

NameTypeDescription
optsobject-
opts.transform?"default" | "pandas"Configure output of transform and fit\_transform.

Returns

Promise<any>

Defined in: generated/decomposition/SparsePCA.ts:377 (opens in a new tab)

transform()

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.

Signature

transform(opts: object): Promise<ArrayLike[]>;

Parameters

NameTypeDescription
optsobject-
opts.X?ArrayLike[]Test data to be transformed, must have the same number of features as the data used to train the model.

Returns

Promise<ArrayLike[]>

Defined in: generated/decomposition/SparsePCA.ts:414 (opens in a new tab)

Properties

_isDisposed

boolean = false

Defined in: generated/decomposition/SparsePCA.ts:23 (opens in a new tab)

_isInitialized

boolean = false

Defined in: generated/decomposition/SparsePCA.ts:22 (opens in a new tab)

_py

PythonBridge

Defined in: generated/decomposition/SparsePCA.ts:21 (opens in a new tab)

id

string

Defined in: generated/decomposition/SparsePCA.ts:18 (opens in a new tab)

opts

any

Defined in: generated/decomposition/SparsePCA.ts:19 (opens in a new tab)

Accessors

components_

Sparse components extracted from the data.

Signature

components_(): Promise<ArrayLike[]>;

Returns

Promise<ArrayLike[]>

Defined in: generated/decomposition/SparsePCA.ts:447 (opens in a new tab)

error_

Vector of errors at each iteration.

Signature

error_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/decomposition/SparsePCA.ts:470 (opens in a new tab)

feature_names_in_

Names of features seen during fit. Defined only when X has feature names that are all strings.

Signature

feature_names_in_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/decomposition/SparsePCA.ts:589 (opens in a new tab)

mean_

Per-feature empirical mean, estimated from the training set. Equal to X.mean(axis=0).

Signature

mean_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/decomposition/SparsePCA.ts:541 (opens in a new tab)

n_components_

Estimated number of components.

Signature

n_components_(): Promise<number>;

Returns

Promise<number>

Defined in: generated/decomposition/SparsePCA.ts:493 (opens in a new tab)

n_features_in_

Number of features seen during fit.

Signature

n_features_in_(): Promise<number>;

Returns

Promise<number>

Defined in: generated/decomposition/SparsePCA.ts:564 (opens in a new tab)

n_iter_

Number of iterations run.

Signature

n_iter_(): Promise<number>;

Returns

Promise<number>

Defined in: generated/decomposition/SparsePCA.ts:518 (opens in a new tab)

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/decomposition/SparsePCA.ts:97 (opens in a new tab)

Signature

py(pythonBridge: PythonBridge): void;

Parameters

NameType
pythonBridgePythonBridge

Returns

void

Defined in: generated/decomposition/SparsePCA.ts:101 (opens in a new tab)