skfolio.moments.GraphicalLassoCV

class skfolio.moments.GraphicalLassoCV(alphas=4, n_refinements=4, cv=None, tol=0.0001, enet_tol=0.0001, max_iter=100, mode='cd', n_jobs=None, verbose=False, assume_centered=False, nearest=True, higham=False, higham_max_iteration=100)

Sparse inverse covariance with cross-validated choice of the l1 penalty.

Read more in scikit-learn.

Parameters:

alphasint or array-like of shape (n_alphas,), dtype=float, default=4

If an integer is given, it fixes the number of points on the grids of alpha to be used. If a list is given, it gives the grid to be used. See the notes in the class docstring for more details. Range is [1, inf) for an integer. Range is (0, inf] for an array-like of floats.

n_refinementsint, default=4

The number of times the grid is refined. Not used if explicit values of alphas are passed. Range is [1, inf).

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,

• integer, to specify the number of folds.

• CV splitter,

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

For integer/None inputs KFold is used.

tolfloat, default=1e-4

The tolerance to declare convergence: if the dual gap goes below this value, iterations are stopped. Range is (0, inf].

enet_tolfloat, default=1e-4

The tolerance for the elastic net solver used to calculate the descent direction. This parameter controls the accuracy of the search direction for a given column update, not of the overall parameter estimate. Only used for mode=’cd’. Range is (0, inf].

max_iterint, default=100

Maximum number of iterations.

mode{‘cd’, ‘lars’}, default=’cd’

The Lasso solver to use: coordinate descent or LARS. Use LARS for very sparse underlying graphs, where number of features is greater than number of samples. Elsewhere prefer cd which is more numerically stable.

n_jobsint, default=None

Number of jobs to run in parallel. None means 1 unless in a joblib.parallel_backend context. -1 means using all processors.

verbosebool, default=False

If verbose is True, the objective function and duality gap are printed at each iteration.

assume_centeredbool, default=False

If True, data are not centered before computation. Useful when working with data whose mean is almost, but not exactly zero. If False, data are centered before computation.

Attributes:

covariance_ndarray of shape (n_assets, n_assets)

Estimated covariance.

location_ndarray of shape (n_assets,)

Estimated location, i.e. the estimated mean.

precision_ndarray of shape (n_assets, n_assets)

Estimated pseudo inverse matrix. (stored only if store_precision is True)

alpha_float

Penalization parameter selected.

cv_results_dict of ndarrays

A dict with keys:

alphasndarray of shape (n_alphas,)

All penalization parameters explored.

split(k)_test_scorendarray of shape (n_alphas,)

Log-likelihood score on left-out data across (k)th fold.

Added in version 1.0.

mean_test_scorendarray of shape (n_alphas,)

Mean of scores over the folds.

Added in version 1.0.

std_test_scorendarray of shape (n_alphas,)

Standard deviation of scores over the folds.

Added in version 1.0.

n_iter_int

Number of iterations run for the optimal alpha.

n_features_in_int

Number of assets seen during fit.

feature_names_in_ndarray of shape (n_features_in_,)

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

Notes

The search for the optimal penalization parameter (alpha) is done on an iteratively refined grid: first the cross-validated scores on a grid are computed, then a new refined grid is centered around the maximum, and so on.

One of the challenges which is faced here is that the solvers can fail to converge to a well-conditioned estimate. The corresponding values of alpha then come out as missing values, but the optimum may be close to these missing values.

In fit, once the best parameter alpha is found through cross-validation, the model is fit again using the entire training set.

Methods

error_norm(comp_cov[, norm, scaling, squared])	Compute the Mean Squared Error between two covariance estimators.
fit(X[, y])	Fit the GraphicalLasso covariance model to X.
get_metadata_routing()	Get metadata routing of this object.
get_params([deep])	Get parameters for this estimator.
get_precision()	Getter for the precision matrix.
mahalanobis(X)	Compute the squared Mahalanobis distances of given observations.
score(X_test[, y])	Compute the log-likelihood of X_test under the estimated Gaussian model.
set_params(**params)	Set the parameters of this estimator.
set_score_request(*[, X_test])	Request metadata passed to the score method.

error_norm(comp_cov, norm='frobenius', scaling=True, squared=True)

Compute the Mean Squared Error between two covariance estimators.

Parameters:

comp_covarray-like of shape (n_features, n_features)

The covariance to compare with.

norm{“frobenius”, “spectral”}, default=”frobenius”

The type of norm used to compute the error. Available error types: - ‘frobenius’ (default): sqrt(tr(A^t.A)) - ‘spectral’: sqrt(max(eigenvalues(A^t.A)) where A is the error (comp_cov - self.covariance_).

scalingbool, default=True

If True (default), the squared error norm is divided by n_features. If False, the squared error norm is not rescaled.

squaredbool, default=True

Whether to compute the squared error norm or the error norm. If True (default), the squared error norm is returned. If False, the error norm is returned.

Returns:

resultfloat

The Mean Squared Error (in the sense of the Frobenius norm) between self and comp_cov covariance estimators.

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

Fit the GraphicalLasso covariance model to X.

Parameters:

Xarray-like of shape (n_observations, n_assets)

Price returns of the assets.

yIgnored

Not used, present for API consistency by convention.

Returns:

selfGraphicalLassoCV

Fitted estimator.

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Added in version 1.5.

Returns:

routingMetadataRouter

A MetadataRouter encapsulating routing information.

get_params(deep=True)

Get parameters for this estimator.

Parameters:

deepbool, default=True

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

Returns:

paramsdict

Parameter names mapped to their values.

get_precision()

Getter for the precision matrix.

Returns:

precision_array-like of shape (n_features, n_features)

The precision matrix associated to the current covariance object.

mahalanobis(X)

Compute the squared Mahalanobis distances of given observations.

Parameters:

Xarray-like of shape (n_samples, n_features)

The observations, the Mahalanobis distances of the which we compute. Observations are assumed to be drawn from the same distribution than the data used in fit.

Returns:

distndarray of shape (n_samples,)

Squared Mahalanobis distances of the observations.

score(X_test, y=None)

Compute the log-likelihood of X_test under the estimated Gaussian model.

The Gaussian model is defined by its mean and covariance matrix which are represented respectively by self.location_ and self.covariance_.

Parameters:

X_testarray-like of shape (n_samples, n_features)

Test data of which we compute the likelihood, where n_samples is the number of samples and n_features is the number of features. X_test is assumed to be drawn from the same distribution than the data used in fit (including centering).

yIgnored

Not used, present for API consistency by convention.

Returns:

resfloat

The log-likelihood of X_test with self.location_ and self.covariance_ as estimators of the Gaussian model mean and covariance matrix respectively.

set_params(**params)

Set the parameters of this estimator.

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

Parameters:

**paramsdict

Estimator parameters.

Returns:

selfestimator instance

Estimator instance.

set_score_request(*, X_test='$UNCHANGED$')

Request metadata passed to the score method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

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

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

• 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 the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:

X_teststr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for X_test parameter in score.

Returns:

selfobject

The updated object.