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)[source]#
将 X 转换为半径范围内的（加权）邻居图。
转换后的数据是由
radius_neighbors_graph返回的稀疏图。详情请参阅用户指南。
0.22 版本新增。
- 参数:
- mode{‘distance’, ‘connectivity’}，默认值为’distance’
返回矩阵的类型：’connectivity’ 将返回包含一和零的连接矩阵，而 ‘distance’ 将根据给定度量返回邻居之间的距离。
- radius浮点型，默认值为 1.0
转换后的稀疏图中邻域的半径。
- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}，默认值为’auto’
用于计算最近邻的算法
注意：对稀疏输入进行拟合将覆盖此参数的设置，使用暴力搜索。
- leaf_size整型，默认值为 30
传递给 BallTree 或 KDTree 的叶子大小。这会影响构造和查询的速度，以及存储树所需的内存。最优值取决于问题的性质。
- metric字符串或可调用对象，默认值为’minkowski’
用于距离计算的度量。默认值为“minkowski”，当 p = 2 时，它会产生标准的欧几里得距离。有关有效度量值，请参见 scipy.spatial.distance 的文档以及
distance_metrics中列出的度量。如果度量是一个可调用函数，它接受两个表示一维向量的数组作为输入，并且必须返回一个值表示这些向量之间的距离。这适用于 Scipy 的度量，但效率不如将度量名称作为字符串传递。
不支持距离矩阵。
- p浮点型，默认值为 2
来自 sklearn.metrics.pairwise.pairwise_distances 的 Minkowski 度量的参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)，当 p = 2 时，则等同于 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。此参数预期为正值。
- metric_params字典，默认值为 None
度量函数的附加关键字参数。
- n_jobs整型，默认值为 None
用于邻居搜索的并行作业数量。如果为
-1，则作业数量设置为 CPU 核的数量。
- 属性:
- effective_metric_字符串或可调用对象
使用的距离度量。它将与
metric参数相同或其同义词，例如，如果metric参数设置为 ‘minkowski’ 且p参数设置为 2，则为 ‘euclidean’。- effective_metric_params_字典
度量函数的附加关键字参数。对于大多数度量，将与
metric_params参数相同，但如果effective_metric_属性设置为 ‘minkowski’，则可能还包含p参数值。- n_features_in_整型
在 fit 期间看到的特征数量。
0.24 版本新增。
- feature_names_in_形状为 (
n_features_in_,) 的 ndarray 在 fit 期间看到的特征名称。仅当
X的所有特征名称均为字符串时才定义。1.0 版本新增。
- n_samples_fit_整型
拟合数据中的样本数量。
另请参阅
kneighbors_graph计算 X 中点的 k-邻居加权图。
KNeighborsTransformer将 X 转换为 k 最近邻的加权图。
示例
>>> 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)[source]#
从训练数据集拟合半径邻居转换器。
- 参数:
- X{array-like, 稀疏矩阵}，形状为 (n_samples, n_features) 或 (n_samples, n_samples)（如果 metric=’precomputed’）
训练数据。
- y忽略
未使用，按惯例存在以保持 API 一致性。
- 返回:
- selfRadiusNeighborsTransformer
拟合后的半径邻居转换器。
- fit_transform(X, y=None)[source]#
拟合数据，然后进行转换。
使用可选参数 fit_params 将转换器拟合到 X 和 y，并返回 X 的转换版本。
- 参数:
- X形状为 (n_samples, n_features) 的 array-like
训练集。
- y忽略
未使用，按惯例存在以保持 API 一致性。
- 返回:
- Xt形状为 (n_samples, n_samples) 的稀疏矩阵
Xt[i, j] 被赋予连接 i 到 j 的边的权重。只有邻居具有显式值。对角线始终是显式的。该矩阵为 CSR 格式。
- get_feature_names_out(input_features=None)[source]#
获取转换的输出特征名称。
输出特征名称将以小写类名前缀。例如，如果转换器输出 3 个特征，则输出特征名称为：
["class_name0", "class_name1", "class_name2"]。- 参数:
- input_features字符串的 array-like 或 None，默认值为 None
仅用于根据
fit中看到的名称验证特征名称。
- 返回:
- feature_names_out字符串对象的 ndarray
转换后的特征名称。
- get_metadata_routing()[source]#
获取此对象的元数据路由。
请查阅用户指南，了解路由机制的工作原理。
- 返回:
- routingMetadataRequest
一个封装路由信息的
MetadataRequest对象。
- get_params(deep=True)[source]#
获取此估计器的参数。
- 参数:
- deep布尔型，默认值为 True
如果为 True，将返回此估计器以及所包含的作为估计器的子对象的参数。
- 返回:
- params字典
参数名称映射到其值。
- radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[source]#
找到一个或多个点在给定半径内的邻居。
返回数据集中每个点在查询数组点周围半径为
radius的球体内所处的索引和距离。位于边界上的点也包含在结果中。结果点 *不* 一定按到查询点的距离排序。
- 参数:
- X{array-like, 稀疏矩阵}，形状为 (n_samples, n_features)，默认值为 None
查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
- radius浮点型，默认值为 None
要返回的邻居的限制距离。默认值为传递给构造函数的值。
- return_distance布尔型，默认值为 True
是否返回距离。
- sort_results布尔型，默认值为 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{array-like, 稀疏矩阵}，形状为 (n_samples, n_features)，默认值为 None
查询点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
- radius浮点型，默认值为 None
邻域的半径。默认值为传递给构造函数的值。
- mode{‘connectivity’, ‘distance’}，默认值为’connectivity’
返回矩阵的类型：‘connectivity’ 将返回包含一和零的连接矩阵，在 ‘distance’ 中，边是点之间的距离，距离类型取决于 NearestNeighbors 类中选择的度量参数。
- sort_results布尔型，默认值为 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.]])
- set_output(*, transform=None)[source]#
设置输出容器。
有关如何使用此 API 的示例，请参阅set_output API 介绍。
- 参数:
- transform{“default”, “pandas”, “polars”}，默认值为 None
配置
transform和fit_transform的输出。"default": 转换器的默认输出格式"pandas": DataFrame 输出"polars": Polars 输出None: 转换配置未更改
1.4 版本新增：添加了
"polars"选项。
- 返回:
- self估计器实例
估计器实例。