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)[源代码]#

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

阅读更多的 User Guide .

Added in version 0.9.

参数:

n_neighborsint，默认=5

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

radiusfloat，默认=1.0

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

algorithm'自动'，' ball_tree '，'，'，默认='自动'

用于计算最近邻居的算法：

'ball_tree'将使用 BallTree
'kd_tree'将使用 KDTree
“brute”将使用暴力搜索。
“Auto”将尝试根据传递给 fit 法

注意：在稀疏输入上进行调整将使用暴力覆盖此参数的设置。

leaf_sizeint，默认=30

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

metric字符串或可调用，默认=' minkowski '

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

如果“预先计算”指标，则假设X是距离矩阵，并且在匹配期间必须为平方。X可以是 sparse graph ，在这种情况下，只有“非零”元素可以被视为邻居。

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

pfloat（正），默认=2

Minkowski指标的参数来自sklearn.metrics.pairwise.pairwise_diversions。当p = 1时，这相当于对于p = 2使用manhattan_Distance（l1）和euclidean_Distance（l2）。对于任意p，使用minkowski_Distance（l_p）。

metric_paramsdict，默认=无

指标函数的附加关键字参数。

n_jobsint，默认=无

为邻居搜索运行的并行作业数。 None 意思是1，除非在a中 joblib.parallel_backend 上下文 -1 意味着使用所有处理器。看到 Glossary 了解更多详细信息。

属性:

effective_metric_str: 用于计算与邻居的距离的指标。
effective_metric_params_dict: 用于计算到邻居的距离的度量的参数。
n_features_in_int: 期间看到的功能数量 fit .

Added in version 0.24.
feature_names_in_ ：nd形状数组 (n_features_in_ ,)nd数组形状（: Names of features seen during fit. Defined only when X has feature names that are all strings.

Added in version 1.0.
n_samples_fit_int: 匹配数据中的样本数量。

参见

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

注意到

看到 Nearest Neighbors 在在线文档中讨论选择 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）如果指标='预先计算': 训练数据。
y忽视: 未使用，按照惯例，为了API一致性而存在。

返回:

selfNearestNeighbors: 适合的最近邻估计量。

get_metadata_routing()[源代码]#

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

请检查 User Guide 关于路由机制如何工作。

返回:

routingMetadataRequest: A MetadataRequest 封装路由信息。

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

获取此估计器的参数。

参数:

deep布尔，默认=True: 如果为True，将返回此估计量和包含的作为估计量的子对象的参数。

返回:

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

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

找到点的K近邻。

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

参数:

X{类数组，稀疏矩阵}，形状（n_questions，n_features），或（n_queries，n_indexed），如果指标==“预计算”，默认=无: 一个或多个查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自己的邻居。
n_neighborsint，默认=无: 每个样本所需的邻居数量。默认值是传递给构造函数的值。
return_distance布尔，默认=True: 是否返回距离。

返回:

neigh_dist形状的nd数组（n_queries，n_neighbors）: 数组，表示到点的长度，仅在return_distance=True时存在。
neigh_ind形状的nd数组（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-邻居的（加权）图。

参数:

X形状的{类数组，稀疏矩阵}（n_questions，n_features），或（n_queries，n_indexed），如果指标==“预计算”，默认=无: 一个或多个查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自己的邻居。为 metric='precomputed' 形状应该是（n_queries，n_indexed）。否则，形状应该是（n_queries，n_features）。
n_neighborsint，默认=无: 每个样本的邻居数量。默认值是传递给构造函数的值。
mode'连通性'，'，默认='连通性': 返回的矩阵类型：“连通性”将返回包含1和0的连通性矩阵，在“距离”中，边是点之间的距离，距离类型取决于NearestNeighbors类中所选的指标参数。

返回:

A形状稀疏矩阵（n_questions，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.]])

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

查找一个或多个点给定半径内的邻居。

返回位于具有大小的球体中的数据集中每个点的指数和距离 radius 在查询数组的点周围。位于边界上的点包括在结果中。

结果点是 not 必须按到查询点的距离排序。

参数:

X{类数组，稀疏矩阵}，（n_samples，n_features），默认=无: 一个或多个查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自己的邻居。
radiusfloat，默认=无: 限制邻居返回的距离。默认值是传递给构造函数的值。
return_distance布尔，默认=True: 是否返回距离。
sort_results布尔，默认=假: 如果为True，距离和指数将在返回之前按照距离的增加进行排序。如果为假，则可能不会对结果进行排序。如果 return_distance=False 、设置 sort_results=True 将导致错误。

Added in version 0.22.

返回:

neigh_dist数组形状（n_samples，）的nd数组: 代表每个点的距离的数组，仅在以下情况下存在 return_distance=True .距离值根据 metric 构造函数参数。
neigh_ind数组形状（n_samples，）的nd数组: 位于大小球内的人口矩阵的大约最近点的指数数组 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中点的邻居的（加权）图。

社区的距离低于半径的点受到限制。

参数:

X形状（n_samples，n_features）的{类数组，稀疏矩阵}，默认=无: 一个或多个查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自己的邻居。
radiusfloat，默认=无: 社区的半径。默认值是传递给构造函数的值。
mode'连通性'，'，默认='连通性': 返回的矩阵类型：“连通性”将返回包含1和0的连通性矩阵，在“距离”中，边是点之间的距离，距离类型取决于NearestNeighbors类中所选的指标参数。
sort_results布尔，默认=假: 如果为True，则在结果的每一行中，非零条目将按距离增加进行排序。如果为False，则可能不会对非零条目进行排序。仅与模式='距离'一起使用。

Added in version 0.22.

返回:

A形状稀疏矩阵（n_questions，n_samples_fit）: n_samples_fit 是匹配数据中的样本数。 A[i, j] 给出连接边缘的重量 i 到 j .该矩阵为CSR格式。

参见

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

示例

>>> 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: 估计参数。

返回:

self估计器实例: 估计实例。

画廊示例#

TSNE的大约最近邻居

Approximate nearest neighbors in TSNE