RadiusNeighborsTransformer#

class sklearn.neighbors.RadiusNeighborsTransformer(*, mode='distance', radius=1.0, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)#

将X转换为一个（加权）邻近半径内的邻居图。

转换后的数据是一个稀疏图，如 radius_neighbors_graph 返回的那样。

更多信息请参阅用户指南。

Added in version 0.22.

Parameters:

mode{‘distance’, ‘connectivity’}, default=’distance’

返回矩阵的类型：’connectivity’将返回一个包含1和0的连通性矩阵， ‘distance’将根据给定的度量返回邻居之间的距离。

radiusfloat, default=1.0

转换后的稀疏图中邻域的半径。

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 中列出的度量，以获取有效的度量值。

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

不支持距离矩阵。

pfloat, default=2

sklearn.metrics.pairwise.pairwise_distances的Minkowski度量参数。当p = 1时，这相当于使用曼哈顿距离（l1），当p = 2时，相当于使用欧几里得距离（l2）。对于任意p，使用Minkowski距离（l_p）。此参数应为正数。

metric_paramsdict, default=None

度量函数的额外关键字参数。

n_jobsint, default=None

用于邻居搜索的并行作业数。如果为 -1 ，则作业数设置为CPU核心数。

Attributes:

effective_metric_str or callable: 使用的距离度量。它将与 metric 参数相同或为其同义词，例如，如果 metric 参数设置为’minkowski’且 p 参数设置为2，则为’euclidean’。
effective_metric_params_dict: 度量函数的额外关键字参数。对于大多数度量，将与 metric_params 参数相同，但如果 effective_metric_ 属性设置为’minkowski’，则可能还包含 p 参数值。
n_features_in_int: 在 fit 期间看到的特征数。

Added in version 0.24.
feature_names_in_ndarray of shape ( n_features_in_ ,): 在 fit 期间看到的特征名称。仅当 X 的特征名称均为字符串时定义。

Added in version 1.0.
n_samples_fit_int: 拟合数据中的样本数。

See also

kneighbors_graph: 计算X中点的k-邻居的加权图。
KNeighborsTransformer: 将X转换为k个最近邻居的加权图。

Examples

>>> import numpy as np
>>> from sklearn.datasets import load_wine
>>> from sklearn.cluster import DBSCAN
>>> from sklearn.neighbors import RadiusNeighborsTransformer
>>> from sklearn.pipeline import make_pipeline
>>> X, _ = load_wine(return_X_y=True)
>>> estimator = make_pipeline(
...     RadiusNeighborsTransformer(radius=42.0, mode='distance'),
...     DBSCAN(eps=25.0, metric='precomputed'))
>>> X_clustered = estimator.fit_predict(X)
>>> clusters, counts = np.unique(X_clustered, return_counts=True)
>>> print(counts)
[ 29  15 111  11  12]

fit(X, y=None)#

拟合从训练数据集得到的半径邻居变换器。

Parameters:

X{array-like, sparse matrix}，形状为 (n_samples, n_features) 或如果 metric=’precomputed’ 则为 (n_samples, n_samples): 训练数据。
y忽略: 未使用，为了API一致性而存在。

Returns:

selfRadiusNeighborsTransformer: 拟合的半径邻居变换器。

fit_transform(X, y=None)#

拟合数据，然后进行转换。

将转换器拟合到X和y，可选参数为fit_params，并返回X的转换版本。

Parameters:

X形状为(n_samples, n_features)的类数组: 训练集。
y忽略: 未使用，为保持API一致性而存在。

Returns:

Xt形状为(n_samples, n_samples)的稀疏矩阵: Xt[i, j] 被分配连接i到j的边的权重。只有邻居有显式值。对角线始终是显式的。矩阵为CSR格式。

get_feature_names_out(input_features=None)#

获取转换后的输出特征名称。

输出特征名称将以小写的类名作为前缀。例如，如果转换器输出3个特征，那么输出特征名称将是： ["class_name0", "class_name1", "class_name2"] 。

Parameters:

input_features类似数组的对象或None，默认为None: 仅用于验证特征名称与 fit 中看到的名称。

Returns:

feature_names_outndarray of str对象: 转换后的特征名称。

get_metadata_routing()#

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

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

Returns:

routingMetadataRequest: MetadataRequest 封装的路由信息。

get_params(deep=True)#

获取此估计器的参数。

Parameters:

deepbool, 默认=True: 如果为True，将返回此估计器和包含的子对象（也是估计器）的参数。

Returns:

paramsdict: 参数名称映射到它们的值。

radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)#

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

返回数据集中每个点在查询数组的点周围半径为 radius 的球内的索引和距离。位于边界上的点包含在结果中。

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

Parameters:

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

Added in version 0.22.

Returns:

neigh_distndarray of shape (n_samples,) of arrays: 表示到每个点的距离的数组，仅在 return_distance=True 时存在。距离值根据 metric 构造函数参数计算。
neigh_indndarray of shape (n_samples,) of arrays: 一个数组的数组，包含来自总体矩阵的近似最近点的索引，这些点位于查询点周围半径为 radius 的球内。

Notes

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

Examples

在以下示例中，我们从一个表示数据集的数组构造一个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中点的（加权）邻居图。

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

Parameters:

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

Added in version 0.22.

Returns:

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