sklearn.neighbors.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)
[源码]
用于实施临近点搜索的无监督学习者。
在用户指南中阅读更多内容。
0.9版的新功能。
| 参数 | 说明 |
|---|---|
| n_neighbors | int, default=5 默认情况下用于 kneighbors查询的临近点数。 |
| radius | float, default=1.0 默认情况下用于 radius_neighbors查询的参数空间范围。 |
| algorithm | {‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’ 用于计算最近临近点的算法： ”ball_tree“将使用BallTree “kd_tree”将使用KDTree “brute”将使用暴力搜索。 “auto”将尝试根据传递给fit方法的值来决定最合适的算法。 注意：稀疏输入上的拟合将使用蛮力覆盖此参数的设置。 |
| leaf_size | int, default=30 叶大小传递给BallTree或KDTree。 这会影响构造和查询的速度，以及存储树所需的内存。 最佳值取决于问题的性质 |
| metric | str or callable, default=’minkowski’ 树使用的距离度量。 默认度量标准为minkowski，p = 2等于标准欧几里德度量标准。 有关可用度量的列表，请参见[https://scikit-learn.org.cn/view/692.html)的文档。 如果度量是“预先计算的”，则X被假定为距离矩阵sparse graph，并且在拟合过程中必须为平方。 X可能是一个稀疏图，在这种情况下，只有“非零”元素可以被视为临近点。 |
| p | int, default=2 sklearn.metrics.pairwise.pairwise_distances中的Minkowski指标的参数。 当p = 1时，这等效于对p = 2使用manhattan_distance（l1）和euclidean_distance（l2）。对于任意p，使用minkowski_distance（l_p）。 |
| metric_params | dict, default=None 度量功能的其他关键字参数。 |
| n_jobs | int, default=None 为临近点搜索运行的并行作业数。 除非在joblib.parallel_backend`上下文中，否则None表示1。 -1表示使用所有处理器。 有关更多详细信息，请参见词汇表](http://scikit-learn.org.cn/lists/91.html#%E5%8F%82%E6%95%B0) |
| 属性 | 说明 |
|---|---|
| effective_metric_ | str 用于计算到临近点的距离的度量。 |
| effective_metric_params_ | dict 用于计算到临近点的距离的度量标准的参数。 |
另见：
声明
有关算法选择和leaf_size的讨论，请参见在线文档中的最近邻Nearest Neighbors。
https://en.wikipedia.org/wiki/K-nearest_neighbor_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]) |
使用X作为训练数据拟合模型 |
get_params([deep]) |
获取此估计量的参数 |
kneighbors([X, n_neighbors, return_distance]) |
查找点的K邻。 |
kneighbors_graph([X, n_neighbors, mode]) |
计算X中点的k临近点的（加权）图 |
radius_neighbors([X, radius, …]) |
查找一个或多个给定半径内的临近点。 |
radius_neighbors_graph([X, radius, mode, …]) |
计算X中点的临近点（加权）图 |
set_params(**params) |
设置此估算器的参数。 |
__init__(*, n_neighbors=5, radius=1.0, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)
[源码]
初始化， 请参阅help(type())以获得准确的说明
fit(X, y=None)
[源码]
使用X作为训练数据拟合模型
| 参数 | 说明 |
|---|---|
| X | {array-like, sparse matrix, BallTree, KDTree} 训练数据。 如果是数组或矩阵，则将其形状设置为[n_samples，n_features]，如果是metric =“ precomputed”，则为[n_samples，n_samples]。 |
get_params(deep=True)
[源码]
获取此估计量的参数。
| 参数 | 说明 |
|---|---|
| deep | mapping of string to any 如果为True，则将返回此估算器和作为估算器的所包含子对象的参数。 |
| 返回值 | 说明 |
|---|---|
| params | mapping of string to any 参数名称映射到其值。 |
kneighbors(X=None, n_neighbors=None, return_distance=True)
[源码]
查找点的K临近点。 返回每个点的临近点的索引和与之的距离。
| 参数 | 说明 |
|---|---|
| X | array-like, shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’ 查询点。 如果未提供，则返回每个索引点的临近点。 在这种情况下，查询点不被视为其自己的临近点。 |
| n_neighbors | int 要获取的临近点数（默认值为传递给构造函数的值） |
| return_distance | boolean, optional. Defaults to True. 如果为False，则不会返回距离 |
| 返回值 | 说明 |
|---|---|
| neigh_dist | array, shape (n_queries, n_neighbors) 表示点的长度的数组，仅在return_distance = True时存在 |
| neigh_ind | array, shape (n_queries, n_neighbors) 总体矩阵中最近点的索引。 |
示例
在下面的示例中，我们从代表我们的数据集的数组构造一个NearestNeighbors类，并询问谁最接近[1,1,1]
>>> 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 | array-like, shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’ 查询点。 如果未提供，则返回每个索引点的临近点。 在这种情况下，查询点不被认为是它自己的临近点。 |
| n_neighbors | int 每个样本的临近点数。 （默认值为传递给构造函数的值）。 |
| mode | {‘connectivity’, ‘distance’}, optional 返回矩阵的类型：“连通性”将返回具有1和0的连通性矩阵，在“距离”中，边为点之间的欧几里得距离。 |
| 返回值 | 说明 |
|---|---|
| A | sparse graph in CSR format, shape = [n_queries, n_samples_fit] n_samples_fit是拟合数据中的样本数A [i，j]，分配了将i连接到j的边的权重。 |
另见：
示例
>>> 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)
[源码]
查找一个或多个给定半径内的临近点。
返回数据集中每个点的索引和距离，该数据集位于一个球中，球的大小半径围绕查询数组的点。 边界上的点包括在结果中。
结果点不一定按与查询点的距离排序。
| 参数 | 返回值 |
|---|---|
| X | array-like, (n_samples, n_features), optional 查询点。 如果未提供，则返回每个索引点的临近点。 在这种情况下，查询点不被视为其自己的临近点。 |
| radius | float 限制临近点返回的距离。 （默认值为传递给构造函数的值）。 |
| return_distance | boolean, optional. Defaults to True. 如果为False，则不会返回距离。 |
| sort_results | boolean, optional. Defaults to False. 如果为True，则距离和索引将在返回之前进行排序。 如果为False，则不会对结果进行排序。 如果return_distance == False，则将sort_results = True设置将导致错误。 0.22版中的新功能。 |
| 返回值 | 说明 |
|---|---|
| neigh_dist | array, shape (n_samples,) of arrays 表示到每个点的距离的数组，仅当return_distance = True时才存在。 距离值是根据度量构造函数参数计算的。 |
| neigh_ind | array, shape (n_samples,) of arrays 人口矩阵中距离查询点最近的近似点的索引数组。 |
声明
因为每个点的临近点数不一定相等，所以多个查询点的结果不能适合标准数据数组。 为了提高效率，radius_neighbors返回对象数组，其中每个对象都是一维索引或距离数组。
示例
在以下示例中，我们从代表数据集的数组构造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 | array-like of shape (n_samples, n_features), default=None 查询点。 如果未提供，则返回每个索引点的临近点。 在这种情况下，查询点不被视为其自己的临近点。 |
| radius | float 社区半径。 （默认值为传递给构造函数的值） |
| mode | {‘connectivity’, ‘distance’}, optional 返回矩阵的类型：“连通性”将返回具有1和0的连通性矩阵，在“距离”中，边为点之间的欧几里得距离。> |
| sort_results | boolean, optional. Defaults to False. 如果为True，则距离和索引将在返回之前进行排序。 如果为False，则不会对结果进行排序。 仅与mode =” distance”一起使用。 0.22版中的新功能。 |
| 返回值 | 说明 |
|---|---|
| A | sparse graph in CSR format, shape = [n_queries, n_samples_fit] n_samples_fit是拟合数据中的样本数A [i，j]，分配了将i连接到j的边的权重。 |
另见：
示例
>>> 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)
[源码]
设置此估算器的参数。
该方法适用于简单的估计器以及嵌套对象（例如管道）。 后者的参数格式为
| 参数 | 说明 |
|---|---|
| **params | dict 估算器参数。 |
| 返回值 | 说明 |
|---|---|
| self | object 估算器实例。 |
