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 .

阅读更多的 User Guide .

Added in version 0.22.

参数:
mode'距离','连通性'},默认='距离'

返回的矩阵类型:“连通性”将返回包含1和0的连通性矩阵,而“距离”将根据给定的指标返回邻居之间的距离。

radiusfloat,默认=1.0

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

algorithm'自动',' ball_tree ',',',默认='自动'

用于计算最近邻居的算法:

  • 'ball_tree'将使用 BallTree

  • 'kd_tree'将使用 KDTree

  • “brute”将使用暴力搜索。

  • “Auto”将尝试根据传递给 fit

注意:在稀疏输入上进行调整将使用暴力覆盖此参数的设置。

leaf_sizeint,默认=30

叶大小传递到BallTree或KDTree。 这可能会影响构建和查询的速度,以及存储树所需的内存。 最佳值取决于问题的性质。

metric字符串或可调用,默认=' minkowski '

用于距离计算的指标。默认值是“minkowski”,当p = 2时,它会产生标准的欧几里得距离。请参阅文档 scipy.spatial.distance 以及中列出的指标 distance_metrics 获取有效的指标值。

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

不支持距离矩阵。

pfloat,默认=2

Minkowski指标的参数来自sklearn.metrics.pairwise.pairwise_diversions。当p = 1时,这相当于对于p = 2使用manhattan_Distance(l1)和euclidean_Distance(l2)。对于任意p,使用minkowski_Distance(l_p)。该参数预计为正值。

metric_paramsdict,默认=无

指标函数的附加关键字参数。

n_jobsint,默认=无

为邻居搜索运行的并行作业数。如果 -1 ,则作业数量设置为中央处理器核心数量。

属性:
effective_metric_字符串或可调用

使用的距离指标。它将与 metric 参数或其同义词,例如“欧几里得”,如果 metric 参数设置为“minkowski”, p 参数设置为2。

effective_metric_params_dict

指标函数的附加关键字参数。对于大多数指标将与 metric_params 参数,但也可能包含 p 如果 effective_metric_ 属性设置为“minkowski”。

n_features_in_int

期间看到的功能数量 fit .

Added in version 0.24.

feature_names_in_ :nd形状数组 (n_features_in_ ,)nd数组形状(

Names of features seen during fit. Defined only when X has feature names that are all strings.

Added in version 1.0.

n_samples_fit_int

匹配数据中的样本数量。

参见

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)[源代码]#

根据训练数据集匹配半径邻居Transformer。

参数:
X形状(n_samples,n_features)的{类数组,稀疏矩阵}或 (n_samples,n_samples)如果指标='预先计算'

训练数据。

y忽视

未使用,按照惯例,为了API一致性而存在。

返回:
selfRadiusNeighborsTransformer

装配半径邻近Transformer。

fit_transform(X, y=None)[源代码]#

适应数据,然后对其进行转换。

使用可选参数fit_params将Transformer器匹配到X和y,并返回X的转换版本。

参数:
X形状类似阵列(n_samples,n_features)

训练装备。

y忽视

未使用,按照惯例,为了API一致性而存在。

返回:
Xt形状稀疏矩阵(n_samples,n_samples)

XT [i, j] 被分配了连接i到j的边的权重。只有邻居才有显式的值。对角线总是明确的。该矩阵为CSR格式。

get_feature_names_out(input_features=None)[源代码]#

获取用于转换的输出要素名称。

输出的功能名称将以大写的类别名称为开头。例如,如果Transformer输出3个特征,则输出的特征名称为: ["class_name0", "class_name1", "class_name2"] .

参数:
input_features字符串或无的类数组,默认=无

仅用于通过中看到的名称验证要素名称 fit .

返回:
feature_names_out字符串对象的nd数组

转换的功能名称。

get_metadata_routing()[源代码]#

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

请检查 User Guide 关于路由机制如何工作。

返回:
routingMetadataRequest

A MetadataRequest 封装路由信息。

get_params(deep=True)[源代码]#

获取此估计器的参数。

参数:
deep布尔,默认=True

如果为True,将返回此估计量和包含的作为估计量的子对象的参数。

返回:
paramsdict

参数名称映射到其值。

radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[源代码]#

查找一个或多个点给定半径内的邻居。

返回位于具有大小的球体中的数据集中每个点的指数和距离 radius 在查询数组的点周围。位于边界上的点包括在结果中。

结果点是 not 必须按到查询点的距离排序。

参数:
X{类数组,稀疏矩阵},(n_samples,n_features),默认=无

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

radiusfloat,默认=无

限制邻居返回的距离。默认值是传递给构造函数的值。

return_distance布尔,默认=True

是否返回距离。

sort_results布尔,默认=假

如果为True,距离和指数将在返回之前按照距离的增加进行排序。如果为假,则可能不会对结果进行排序。如果 return_distance=False 、设置 sort_results=True 将导致错误。

Added in version 0.22.

返回:
neigh_dist数组形状(n_samples,)的nd数组

代表每个点的距离的数组,仅在以下情况下存在 return_distance=True .距离值根据 metric 构造函数参数。

neigh_ind数组形状(n_samples,)的nd数组

位于大小球内的人口矩阵的大约最近点的指数数组 radius 围绕查询点。

注意到

由于每个点的邻居数量不一定相等,因此多个查询点的结果无法适合标准数据数组。为了提高效率, radius_neighbors 返回对象数组,其中每个对象都是索引或距离的1D数组。

示例

在下面的示例中,我们从代表数据集的数组中构建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形状(n_samples,n_features)的{类数组,稀疏矩阵},默认=无

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

radiusfloat,默认=无

社区的半径。默认值是传递给构造函数的值。

mode'连通性',',默认='连通性'

返回的矩阵类型:“连通性”将返回包含1和0的连通性矩阵,在“距离”中,边是点之间的距离,距离类型取决于NearestNeighbors类中所选的指标参数。

sort_results布尔,默认=假

如果为True,则在结果的每一行中,非零条目将按距离增加进行排序。如果为False,则可能不会对非零条目进行排序。仅与模式='距离'一起使用。

Added in version 0.22.

返回:
A形状稀疏矩阵(n_questions,n_samples_fit)

n_samples_fit 是匹配数据中的样本数。 A[i, j] 给出连接边缘的重量 ij .该矩阵为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)[源代码]#

设置输出容器。

看到 介绍 set_output API 了解如何使用API的示例。

参数:
transform{“默认”,“pandas”,“polars”},默认=无

配置输出 transformfit_transform .

  • "default" :Transformer的默认输出格式

  • "pandas" :DataFrame输出

  • "polars" :两极输出

  • None :转换配置不变

Added in version 1.4: "polars" 添加了选项。

返回:
self估计器实例

估计实例。

set_params(**params)[源代码]#

设置此估计器的参数。

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

参数:
**paramsdict

估计参数。

返回:
self估计器实例

估计实例。

transform(X)[源代码]#

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

参数:
X形状类似阵列(n_samples_transform,n_features)

样本数据。

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

XT [i, j] 被分配了连接i到j的边的权重。只有邻居才有显式的值。对角线总是明确的。该矩阵为CSR格式。