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)[source]#
用于实现邻域搜索的无监督学习器。
在用户指南中了解更多信息。
在 0.9 版本中添加。
- 参数:
- n_neighborsint，默认值=5
为
kneighbors查询默认使用的邻居数量。- radiusfloat，默认值=1.0
为
radius_neighbors查询默认使用的参数空间范围。- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}，默认值=’auto’
用于计算最近邻的算法
注意：对稀疏输入进行拟合将覆盖此参数的设置，强制使用暴力搜索。
- 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.pairwise_distances 中 Minkowski 度量的参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)；当 p = 2 时，等同于 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。
- metric_paramsdict，默认值=None
度量函数的附加关键字参数。
- n_jobsint，默认值=None
用于邻居搜索的并行作业数量。
None表示 1，除非在joblib.parallel_backend上下文。-1表示使用所有处理器。有关更多详细信息，请参阅术语表。
- 属性:
另请参阅
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)[source]#
从训练数据集拟合最近邻估计器。
- 参数:
- X形状为 (n_samples, n_features) 的 {类数组, 稀疏矩阵} 或在 metric=’precomputed’ 时为 (n_samples, n_samples)
训练数据。
- y忽略
未使用，依照惯例为保持 API 一致性而存在。
- 返回:
- selfNearestNeighbors
拟合的最近邻估计器。
- 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{类数组, 稀疏矩阵}，形状为 (n_queries, n_features)，或在 metric == ‘precomputed’ 时为 (n_queries, n_indexed)，默认值=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形状为 (n_queries, n_features) 的 {类数组, 稀疏矩阵}，或在 metric == ‘precomputed’ 时为 (n_queries, n_indexed)，默认值=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.]])
- radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[source]#
在给定半径内查找一个点或多个点的邻居。
返回数据集中每个点位于查询数组点周围半径为
radius的球体内的索引和距离。位于边界上的点包含在结果中。结果点不一定按到其查询点的距离进行排序。
- 参数:
- X形状为 (n_samples, n_features) 的 {类数组, 稀疏矩阵}，默认值=None
查询点或多个点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
- radiusfloat，默认值=None
要返回的邻居的限制距离。默认值是传递给构造函数的值。
- return_distancebool，默认值=True
是否返回距离。
- sort_resultsbool，默认值=False
如果为 True，则距离和索引在返回之前将按递增距离排序。如果为 False，则结果可能未排序。如果
return_distance=False，则设置sort_results=True将导致错误。在 0.22 版本中添加。
- 返回:
- neigh_dist形状为 (n_samples,) 的数组的 ndarray
表示到每个点的距离的数组，仅在
return_distance=True时存在。距离值根据metric构造函数参数计算。- neigh_ind形状为 (n_samples,) 的数组的 ndarray
一个由数组组成的数组，其中包含总体矩阵中近似最近点的索引，这些点位于查询点周围半径为
radius的球体内。
注意
因为每个点的邻居数量不一定相等，所以多个查询点的结果无法放入标准数据数组中。为了提高效率，
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)[source]#
计算 X 中点的邻居（加权）图。
邻域被限制为距离小于半径的点。
- 参数:
- X形状为 (n_samples, n_features) 的 {类数组, 稀疏矩阵}，默认值=None
查询点或多个点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
- radiusfloat，默认值=None
邻域半径。默认值是传递给构造函数的值。
- mode{‘connectivity’, ‘distance’}，默认值=’connectivity’
返回矩阵的类型：‘connectivity’ 将返回由 1 和 0 组成的连通性矩阵；在 ‘distance’ 中，边是点之间的距离，距离类型取决于 NearestNeighbors 类中选择的度量参数。
- sort_resultsbool，默认值=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-邻居（加权）图。
示例
>>> 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.]])
