`sklearn.covariance`.LedoitWolf¶

class sklearn.covariance.LedoitWolf¶

Estimador Ledoit-Wolf

Ledoit-Wolf es una forma particular de reducción, donde el coeficiente de reducción se calcula usando la formula de O. Ledoit y M. Wolf como fue descrita en «A Well-Conditioned Estimator for Large-Dimensional Covariance Matrices», Ledoit and Wolf, Journal of Multivariate Analysis, Volume 88, Issue 2, February 2004, pages 365-411.

Más información en el Manual de usuario.

Parámetros

store_precisionbooleano, default=True: Especifica si se almacena la precisión estimada.
assume_centeredbooleano, default=False: Si es True, los datos no se centrarán antes del calculó. Útil al trabajar con datos cuya media es casí, pero no igual a cero. Si es False (predeterminado), los datos se centrarán antes del cálculo.
block_sizeint, default=1000: Tamaño de los bloques en los que se dividirá la matriz de covarianza durante su estimación Ledoit-Wolf. Esto es solamente una optimización de la memoria y no afecta a los resultados.

Atributos

covariance_ndarray de forma (n_features, n_features): Matriz de covarianza estimada.
location_ndarray de forma (n_features,): Ubicación estimada, es decir, la media estimada.
precision_ndarray de forma (n_features, n_features): Matriz pseudo inversa estimada. (almacenada sólo si store_precision es True)
shrinkage_float: Coeficiente en la combinación convex utilizada para el cálculo de la estimación reducida. Su rango es [0, 1].

Notas

La covarianza regularizada es:

(1 - shrinkage) * cov + shrinkage * mu * np.identity(n_features)

donde mu = trace(cov) / n_features y la reducción es dada por la fórmula Ledoit y Wolf (ver referencias)

Referencias

«A Well-Conditioned Estimator for Large-Dimensional Covariance Matrices», Ledoit and Wolf, Journal of Multivariate Analysis, Volume 88, Issue 2, February 2004, pages 365-411.

Ejemplos

>>> import numpy as np
>>> from sklearn.covariance import LedoitWolf
>>> real_cov = np.array([[.4, .2],
...                      [.2, .8]])
>>> np.random.seed(0)
>>> X = np.random.multivariate_normal(mean=[0, 0],
...                                   cov=real_cov,
...                                   size=50)
>>> cov = LedoitWolf().fit(X)
>>> cov.covariance_
array([[0.4406..., 0.1616...],
       [0.1616..., 0.8022...]])
>>> cov.location_
array([ 0.0595... , -0.0075...])

Métodos

`error_norm`	Calcula el Error Cuadrático Medio entre dos estimadores de covarianza.
`fit`	Encaja el modelo de covarianza reducida Ledoit-Wolf de acuerdo a los datos de entrenamiento y parámetros dados.
`get_params`	Obtiene los parámetros para este estimador.
`get_precision`	Colector para la matriz de precisión.
`mahalanobis`	Calcula las distancias de mahalanobis cuadráticas de las observaciones dadas.
`score`	Calcula el logaritmo de la verosimilitud de un conjunto de datos Gaussiano con `self.covariance_` como un estimador de su matriz de covarianza.
`set_params`	Establece los parámetros de este estimador.

error_norm()¶

Calcula el Error Cuadrático Medio entre dos estimadores de covarianza. (En el sentido de la norma Frobenius).

Parámetros

comp_covarray-like de forma (n_features, n_features): La covarianza con la cual se compara.
norm{«frobenius», «spectral»}, default=»frobenius»: El tipo de norma utilizada para calcular el error. Tipos de error disponibles: - “frobenius” (predeterminado): sqrt(tr(A^t.)) - “spectral”: sqrt(max(eigenvalues(A^t.A)) donde A es el error (comp_cov - self.covariance_).
scalingbooleano, default=True: Si es True (predeterminado), la norma de error cuadrático es dividida por n_features. Si es False, la norma de error cuadrático no es reescalada.
squaredbooleano, default=True: Si se calcula la norma de error cuadrático o la norma de error. Si es True (predeterminado) se devuelve la norma de error cuadrático. Si es False, se devuelve la norma de error.

Devuelve

resultfloat: El Error Cuadrático Medio (en el sentido de la norma Frobenius) entre los estimadores de covarianza self y comp_cov.

fit()¶

Encaja el modelo de covarianza reducida Ledoit-Wolf de acuerdo a los datos de entrenamiento y parámetros dados.

Parámetros

Xarray-like de forma (n_samples, n_features): Datos de entrenamiento, donde n_samples es el número de muestras y n_features es el número de características.
yIgnorado: No se utiliza, está presente para la coherencia de la API por convención.

Devuelve

selfobjeto

get_params()¶

Obtiene los parámetros para este estimador.

Parámetros

deepbooleano, default=True: Si es True, devolverá los parámetros para este estimador y los subobjetos contenidos que son estimadores.

Devuelve

paramsdict: Nombres de parámetros asignados a sus valores.

get_precision()¶

Colector para la matriz de precisión.

Devuelve

precision_array-like de forma (n_features, n_features): La matriz de precisión asociada al objeto de covariancia actual.

mahalanobis()¶

Calcula las distancias de mahalanobis cuadráticas de las observaciones dadas.

Parámetros

Xarray-like de forma (n_samples, n_features): Las observaciones, las distancias Mahalanobis de lo que calculamos. Se asume que las observaciones se extraen de la misma distribución que utilizaron los datos en el ajuste.

Devuelve

distndarray de forma (n_samples,): Distancias de Mahalanobis cuadráticas de las observaciones.

score()¶

Calcula el logaritmo de la verosimilitud de un conjunto de datos Gaussiano con self.covariance_ como un estimador de su matriz de covarianza.

Parámetros

X_testarray-like de forma (n_samples, n_features): Los datos de prueba para los cuales calculamos la verosimilitud, donde n_samples es el número de muestras y n_features es el número de características. Se asume que X_test se extrae de la misma distribución que los datos utilizados en fit (incluyendo el centrado).
yIgnorado: No se utiliza, está presente para la coherencia de la API por convención.

Devuelve

resfloat: La probabilidad del conjunto de datos con self.covariance_ como un estimador de su matriz de covarianza.

set_params()¶

Establece los parámetros de este estimador.

El método funciona tanto en estimadores simples como en objetos anidados (como Pipeline). Estos últimos tienen parámetros de la forma <component>__<parameter> para que sea posible actualizar cada componente de un objeto anidado.

Parámetros

**paramsdict: Parámetros del estimador.

Devuelve

selfinstancia de estimador: Instancia del estimador.