LocalOutlierFactor

classsklearn.neighbors.LocalOutlierFactor(n_neighbors=20, *, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, contamination='auto', novelty=False, n_jobs=None)[source]

Обнаружение выбросов без учителя с помощью локального фактора выбросов (LOF).

Оценка аномальности каждого образца называется локальным фактором выбросов. Она измеряет локальное отклонение плотности заданного образца относительно его соседей. Она локальна в том смысле, что оценка аномальности зависит от того, насколько изолирован объект по отношению к окружающему окружению. Более точно, локальность задается k ближайшими соседями, расстояние до которых используется для оценки локальной плотности. Сравнивая локальную плотность образца с локальными плотностями его соседей, можно определить образцы, имеющие существенно меньшую плотность, чем их соседи. Они считаются выбросами.

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

Параметры:

n_neighborsint, по умолчанию=20

Количество соседей, используемых по умолчанию для запросов kneighbors. Если n_neighbors больше, чем количество образцов, предоставленных, будут использованы все образцы.

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, по умолчанию=’auto’

Алгоритм, используемый для вычисления ближайших соседей:

• ‘ball_tree’ будет использовать BallTree
• ‘kd_tree’ будет использовать KDTree
• ‘brute’ будет использовать грубую силу.
• ‘auto’ будет пытаться определить наиболее подходящий алгоритм на основе значений, переданных методу fit.

Примечание: подгонка на разреженном вводе переопределит настройку этого параметра, используя грубую силу.

leaf_sizeint, по умолчанию=30

Размер листа, передаваемый в BallTree или KDTree. Это может повлиять на скорость построения и запроса, а также на память, необходимую для хранения дерева. Оптимальное значение зависит от характера задачи.

metricstr или вызываемая функция, по умолчанию=’minkowski’

Метрика, используемая для вычисления расстояния. По умолчанию «minkowski», что приводит к стандартному евклидовому расстоянию при p = 2. См. документацию scipy.spatial.distance и перечисленные метрики в distance_metrics для допустимых значений метрики.

Если metric равно «precomputed», X предполагается матрицей расстояний и должна быть квадратной во время подгонки. X может быть разреженной графой, в этом случае только «ненулевые» элементы могут рассматриваться как соседи.

Если metric — вызываемая функция, она принимает два массива, представляющих одномерные векторы, в качестве входных данных и должна возвращать одно значение, обозначающее расстояние между этими векторами. Это работает для метрик Scipy, но менее эффективно, чем передача имени метрики как строки.

pfloat, по умолчанию=2

Параметр метрики Минковского из sklearn.metrics.pairwise_distances. При p = 1 это эквивалентно использованию manhattan_distance (l1), а euclidean_distance (l2) для p = 2. Для произвольного p используется minkowski_distance (l_p).

metric_paramsdict, по умолчанию=None

Дополнительные ключевые аргументы для функции метрики.

contamination‘auto’ или float, по умолчанию=’auto’

Количество загрязнений набора данных, т.е. доля выбросов в наборе данных. При подгонке это используется для определения порога по оценкам образцов.

• если ‘auto’, порог определяется как в оригинальной статье,
• если float, contamination должна быть в диапазоне (0, 0.5].

Изменено в версии 0.22: Значение по умолчанию contamination изменено с 0.1 на 'auto'.

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

По умолчанию LocalOutlierFactor предназначен только для обнаружения выбросов (novelty=False). Установите novelty в True, если хотите использовать LocalOutlierFactor для обнаружения новизны. В этом случае имейте в виду, что вы должны использовать только predict, decision_function и score_samples на новых невиданных данных, а не на наборе обучающих данных; и обратите внимание, что результаты, полученные таким образом, могут отличаться от стандартных результатов LOF.

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

n_jobsint, по умолчанию=None

Количество параллельных задач для поиска соседей. None означает 1, если не в контексте joblib.parallel_backend. -1 означает использование всех процессоров. См. Глоссарий для получения дополнительных сведений.

Атрибуты:

negative_outlier_factor_ndarray формы (n_samples,)

Обратное значение LOF для обучающих образцов. Чем выше, тем более нормальный. Внутри образцы имеют оценку LOF, близкую к 1 (negative_outlier_factor_ близко к -1), в то время как выбросы имеют более высокую оценку LOF.

Локальный фактор выбросов (LOF) образца отражает его предполагаемую «степень аномальности». Это среднее значение отношения локальной плотности достижимости образца к локальным плотностям его k ближайших соседей.

n_neighbors_int

Фактическое количество соседей, используемых для запросов kneighbors

offset_float

Смещение, используемое для получения двоичных меток из исходных оценок. Наблюдения, имеющие negative_outlier_factor, меньший, чем offset_, обнаруживаются как аномальные. Смещение установлено в -1.5 (внутри образцы имеют оценку около -1), за исключением случаев, когда предоставляется параметр contamination, отличный от «auto». В этом случае смещение определяется таким образом, чтобы мы получали ожидаемое количество выбросов в обучении.

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

effective_metric_str

Эффективная метрика, используемая для вычисления расстояния.

effective_metric_params_dict

Эффективные дополнительные ключевые аргументы для функции метрики.

n_features_in_int

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

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

feature_names_in_ndarray формы (n_features_in_,)

Имена признаков, увиденные во время подгонки. Определены только тогда, когда X имеет имена признаков, которые все являются строками.

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

n_samples_fit_int

Это количество образцов в подогнанных данных.

См. также

sklearn.svm.OneClassSVM

Обнаружение выбросов без учителя с помощью машины опорных векторов.

Ссылки

[1]

Бреунинг, М. М., Кригель, Х. П., Нг, Р. Т., и Сандер, Дж. (2000, май). LOF: идентификация локальных выбросов на основе плотности. В записях ACM sigmod.

Примеры

>>> import numpy as np
>>> from sklearn.neighbors import LocalOutlierFactor
>>> X = [[-1.1], [0.2], [101.1], [0.3]]
>>> clf = LocalOutlierFactor(n_neighbors=2)
>>> clf.fit_predict(X)
array([ 1,  1, -1,  1])
>>> clf.negative_outlier_factor_
array([ -0.9821...,  -1.0370..., -73.3697...,  -0.9821...])

decision_function(X)[source]

Смещенное противоположное значение локального фактора выброса для X.

Больше — лучше, т.е. большие значения соответствуют инлайнерам.

Доступно только для обнаружения новизны (когда novelty установлено в True). Смещение позволяет установить нулевой порог для выброса. Аргумент X должен содержать новые данные: если X содержит точку из обучающего набора, он рассматривает ее в своем собственном окрестности. Также, образцы в X не учитываются в окрестности любой точки.

Параметры:

X{массив, разреженная матрица} формы (n_samples, n_features)

Запрос образца или образцов для вычисления локального фактора выбросов по отношению к обучающим образцам.

Возвращает:

shifted_opposite_lof_scoresмассив формы (n_samples,)

Смещенное противоположное значение локального фактора выброса для каждого входного образца. Чем меньше, тем больше аномалия. Отрицательные значения представляют выбросы, положительные — инлайнеры.

fit(X, y=None)[source]

Обучает детектор локального фактора выбросов на основе обучающего набора данных.

Параметры:

X{массив, разреженная матрица} формы (n_samples, n_features) или (n_samples, n_samples), если metric=’precomputed’

Обучающие данные.

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

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

Возвращает:

selfLocalOutlierFactor

Обученный детектор локального фактора выбросов.

fit_predict(X, y=None)[source]

Обучает модель на обучающем наборе X и возвращает метки.

Не доступно для обнаружения новизны (когда novelty установлено в True). Метка равна 1 для инлайнера и -1 для выброса в соответствии со значением LOF и параметром contamination.

Параметры:

X{массив, разреженная матрица} формы (n_samples, n_features), по умолчанию = None

Запрос образца или образцов для вычисления локального фактора выбросов по отношению к обучающим образцам.

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

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

Возвращает:

is_inlierмассив формы (n_samples,)

Возвращает -1 для аномалий/выбросов и 1 для инлайнеров.

get_metadata_routing()[source]

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

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

Возвращает:

routingMetadataRequest

MetadataRequest\p>

get_params(deep=True)[source]

Получает параметры для данного оценщика.

Параметры:

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

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

Возвращает:

paramsdict

Названия параметров, сопоставленные со значениями.

kneighbors(X=None, n_neighbors=None, return_distance=True)[source]

Находит K-ближайших соседей точки.

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

Параметры:

X{массив, разреженная матрица}, форма (n_queries, n_features) или (n_queries, n_indexed) если metric == ‘precomputed’, по умолчанию = None

Точка или точки запроса. Если не указано, возвращаются соседи каждой индексированной точки. В этом случае точка запроса не считается ее собственным соседом.

n_neighborsint, по умолчанию = None

Число требуемых соседей для каждой выборки. По умолчанию — значение, переданное конструктору.

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

Возвращать ли расстояния.

Возвращает:

neigh_distмассив формы (n_queries, n_neighbors)

Массив, представляющий длины до точек, присутствует только если return_distance=True.

neigh_indмассив формы (n_queries, n_neighbors)

Индексы ближайших точек в матрице популяции.

kneighbors_graph(X=None, n_neighbors=None, mode='connectivity')[source]

Вычислить (взвешенную) граф k-соседей для точек в X.

Параметры:

X{array-like, sparse matrix} формы (n_queries, n_features), или (n_queries, n_indexed), если metric == ‘precomputed’, по умолчанию None

Точка или точки запроса. Если не указано, возвращаются соседи каждой индексированной точки. В этом случае точка запроса не считается своим собственным соседом. Для metric='precomputed' форма должна быть (n_queries, n_indexed). В противном случае форма должна быть (n_queries, n_features).

n_neighborsint, по умолчанию None

Количество соседей для каждого образца. По умолчанию используется значение, переданное в конструктор.

mode{‘connectivity’, ‘distance’}, по умолчанию=’connectivity’

Тип возвращаемой матрицы: ‘connectivity’ вернёт матрицу связности с единицами и нулями, в ‘distance’ рёбра являются расстояниями между точками, тип расстояния зависит от выбранного параметра метрики в классе NearestNeighbors.

Возвращает:

Aразреженная матрица формы (n_queries, n_samples_fit)

n_samples_fit — это число образцов в подготовленных данных. A[i, j] задаёт вес ребра, соединяющего i с j. Матрица имеет формат CSR.

См. также

NearestNeighbors.radius_neighbors_graph

Вычислить (взвешенную) граф соседей для точек в X.

Примеры

>>> X = [[0], [3], [1]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(n_neighbors=2)
>>> neigh.fit(X)
NearestNeighbors(n_neighbors=2)
>>> A = neigh.kneighbors_graph(X)
>>> A.toarray()
array([[1., 0., 1.],
       [0., 1., 1.],
       [1., 0., 1.]])

predict(X=None)[source]

Предсказать метки (1 — инлайнер, -1 — аутлайнер) X в соответствии с LOF.

Доступно только для обнаружения новизны (когда novelty установлено в True). Этот метод позволяет обобщить предсказание на *новые наблюдения* (не в обучающей выборке). Обратите внимание, что результат clf.fit(X) а затем clf.predict(X) с novelty=True может отличаться от результата, полученного clf.fit_predict(X) с novelty=False.

Параметры:

X{array-like, sparse matrix} формы (n_samples, n_features)

Образец или образцы запроса для вычисления Local Outlier Factor относительно обучающих образцов.

Возвращает:

is_inlierndarray формы (n_samples,)

Возвращает -1 для аномалий/аутлайнеров и +1 для инлайнеров.

score_samples(X)[source]

Обратное значение Local Outlier Factor для X.

Обратное, так как больше — лучше, т.е. большие значения соответствуют инлайнерам.

Доступно только для обнаружения новизны (когда novelty установлено в True). Аргумент X должен содержать *новые данные*: если X содержит точку из обучающей выборки, он рассматривает её в своём собственном окружении. Кроме того, образцы в X не учитываются в окрестности любой точки. По этой причине значения, полученные посредством score_samples, могут отличаться от стандартных значений LOF. Стандартные значения LOF для обучающих данных доступны через атрибут negative_outlier_factor_.

Параметры:

X{array-like, sparse matrix} формы (n_samples, n_features)

Образец или образцы запроса для вычисления Local Outlier Factor относительно обучающих образцов.

Возвращает:

opposite_lof_scoresndarray формы (n_samples,)

Обратное значение Local Outlier Factor для каждого входного образца. Чем меньше, тем более аномальный.

set_params(**params)[source]

Установить параметры этого оценивателя.

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

Параметры:

**paramsdict

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

Возвращает:

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

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

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

Сравнение алгоритмов обнаружения аномалий для обнаружения выбросов на наборах данных игрушечных данных

Оценка алгоритмов обнаружения выбросов

Обнаружение новизны с помощью Local Outlier Factor (LOF)

Обнаружение выбросов с помощью Local Outlier Factor (LOF)