LocalOutlierFactor#

class sklearn.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 或 callable, 默认值='minkowski'

用于距离计算的度量。默认是 “minkowski”，当 p = 2 时，这相当于标准欧几里得距离。有关有效的度量值，请参见 scipy.spatial.distance 的文档以及 `distance_metrics` 中列出的度量。

如果度量是“precomputed”，则 X 被假定为距离矩阵，并且在拟合期间必须是方阵。X 可以是稀疏图，在这种情况下，只有“非零”元素才可能被视为邻居。

如果度量是一个可调用函数，它接受两个表示一维向量的数组作为输入，并且必须返回一个值表示这些向量之间的距离。这适用于 Scipy 的度量，但效率低于将度量名称作为字符串传递。

pfloat, 默认值=2

来自 `sklearn.metrics.pairwise_distances` 的 Minkowski 度量参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)，当 p = 2 时等同于 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。

metric_paramsdict, 默认值=None

度量函数的附加关键字参数。

contamination‘auto’ 或 float, 默认值='auto'

数据集的污染程度，即数据集中异常值的比例。在拟合时，这用于定义样本分数的阈值。

如果为 ‘auto’，则阈值按原始论文中定义的方式确定，
如果为 float，则污染应在 (0, 0.5] 范围内。

0.22 版本中的变更: contamination 的默认值从 0.1 更改为 'auto'。

noveltybool, 默认值=False

默认情况下，LocalOutlierFactor 仅用于异常值检测 (novelty=False)。如果您想将 LocalOutlierFactor 用于新颖性检测，请将 novelty 设置为 True。在这种情况下，请注意您应该只对新的、未见过的数据使用 predict、decision_function 和 score_samples，而不是在训练集上使用；并且请注意，以这种方式获得的结果可能与标准 LOF 结果不同。

在 0.20 版本中添加。

n_jobsint, 默认值=None

邻居搜索并行运行的作业数量。None 表示 1，除非在 `joblib.parallel_backend` 上下文中。-1 表示使用所有处理器。详情请参见词汇表。

属性:

negative_outlier_factor_形状为 (n_samples,) 的 ndarray

训练样本的 LOF 相反值。该值越高，越正常。局内点 (Inliers) 的 LOF 分数倾向于接近 1（negative_outlier_factor_ 接近 -1），而异常值 (outliers) 的 LOF 分数倾向于更大。

样本的局部异常因子 (LOF) 捕捉其所谓的“异常程度”。它是样本局部可达性密度与其 k 近邻的局部可达性密度之比的平均值。

n_neighbors_int

实际用于 `kneighbors` 查询的邻居数量。

offset_float

用于从原始分数获取二元标签的偏移量。负异常因子小于 offset_ 的观测值被检测为异常。偏移量设置为 -1.5（局内点分数约为 -1），除非提供了与“auto”不同的污染参数。在这种情况下，偏移量被定义为在训练中获得预期数量的异常值。

在 0.20 版本中添加。

effective_metric_str

用于距离计算的有效度量。

effective_metric_params_dict

度量函数的有效附加关键字参数。

n_features_in_int

在拟合期间观察到的特征数量。

在 0.24 版本中添加。

feature_names_in_形状为 (n_features_in_,) 的 ndarray

在拟合期间观察到的特征名称。仅当 X 的所有特征名称都是字符串时才定义。

在 1.0 版本中添加。

n_samples_fit_int

它是拟合数据中的样本数量。

另请参见

sklearn.svm.OneClassSVM: 使用支持向量机进行无监督异常检测。

参考文献

[1]

Breunig, M. M., Kriegel, H. P., Ng, R. T., & Sander, J. (2000, May). LOF: identifying density-based local outliers. In ACM sigmod record.

示例

>>> 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{array-like, 稀疏矩阵}，形状为 (n_samples, n_features): 用于计算相对于训练样本的局部异常因子的查询样本或样本。

返回:

shifted_opposite_lof_scores形状为 (n_samples,) 的 ndarray: 每个输入样本的局部异常因子的平移相反值。值越低，越异常。负分数表示异常值，正分数表示局内点。

fit(X, y=None)[source]#

从训练数据集拟合局部异常因子检测器。

参数:

X{array-like, 稀疏矩阵}，形状为 (n_samples, n_features) 或 (n_samples, n_samples) 如果 metric='precomputed': 训练数据。
y忽略: 未使用，按惯例为保持 API 一致性而存在。

返回:

selfLocalOutlierFactor: 已拟合的局部异常因子检测器。

fit_predict(X, y=None)[source]#

将模型拟合到训练集 X 并返回标签。

不适用于新颖性检测 (当 novelty 设置为 True 时)。 根据 LOF 分数和污染参数，局内点标签为 1，异常值标签为 -1。

参数:

X{array-like, 稀疏矩阵}，形状为 (n_samples, n_features), 默认值=None: 用于计算相对于训练样本的局部异常因子的查询样本或样本。
y忽略: 未使用，按惯例为保持 API 一致性而存在。

返回:

is_inlier形状为 (n_samples,) 的 ndarray: 异常/异常值返回 -1，局内点返回 1。

get_metadata_routing()[source]#

获取此对象的元数据路由。

请查看用户指南以了解路由机制的工作原理。

返回:

routingMetadataRequest: 封装路由信息的 `MetadataRequest`。

get_params(deep=True)[source]#

获取此评估器的参数。

参数:

deepbool, 默认值=True: 如果为 True，将返回此评估器及其包含的作为评估器的子对象的参数。

返回:

paramsdict: 参数名称映射到其值。

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

查找一个点的 K 近邻。

返回每个点的邻居的索引和距离。

参数:

X{array-like, 稀疏矩阵}，形状为 (n_queries, n_features)，或 (n_queries, n_indexed) 如果 metric == 'precomputed', 默认值=None: 查询点或点集。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
n_neighborsint, 默认值=None: 每个样本所需的邻居数量。默认值是传递给构造函数的值。
return_distancebool, 默认值=True: 是否返回距离。

返回:

neigh_dist形状为 (n_queries, n_neighbors) 的 ndarray: 表示到点的长度的数组，仅当 return_distance=True 时存在。
neigh_ind形状为 (n_queries, n_neighbors) 的 ndarray: 人口矩阵中最接近点的索引。

示例

在以下示例中，我们从表示数据集的数组构建了一个 NearestNeighbors 类，并询问距离 [1,1,1] 最近的点是哪个

>>> samples = [[0., 0., 0.], [0., .5, 0.], [1., 1., .5]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(n_neighbors=1)
>>> neigh.fit(samples)
NearestNeighbors(n_neighbors=1)
>>> print(neigh.kneighbors([[1., 1., 1.]]))
(array([[0.5]]), array([[2]]))

正如您所见，它返回 [[0.5]] 和 [[2]]，这意味着该元素距离为 0.5，并且是样本的第三个元素（索引从 0 开始）。您还可以查询多个点

>>> X = [[0., 1., 0.], [1., 0., 1.]]
>>> neigh.kneighbors(X, return_distance=False)
array([[1],
       [2]]...)

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

计算 X 中点的 k 近邻（加权）图。

参数:

X{array-like, 稀疏矩阵}，形状为 (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’ 将返回包含 1 和 0 的连通性矩阵；‘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]#

根据 LOF 预测 X 的标签（1 为局内点，-1 为异常值）。

仅在新颖性检测可用 (当 novelty 设置为 True 时)。 此方法允许将预测推广到 新观测值（不在训练集中）。请注意，使用 novelty=True 执行 clf.fit(X) 然后 clf.predict(X) 的结果可能与使用 novelty=False 执行 clf.fit_predict(X) 的结果不同。

参数:

X{array-like, 稀疏矩阵}，形状为 (n_samples, n_features): 用于计算相对于训练样本的局部异常因子的查询样本或样本。

返回:

is_inlier形状为 (n_samples,) 的 ndarray: 异常/异常值返回 -1，局内点返回 +1。

score_samples(X)[source]#

X 的局部异常因子的相反值。

它是相反的，因为越大越好，即大值对应于局内点。

仅在新颖性检测可用 (当 novelty 设置为 True 时)。 参数 X 应包含 新数据：如果 X 包含来自训练集的一个点，它会在其自身邻域中考虑该点。此外，X 中的样本不被视为任何点的邻域的一部分。因此，通过 score_samples 获得的分数可能与标准 LOF 分数不同。训练数据的标准 LOF 分数可通过 negative_outlier_factor_ 属性获得。

参数: