NearestNeighbors#

class sklearn.neighbors.NearestNeighbors(*, n_neighbors=5, radius=1.0, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)[源代码]#

用于实现邻居搜索的无监督学习器。

在用户指南中阅读更多内容。

Added in version 0.9.

参数:

n_neighborsint, default=5

为 kneighbors 查询默认使用的邻居数量。

radiusfloat, default=1.0

为 radius_neighbors 查询默认使用的参数空间范围。

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’

用于计算最近邻居的算法

‘ball_tree’ 将使用 BallTree
‘kd_tree’ 将使用 KDTree
'brute' 将使用暴力搜索。
“auto” 会尝试根据传递给 fit 方法的值来决定最合适的算法。

注意：对稀疏输入进行拟合将覆盖此参数的设置，使用暴力方法。

leaf_sizeint, default=30

传递给 BallTree 或 KDTree 的叶子大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。

metricstr or callable, default=’minkowski’

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

如果 metric 为 “precomputed”，则 X 被假定为一个距离矩阵，并且在 fit 时必须是方形的。X 可以是稀疏图，在这种情况下，只有“非零”元素可能被视为邻居。

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

pfloat (positive), default=2

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

metric_paramsdict, default=None

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

n_jobsint, default=None

用于邻居搜索的并行作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。有关详细信息，请参阅词汇表。

属性:

effective_metric_str: 用于计算邻居距离的度量。
effective_metric_params_dict: 用于计算邻居距离的度量的参数。
n_features_in_int: 在拟合期间看到的特征数。

0.24 版本新增。
feature_names_in_shape 为 (n_features_in_,) 的 ndarray: 在 fit 期间看到的特征名称。仅当 X 具有全部为字符串的特征名称时才定义。

1.0 版本新增。
n_samples_fit_int: 拟合数据中的样本数量。

另请参阅

KNeighborsClassifier: 实现 k 最近邻投票的分类器。
RadiusNeighborsClassifier: 实现给定半径内邻居投票的分类器。
KNeighborsRegressor: 基于 k 最近邻的回归。
RadiusNeighborsRegressor: 基于固定半径内邻居的回归。
BallTree: 用于在多维空间中组织点的空间划分数据结构，用于最近邻搜索。

注意事项

有关 `algorithm` 和 `leaf_size` 选择的讨论，请参阅在线文档中的最近邻。

https://en.wikipedia.org/wiki/K-nearest_neighbors_algorithm

示例

>>> import numpy as np
>>> from sklearn.neighbors import NearestNeighbors
>>> samples = [[0, 0, 2], [1, 0, 0], [0, 0, 1]]
>>> neigh = NearestNeighbors(n_neighbors=2, radius=0.4)
>>> neigh.fit(samples)
NearestNeighbors(...)
>>> neigh.kneighbors([[0, 0, 1.3]], 2, return_distance=False)
array([[2, 0]]...)
>>> nbrs = neigh.radius_neighbors(
...    [[0, 0, 1.3]], 0.4, return_distance=False
... )
>>> np.asarray(nbrs[0][0])
array(2)

fit(X, y=None)[源代码]#

从训练数据集中拟合最近邻估计器。

参数:

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

返回:

selfNearestNeighbors: 已拟合的最近邻估计器。

get_metadata_routing()[源代码]#

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

请查阅用户指南，了解路由机制如何工作。

返回:

routingMetadataRequest: 封装路由信息的 MetadataRequest。

get_params(deep=True)[源代码]#

获取此估计器的参数。

参数:

deepbool, default=True: 如果为 True，将返回此估计器以及包含的子对象（如果它们是估计器）的参数。

返回:

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

kneighbors(X=None, n_neighbors=None, return_distance=True)[源代码]#

找到一个点的 K-邻居。

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

参数:

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

返回:

neigh_distndarray，形状为 (n_queries, n_neighbors): 表示到点的长度的数组，仅当 return_distance=True 时存在。
neigh_indndarray，形状为 (n_queries, n_neighbors): 总体矩阵中最近点的索引。

示例

在以下示例中，我们从表示我们数据集的数组构建了一个 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')[源代码]#

计算 X 中点的 k-Neighbors（加权）图。

参数:

X{类数组, 稀疏矩阵}，形状为 (n_queries, n_features)，如果 metric == ‘precomputed’ 则为 (n_queries, n_indexed)，默认=None: 查询点或点集。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。对于 metric='precomputed'，形状应为 (n_queries, n_indexed)。否则，形状应为 (n_queries, n_features)。
n_neighborsint, default=None: 每个样本的邻居数量。默认值为构造函数中传递的值。
mode{‘connectivity’, ‘distance’}, default=’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 中点的 Neighbors（加权）图。

示例

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

radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[源代码]#

查找点或点在给定半径内的邻居。

返回查询数组的点在半径为 radius 的球体内的点到数据集的距离和索引。边界上的点包含在结果中。

结果点不一定按与查询点的距离排序。

参数:

X{array-like, sparse matrix} of (n_samples, n_features), default=None: 查询点或点集。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
radiusfloat, default=None: 返回邻居的限制距离。默认值为传递给构造函数的该值。
return_distance布尔值，默认=True: 是否返回距离。
sort_resultsbool, default=False: 如果为 True，则在返回之前，距离和索引将按递增距离排序。如果为 False，则结果可能未排序。如果 return_distance=False，则设置 sort_results=True 将导致错误。

版本 0.22 新增。

返回:

neigh_distndarray of shape (n_samples,) of arrays: 表示到每个点的距离的数组，仅当 return_distance=True 时才存在。距离值根据 metric 构造函数参数计算。
neigh_indndarray of shape (n_samples,) of arrays: 一个数组，包含位于查询点周围大小为 radius 的球体内的近邻点的索引数组。

注意事项

由于每个点的邻居数量不一定相等，因此多个查询点的结果不能装入标准数据数组。为了提高效率，radius_neighbors 返回对象数组，其中每个对象是索引或距离的 1D 数组。

示例

在下面的示例中，我们根据表示数据集的数组构建了一个 NeighborsClassifier 类，并询问 [1, 1, 1] 的最近点是谁。

>>> import numpy as np
>>> samples = [[0., 0., 0.], [0., .5, 0.], [1., 1., .5]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(radius=1.6)
>>> neigh.fit(samples)
NearestNeighbors(radius=1.6)
>>> rng = neigh.radius_neighbors([[1., 1., 1.]])
>>> print(np.asarray(rng[0][0]))
[1.5 0.5]
>>> print(np.asarray(rng[1][0]))
[1 2]

返回的第一个数组包含所有小于 1.6 的点的距离，第二个数组包含它们的索引。通常，可以同时查询多个点。

radius_neighbors_graph(X=None, radius=None, mode='connectivity', sort_results=False)[源代码]#

计算 X 中点的 Neighbors（加权）图。

邻域被限制在距离小于半径的点。

参数:

X{array-like, sparse matrix} of shape (n_samples, n_features), default=None: 查询点或点集。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
radiusfloat, default=None: 邻域的半径。默认值为传递给构造函数的该值。
mode{‘connectivity’, ‘distance’}, default=’connectivity’: 返回矩阵的类型：‘connectivity’ 将返回包含 1 和 0 的连通性矩阵，‘distance’ 中边是点之间的距离，距离类型取决于 NearestNeighbors 类中选择的度量参数。
sort_resultsbool, default=False: 如果为 True，则在结果的每一行中，非零条目将按递增距离排序。如果为 False，则非零条目可能未排序。仅当 mode='distance' 时使用。

版本 0.22 新增。

返回:

A稀疏矩阵，形状为 (n_queries, n_samples_fit): n_samples_fit 是拟合数据中的样本数量。A[i, j] 给出连接 i 到 j 的边的权重。矩阵为 CSR 格式。

另请参阅

kneighbors_graph: 计算 X 中点的 k-Neighbors（加权）图。

示例

>>> X = [[0], [3], [1]]
>>> from sklearn.neighbors import NearestNeighbors
>>> neigh = NearestNeighbors(radius=1.5)
>>> neigh.fit(X)
NearestNeighbors(radius=1.5)
>>> A = neigh.radius_neighbors_graph(X)
>>> A.toarray()
array([[1., 0., 1.],
       [0., 1., 0.],
       [1., 0., 1.]])

set_params(**params)[源代码]#

设置此估计器的参数。

此方法适用于简单的估计器以及嵌套对象（如 Pipeline）。后者具有 <component>__<parameter> 形式的参数，以便可以更新嵌套对象的每个组件。

参数:

**paramsdict: 估计器参数。

返回:

selfestimator instance: 估计器实例。

Gallery examples#

TSNE 中的近似最近邻

NearestNeighbors#

Gallery examples#

本页