半径近邻变换器#

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’}, 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中列出的度量。

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

不支持距离矩阵。

pfloat, default=2

来自 sklearn.metrics.pairwise.pairwise_distances 的 Minkowski 度量的参数。当 p = 1 时,这等效于使用 manhattan_distance (l1),而 p = 2 时则为 euclidean_distance (l2)。对于任意 p,使用 minkowski_distance (l_p)。此参数应为正数。

metric_paramsdict, default=None

度量函数的其他关键字参数。

n_jobsint, default=None

为邻居搜索运行的并行作业数。如果为-1,则作业数设置为 CPU 内核数。

属性:
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

拟合期间看到的特征数量。

0.24版本新增。

feature_names_in_ndarray of shape (n_features_in_,)

拟合期间看到的特征名称。仅当X具有全部为字符串的特征名称时才定义。

1.0版本新增。

n_samples_fit_int

拟合数据中的样本数。

另请参见

K 近邻图

计算X中点的k近邻的加权图。

K 近邻变换器

将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, sparse matrix} of shape (n_samples, n_features) or (n_samples, n_samples) if metric=’precomputed’

训练数据。

yIgnored

未使用,根据约定保留以保持API一致性。

返回:
selfRadiusNeighborsTransformer

拟合的半径邻域变换器。

fit_transform(X, y=None)[source]#

先拟合数据,然后转换数据。

使用可选参数 `fit_params` 将转换器拟合到 X 和 y,并返回 X 的转换版本。

参数:
X形状为 (n_samples, n_features) 的类数组

训练集。

yIgnored

未使用,根据约定保留以保持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字符串类数组或 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形状为 (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中点的(加权)邻域图。

邻域限制在距离小于radius的点。

参数:
X形状为(n_samples, n_features)的{类数组,稀疏矩阵},默认为None

查询点或多个点。如果未提供,则返回每个索引点的邻居。在这种情况下,查询点不被认为是其自身的邻居。

radius浮点数,默认为 None

邻域半径。默认为构造函数中传递的值。

mode{'connectivity', 'distance'},默认为'connectivity'

返回矩阵的类型:'connectivity'将返回包含1和0的连接矩阵,在'distance'中,边是点之间的距离,距离的类型取决于NearestNeighbors类中选择的度量参数。

sort_results布尔值,默认为 False

如果为True,则在结果的每一行中,非零条目将按距离递增排序。如果为False,则非零条目可能不会排序。仅在mode='distance'时使用。

0.22版本新增。

返回:
A形状为(n_queries, n_samples_fit)的稀疏矩阵

n_samples_fit是拟合数据中的样本数。A[i, j]给出连接ij的边的权重。矩阵为CSR格式。

另请参见

K 近邻图

计算X中点的k-邻域的(加权)图。(这句话与p1重复,可以考虑删除)

示例

>>> 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]#

设置输出容器。

参见 Introducing the set_output API 了解如何使用API的示例。

参数:
transform{"default", "pandas", "polars"},默认为None

配置transformfit_transform的输出。

  • "default":转换器的默认输出格式

  • "pandas":DataFrame输出

  • "polars":Polars输出

  • None:转换配置保持不变

1.4版本新增:"polars"选项已添加。

返回:
self估计器实例

估计器实例。

set_params(**params)[source]#

设置此估计器的参数。

此方法适用于简单的估计器以及嵌套对象(例如Pipeline)。后者具有<component>__<parameter>形式的参数,因此可以更新嵌套对象的每个组件。

参数:
**params字典

估计器参数。

返回:
self估计器实例

估计器实例。

transform(X)[source]#

计算X中点的(加权)邻域图。

参数:
X形状为(n_samples_transform, n_features)的类数组

样本数据。

返回:
Xt形状为(n_samples_transform, n_samples_fit)的稀疏矩阵

Xt[i, j] 表示连接 i 和 j 的边的权重。只有邻居节点之间具有显式值。对角线总是显式值。矩阵采用 CSR 格式。