LedoitWolf

classsklearn.covariance.LedoitWolf(*, store_precision=True, assume_centered=False, block_size=1000)[источник]

Оцениватель LedoitWolf.

Оцениватель Ledoit-Wolf — это особая разновидность регуляризации с усадкой, коэффициент которой вычисляется по формуле O. Ledoit и M. Wolf, описанной в статье «A Well-Conditioned Estimator for Large-Dimensional Covariance Matrices», Ledoit and Wolf, Journal of Multivariate Analysis, том 88, выпуск 2, февраль 2004 года, страницы 365–411.

Подробнее см. в руководстве пользователя.

Параметры:

store_precisionbool, по умолчанию=True

Указывает, следует ли сохранять оценённую матрицу точности.

assume_centeredbool, по умолчанию=False

Если True, данные не будут центрироваться перед вычислением. Полезно при работе с данными, среднее значение которых почти, но не в точности равно нулю. Если False (значение по умолчанию), данные будут центрироваться перед вычислением.

block_sizeint, по умолчанию=1000

Размер блоков, на которые разбивается матрица ковариации при оценивании методом Ledoit-Wolf. Это лишь оптимизация использования памяти, не влияющая на результаты.

Атрибуты:

covariance_ndarray формы (n_features, n_features)

Оценённая матрица ковариации.

location_ndarray формы (n_features,)

Оценённое положение, то есть оценённое среднее значение.

precision_ndarray формы (n_features, n_features)

Оценённая псевдообратная матрица. (Сохраняется, только если store_precision равно True.)

shrinkage_float

Коэффициент в выпуклой комбинации, используемой для вычисления оценки с усадкой. Диапазон значений — [0, 1].

n_features_in_int

Количество признаков, обнаруженных во время обучения.

Добавлено в версии 0.24.

feature_names_in_ndarray формы (n_features_in_,)

Названия признаков, обнаруженных во время обучения. Определяется, только если X содержит названия признаков, представленные строками.

Добавлено в версии 1.0.

См. также

EllipticEnvelope

Объект для обнаружения выбросов в наборах данных с гауссовым распределением.

EmpiricalCovariance

Оцениватель ковариации методом максимального правдоподобия.

GraphicalLasso

Разреженное оценивание обратной ковариации с помощью оценивателя с l1-регуляризацией.

GraphicalLassoCV

Разреженная обратная ковариация с выбором параметра l1-регуляризации посредством перекрёстной проверки.

MinCovDet

Определитель минимальной ковариации (робастный оцениватель ковариации).

OAS

Оцениватель усадки с оракельным приближением.

ShrunkCovariance

Оцениватель ковариации с усадкой.

Примечания

Регуляризованная ковариация имеет вид:

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

где mu = trace(cov) / n_features, а shrinkage вычисляется по формуле Ledoit и Wolf (см. раздел «Литература»).

Литература

«A Well-Conditioned Estimator for Large-Dimensional Covariance Matrices», Ledoit and Wolf, Journal of Multivariate Analysis, том 88, выпуск 2, февраль 2004 года, страницы 365–411.

Примеры

>>> 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])

Дополнительные примеры см. в разделах Оценивание ковариации с усадкой: LedoitWolf, OAS и максимальное правдоподобие и Оценивание Ledoit-Wolf и OAS.

error_norm(comp_cov, norm='frobenius', scaling=True, squared=True)[источник]

Вычисляет среднеквадратичную ошибку между двумя оценивателями ковариации.

Параметры:

comp_covarray-like формы (n_features, n_features)

Матрица ковариации для сравнения.

norm{“frobenius”, “spectral”}, по умолчанию=”frobenius”

Тип нормы, используемой для вычисления ошибки. Доступные типы ошибки: - ‘frobenius’ (по умолчанию): sqrt(tr(A^t.A)) - ‘spectral’: sqrt(max(eigenvalues(A^t.A)), где A — матрица ошибки (comp_cov - self.covariance_).

scalingbool, по умолчанию=True

Если True (значение по умолчанию), квадрат нормы ошибки делится на n_features. Если False, квадрат нормы ошибки не масштабируется.

squaredbool, по умолчанию=True

Определяет, вычислять ли квадрат нормы ошибки или саму норму ошибки. Если True (значение по умолчанию), возвращается квадрат нормы ошибки. Если False, возвращается норма ошибки.

Возвращает:

resultfloat

Среднеквадратичная ошибка (в смысле нормы Фробениуса) между оценивателями ковариации self и comp_cov.

fit(X, y=None)[источник]

Обучает модель ковариации с усадкой Ledoit-Wolf на данных X.

Параметры:

Xarray-like формы (n_samples, n_features)

Обучающие данные, где n_samples — количество объектов, а n_features — количество признаков.

yИгнорируется

Не используется; присутствует для согласованности API согласно принятому соглашению.

Возвращает:

selfobject

Возвращает сам экземпляр объекта.

get_metadata_routing()[источник]

Получает маршрутизацию метаданных этого объекта.

О том, как работает механизм маршрутизации, см. в руководстве пользователя.

Возвращает:

routingMetadataRequest

Объект MetadataRequest, содержащий информацию о маршрутизации.

get_params(deep=True)[источник]

Получает параметры этого оценивателя.

Параметры:

deepbool, по умолчанию=True

Если True, возвращает параметры этого оценивателя и содержащихся в нём подчинённых объектов, являющихся оценивателями.

Возвращает:

paramsdict

Имена параметров и соответствующие им значения.

get_precision()[источник]

Возвращает матрицу точности.

Возвращает:

precision_array-like формы (n_features, n_features)

Матрица точности, связанная с текущим объектом ковариации.

mahalanobis(X)[источник]

Вычисляет квадраты расстояний Махаланобиса для заданных наблюдений.

Подробный пример влияния выбросов на расстояние Махаланобиса см. в разделе Робастное оценивание ковариации и значимость расстояний Махаланобиса.

Параметры:

Xarray-like формы (n_samples, n_features)

Наблюдения, для которых вычисляются расстояния Махаланобиса. Предполагается, что наблюдения получены из того же распределения, что и данные, использованные при обучении.

Возвращает:

distndarray формы (n_samples,)

Квадраты расстояний Махаланобиса для наблюдений.

score(X_test, y=None)[источник]

Вычисляет логарифм правдоподобия X_test в соответствии с оценённой гауссовой моделью.

Гауссова модель определяется средним значением и матрицей ковариации, представленными соответственно self.location_ и self.covariance_.

Параметры:

X_testarray-like формы (n_samples, n_features)

Тестовые данные, для которых вычисляется правдоподобие; n_samples — количество объектов, а n_features — количество признаков. Предполагается, что X_test получены из того же распределения, что и данные, использованные при обучении (включая центрирование).

yИгнорируется

Не используется; присутствует для согласованности API согласно принятому соглашению.

Возвращает:

resfloat

Логарифм правдоподобия X_test, где self.location_ и self.covariance_ используются соответственно как оценки среднего значения и матрицы ковариации гауссовой модели.

set_params(**params)[источник]

Задаёт параметры этого оценивателя.

Метод работает как с простыми оценивателями, так и с вложенными объектами (например, Pipeline). Параметры последних имеют вид <component>__<parameter>, что позволяет обновлять каждый компонент вложенного объекта.

Параметры:

**paramsdict

Параметры оценивателя.

Возвращает:

selfэкземпляр оценивателя

Экземпляр оценивателя.

Примеры из галереи

Оценивание ковариации с усадкой: LedoitWolf, OAS и максимальное правдоподобие

Оценивание Ledoit-Wolf и OAS

Выбор модели с вероятностным методом главных компонент и факторным анализом (FA)