LassoCV#

classsklearn.linear_model.LassoCV(*,eps=0.001,n_alphas='deprecated',alphas='warn',fit_intercept=True,precompute='auto',max_iter=1000,tol=0.0001,copy_X=True,cv=None,verbose=False,n_jobs=None,positive=False,random_state=None,selection='cyclic')[source]#

Lasso linear model with iterative fitting along a regularization path.

See glossary entry forcross-validation estimator.

The best model is selected by cross-validation.

The optimization objective for Lasso is:

(1/(2*n_samples))*||y-Xw||^2_2+alpha*||w||_1

Read more in theUser Guide.

Parameters:
epsfloat, default=1e-3

Length of the path.eps=1e-3 means thatalpha_min/alpha_max=1e-3.

n_alphasint, default=100

Number of alphas along the regularization path.

Deprecated since version 1.7:n_alphas was deprecated in 1.7 and will be removed in 1.9. Usealphasinstead.

alphasarray-like or int, default=None

Values of alphas to test along the regularization path.If int,alphas values are generated automatically.If array-like, list of alpha values to use.

Changed in version 1.7:alphas accepts an integer value which removes the need to passn_alphas.

Deprecated since version 1.7:alphas=None was deprecated in 1.7 and will be removed in 1.9, at whichpoint the default value will be set to 100.

fit_interceptbool, default=True

Whether to calculate the intercept for this model. If setto false, no intercept will be used in calculations(i.e. data is expected to be centered).

precompute‘auto’, bool or array-like of shape (n_features, n_features), default=’auto’

Whether to use a precomputed Gram matrix to speed upcalculations. If set to'auto' let us decide. The Grammatrix can also be passed as argument.

max_iterint, default=1000

The maximum number of iterations.

tolfloat, default=1e-4

The tolerance for the optimization: if the updates aresmaller thantol, the optimization code checks thedual gap for optimality and continues until it is smallerthantol.

copy_Xbool, default=True

IfTrue, X will be copied; else, it may be overwritten.

cvint, cross-validation generator or iterable, default=None

Determines the cross-validation splitting strategy.Possible inputs for cv are:

  • None, to use the default 5-fold cross-validation,

  • int, to specify the number of folds.

  • CV splitter,

  • An iterable yielding (train, test) splits as arrays of indices.

For int/None inputs,KFold is used.

ReferUser Guide for the variouscross-validation strategies that can be used here.

Changed in version 0.22:cv default value if None changed from 3-fold to 5-fold.

verbosebool or int, default=False

Amount of verbosity.

n_jobsint, default=None

Number of CPUs to use during the cross validation.None means 1 unless in ajoblib.parallel_backend context.-1 means using all processors. SeeGlossaryfor more details.

positivebool, default=False

If positive, restrict regression coefficients to be positive.

random_stateint, RandomState instance, default=None

The seed of the pseudo random number generator that selects a randomfeature to update. Used whenselection == ‘random’.Pass an int for reproducible output across multiple function calls.SeeGlossary.

selection{‘cyclic’, ‘random’}, default=’cyclic’

If set to ‘random’, a random coefficient is updated every iterationrather than looping over features sequentially by default. This(setting to ‘random’) often leads to significantly faster convergenceespecially when tol is higher than 1e-4.

Attributes:
alpha_float

The amount of penalization chosen by cross validation.

coef_ndarray of shape (n_features,) or (n_targets, n_features)

Parameter vector (w in the cost function formula).

intercept_float or ndarray of shape (n_targets,)

Independent term in decision function.

mse_path_ndarray of shape (n_alphas, n_folds)

Mean square error for the test set on each fold, varying alpha.

alphas_ndarray of shape (n_alphas,)

The grid of alphas used for fitting.

dual_gap_float or ndarray of shape (n_targets,)

The dual gap at the end of the optimization for the optimal alpha(alpha_).

n_iter_int

Number of iterations run by the coordinate descent solver to reachthe specified tolerance for the optimal alpha.

n_features_in_int

Number of features seen duringfit.

Added in version 0.24.

feature_names_in_ndarray of shape (n_features_in_,)

Names of features seen duringfit. Defined only whenXhas feature names that are all strings.

Added in version 1.0.

See also

lars_path

Compute Least Angle Regression or Lasso path using LARS algorithm.

lasso_path

Compute Lasso path with coordinate descent.

Lasso

The Lasso is a linear model that estimates sparse coefficients.

LassoLars

Lasso model fit with Least Angle Regression a.k.a. Lars.

LassoCV

Lasso linear model with iterative fitting along a regularization path.

LassoLarsCV

Cross-validated Lasso using the LARS algorithm.

Notes

Infit, once the best parameteralpha is found throughcross-validation, the model is fit again using the entire training set.

To avoid unnecessary memory duplication theX argument of thefitmethod should be directly passed as a Fortran-contiguous numpy array.

For an example, seeexamples/linear_model/plot_lasso_model_selection.py.

LassoCV leads to different results than a hyperparametersearch usingGridSearchCV with aLasso model. InLassoCV, a model for a givenpenaltyalpha is warm started using the coefficients of theclosest model (trained at the previous iteration) on theregularization path. It tends to speed up the hyperparametersearch.

Examples

>>>fromsklearn.linear_modelimportLassoCV>>>fromsklearn.datasetsimportmake_regression>>>X,y=make_regression(noise=4,random_state=0)>>>reg=LassoCV(cv=5,random_state=0).fit(X,y)>>>reg.score(X,y)0.9993>>>reg.predict(X[:1,])array([-78.4951])
fit(X,y,sample_weight=None,**params)[source]#

Fit Lasso model with coordinate descent.

Fit is on grid of alphas and best alpha estimated by cross-validation.

Parameters:
X{array-like, sparse matrix} of shape (n_samples, n_features)

Training data. Pass directly as Fortran-contiguous datato avoid unnecessary memory duplication. If y is mono-output,X can be sparse. Note that large sparse matrices and arraysrequiringint64 indices are not accepted.

yarray-like of shape (n_samples,)

Target values.

sample_weightfloat or array-like of shape (n_samples,), default=None

Sample weights used for fitting and evaluation of the weightedmean squared error of each cv-fold. Note that the cross validatedMSE that is finally used to find the best model is the unweightedmean over the (weighted) MSEs of each test fold.

**paramsdict, default=None

Parameters to be passed to the CV splitter.

Added in version 1.4:Only available ifenable_metadata_routing=True,which can be set by usingsklearn.set_config(enable_metadata_routing=True).SeeMetadata Routing User Guide formore details.

Returns:
selfobject

Returns an instance of fitted model.

get_metadata_routing()[source]#

Get metadata routing of this object.

Please checkUser Guide on how the routingmechanism works.

Added in version 1.4.

Returns:
routingMetadataRouter

AMetadataRouter encapsulatingrouting information.

get_params(deep=True)[source]#

Get parameters for this estimator.

Parameters:
deepbool, default=True

If True, will return the parameters for this estimator andcontained subobjects that are estimators.

Returns:
paramsdict

Parameter names mapped to their values.

staticpath(X,y,*,eps=0.001,n_alphas=100,alphas=None,precompute='auto',Xy=None,copy_X=True,coef_init=None,verbose=False,return_n_iter=False,positive=False,**params)[source]#

Compute Lasso path with coordinate descent.

The Lasso optimization function varies for mono and multi-outputs.

For mono-output tasks it is:

(1/(2*n_samples))*||y-Xw||^2_2+alpha*||w||_1

For multi-output tasks it is:

(1/(2*n_samples))*||Y-XW||^2_Fro+alpha*||W||_21

Where:

||W||_21= \sum_i \sqrt{\sum_jw_{ij}^2}

i.e. the sum of norm of each row.

Read more in theUser Guide.

Parameters:
X{array-like, sparse matrix} of shape (n_samples, n_features)

Training data. Pass directly as Fortran-contiguous data to avoidunnecessary memory duplication. Ify is mono-output thenXcan be sparse.

y{array-like, sparse matrix} of shape (n_samples,) or (n_samples, n_targets)

Target values.

epsfloat, default=1e-3

Length of the path.eps=1e-3 means thatalpha_min/alpha_max=1e-3.

n_alphasint, default=100

Number of alphas along the regularization path.

alphasarray-like, default=None

List of alphas where to compute the models.IfNone alphas are set automatically.

precompute‘auto’, bool or array-like of shape (n_features, n_features), default=’auto’

Whether to use a precomputed Gram matrix to speed upcalculations. If set to'auto' let us decide. The Grammatrix can also be passed as argument.

Xyarray-like of shape (n_features,) or (n_features, n_targets), default=None

Xy = np.dot(X.T, y) that can be precomputed. It is usefulonly when the Gram matrix is precomputed.

copy_Xbool, default=True

IfTrue, X will be copied; else, it may be overwritten.

coef_initarray-like of shape (n_features, ), default=None

The initial values of the coefficients.

verbosebool or int, default=False

Amount of verbosity.

return_n_iterbool, default=False

Whether to return the number of iterations or not.

positivebool, default=False

If set to True, forces coefficients to be positive.(Only allowed wheny.ndim==1).

**paramskwargs

Keyword arguments passed to the coordinate descent solver.

Returns:
alphasndarray of shape (n_alphas,)

The alphas along the path where models are computed.

coefsndarray of shape (n_features, n_alphas) or (n_targets, n_features, n_alphas)

Coefficients along the path.

dual_gapsndarray of shape (n_alphas,)

The dual gaps at the end of the optimization for each alpha.

n_iterslist of int

The number of iterations taken by the coordinate descent optimizer toreach the specified tolerance for each alpha.

See also

lars_path

Compute Least Angle Regression or Lasso path using LARS algorithm.

Lasso

The Lasso is a linear model that estimates sparse coefficients.

LassoLars

Lasso model fit with Least Angle Regression a.k.a. Lars.

LassoCV

Lasso linear model with iterative fitting along a regularization path.

LassoLarsCV

Cross-validated Lasso using the LARS algorithm.

sklearn.decomposition.sparse_encode

Estimator that can be used to transform signals into sparse linear combination of atoms from a fixed.

Notes

For an example, seeexamples/linear_model/plot_lasso_lasso_lars_elasticnet_path.py.

To avoid unnecessary memory duplication the X argument of the fit methodshould be directly passed as a Fortran-contiguous numpy array.

Note that in certain cases, the Lars solver may be significantlyfaster to implement this functionality. In particular, linearinterpolation can be used to retrieve model coefficients between thevalues output by lars_path

Examples

Comparing lasso_path and lars_path with interpolation:

>>>importnumpyasnp>>>fromsklearn.linear_modelimportlasso_path>>>X=np.array([[1,2,3.1],[2.3,5.4,4.3]]).T>>>y=np.array([1,2,3.1])>>># Use lasso_path to compute a coefficient path>>>_,coef_path,_=lasso_path(X,y,alphas=[5.,1.,.5])>>>print(coef_path)[[0.         0.         0.46874778] [0.2159048  0.4425765  0.23689075]]
>>># Now use lars_path and 1D linear interpolation to compute the>>># same path>>>fromsklearn.linear_modelimportlars_path>>>alphas,active,coef_path_lars=lars_path(X,y,method='lasso')>>>fromscipyimportinterpolate>>>coef_path_continuous=interpolate.interp1d(alphas[::-1],...coef_path_lars[:,::-1])>>>print(coef_path_continuous([5.,1.,.5]))[[0.         0.         0.46915237] [0.2159048  0.4425765  0.23668876]]
predict(X)[source]#

Predict using the linear model.

Parameters:
Xarray-like or sparse matrix, shape (n_samples, n_features)

Samples.

Returns:
Carray, shape (n_samples,)

Returns predicted values.

score(X,y,sample_weight=None)[source]#

Returncoefficient of determination on test data.

The coefficient of determination,\(R^2\), is defined as\((1 - \frac{u}{v})\), where\(u\) is the residualsum of squares((y_true-y_pred)**2).sum() and\(v\)is the total sum of squares((y_true-y_true.mean())**2).sum().The best possible score is 1.0 and it can be negative (because themodel can be arbitrarily worse). A constant model that always predictsthe expected value ofy, disregarding the input features, would geta\(R^2\) score of 0.0.

Parameters:
Xarray-like of shape (n_samples, n_features)

Test samples. For some estimators this may be a precomputedkernel matrix or a list of generic objects instead with shape(n_samples,n_samples_fitted), wheren_samples_fittedis the number of samples used in the fitting for the estimator.

yarray-like of shape (n_samples,) or (n_samples, n_outputs)

True values forX.

sample_weightarray-like of shape (n_samples,), default=None

Sample weights.

Returns:
scorefloat

\(R^2\) ofself.predict(X) w.r.t.y.

Notes

The\(R^2\) score used when callingscore on a regressor usesmultioutput='uniform_average' from version 0.23 to keep consistentwith default value ofr2_score.This influences thescore method of all the multioutputregressors (except forMultiOutputRegressor).

set_fit_request(*,sample_weight:bool|None|str='$UNCHANGED$')LassoCV[source]#

Configure whether metadata should be requested to be passed to thefit method.

Note that this method is only relevant when this estimator is used as asub-estimator within ameta-estimator and metadata routing is enabledwithenable_metadata_routing=True (seesklearn.set_config).Please check theUser Guide on how the routingmechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed tofit if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it tofit.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains theexisting request. This allows you to change the request for someparameters and not others.

Added in version 1.3.

Parameters:
sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing forsample_weight parameter infit.

Returns:
selfobject

The updated object.

set_params(**params)[source]#

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects(such asPipeline). The latter haveparameters of the form<component>__<parameter> so that it’spossible to update each component of a nested object.

Parameters:
**paramsdict

Estimator parameters.

Returns:
selfestimator instance

Estimator instance.

set_score_request(*,sample_weight:bool|None|str='$UNCHANGED$')LassoCV[source]#

Configure whether metadata should be requested to be passed to thescore method.

Note that this method is only relevant when this estimator is used as asub-estimator within ameta-estimator and metadata routing is enabledwithenable_metadata_routing=True (seesklearn.set_config).Please check theUser Guide on how the routingmechanism works.

The options for each parameter are:

  • True: metadata is requested, and passed toscore if provided. The request is ignored if metadata is not provided.

  • False: metadata is not requested and the meta-estimator will not pass it toscore.

  • None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

  • str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains theexisting request. This allows you to change the request for someparameters and not others.

Added in version 1.3.

Parameters:
sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing forsample_weight parameter inscore.

Returns:
selfobject

The updated object.

Gallery examples#

Combine predictors using stacking

Combine predictors using stacking

Common pitfalls in the interpretation of coefficients of linear models

Common pitfalls in the interpretation of coefficients of linear models

L1-based models for Sparse Signals

L1-based models for Sparse Signals

Lasso model selection: AIC-BIC / cross-validation

Lasso model selection: AIC-BIC / cross-validation