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 转换为比半径更近的邻居的（加权）图。

The transformed data is a sparse graph as returned by radius_neighbors_graph.

Read more in the User Guide.

版本 0.22 新增。

参数:

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

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

radiusfloat, default=1.0

Radius of neighborhood in the transformed sparse graph.

algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’

用于计算最近邻居的算法

• ‘ball_tree’ 将使用 BallTree

• ‘kd_tree’ 将使用 KDTree

• 'brute' 将使用暴力搜索。

• ‘auto’ will attempt to decide the most appropriate algorithm based on the values passed to fit method.

注意：对稀疏输入进行拟合将覆盖此参数的设置，使用暴力方法。

leaf_sizeint, default=30

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

metricstr or callable, default=’minkowski’

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

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

不支持距离矩阵。

pfloat, default=2

Parameter for the Minkowski metric from sklearn.metrics.pairwise.pairwise_distances. When p = 1, this is equivalent to using manhattan_distance (l1), and euclidean_distance (l2) for p = 2. For arbitrary p, minkowski_distance (l_p) is used. This parameter is expected to be positive.

metric_paramsdict, default=None

度量函数的附加关键字参数。

n_jobsint, default=None

The number of parallel jobs to run for neighbors search. If -1, then the number of jobs is set to the number of CPU cores.

属性:

effective_metric_str 或 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_shape 为 (n_features_in_,) 的 ndarray

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

1.0 版本新增。

n_samples_fit_int

拟合数据中的样本数量。

另请参阅

kneighbors_graph

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

KNeighborsTransformer

Transform X into a weighted graph of k nearest neighbors.

示例

>>> 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)

Fit the radius neighbors transformer from the training dataset.

参数:

X{类数组, 稀疏矩阵}，形状为 (n_samples, n_features) 或 (n_samples, n_samples) 如果 metric='precomputed'

训练数据。

y被忽略

未使用，按照惯例为保持 API 一致性而存在。

返回:

selfRadiusNeighborsTransformer

The fitted radius neighbors transformer.

fit_transform(X, y=None)

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

Fits transformer to X and y with optional parameters fit_params and returns a transformed version of X.

参数:

Xshape 为 (n_samples, n_features) 的 array-like

Training set.

y被忽略

未使用，按照惯例为保持 API 一致性而存在。

返回:

Xtsparse matrix of shape (n_samples, n_samples)

Xt[i, j] is assigned the weight of edge that connects i to j. Only the neighbors have an explicit value. The diagonal is always explicit. The matrix is of CSR format.

get_feature_names_out(input_features=None)

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

The feature names out will prefixed by the lowercased class name. For example, if the transformer outputs 3 features, then the feature names out are: ["class_name0", "class_name1", "class_name2"].

参数:

input_featuresarray-like of str or None, default=None

Only used to validate feature names with the names seen in fit.

返回:

feature_names_outstr 对象的 ndarray

转换后的特征名称。

get_metadata_routing()

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

请查阅 用户指南，了解路由机制如何工作。

返回:

routingMetadataRequest

封装路由信息的 MetadataRequest。

get_params(deep=True)

获取此估计器的参数。

参数:

deepbool, default=True

如果为 True，将返回此估计器以及包含的子对象（如果它们是估计器）的参数。

返回:

paramsdict

参数名称映射到其值。

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

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

返回查询数组的点在半径为 radius 的球体内的点到数据集的距离和索引。边界上的点包含在结果中。

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

参数:

X{array-like, sparse matrix} of (n_samples, n_features), default=None

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

radiusfloat, default=None

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

return_distance布尔值，默认=True

是否返回距离。

sort_resultsbool, default=False

如果为 True，则在返回之前，距离和索引将按递增距离排序。如果为 False，则结果可能未排序。如果 return_distance=False，则设置 sort_results=True 将导致错误。

版本 0.22 新增。

返回:

neigh_distndarray of shape (n_samples,) of arrays

表示到每个点的距离的数组，仅当 return_distance=True 时才存在。距离值根据 metric 构造函数参数计算。

neigh_indndarray of shape (n_samples,) of arrays

一个数组，包含位于查询点周围大小为 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 中点的 Neighbors（加权）图。

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

参数:

X{array-like, sparse matrix} of shape (n_samples, n_features), default=None

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

radiusfloat, default=None

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

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

返回矩阵的类型：‘connectivity’ 将返回包含 1 和 0 的连通性矩阵，‘distance’ 中边是点之间的距离，距离类型取决于 NearestNeighbors 类中选择的度量参数。

sort_resultsbool, default=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-Neighbors（加权）图。

示例

>>> 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)

设置输出容器。

有关如何使用 API 的示例，请参阅引入 set_output API。

参数:

transform{“default”, “pandas”, “polars”}, default=None

配置 transform 和 fit_transform 的输出。

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

• "pandas": DataFrame 输出

• "polars": Polars 输出

• None: 转换配置保持不变

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

返回:

selfestimator instance

估计器实例。

set_params(**params)

设置此估计器的参数。

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

参数:

**paramsdict

估计器参数。

返回:

selfestimator instance

估计器实例。

transform(X)

计算 X 中点的 Neighbors（加权）图。

参数:

Xarray-like of shape (n_samples_transform, n_features)

样本数据。

返回:

Xtsparse matrix of shape (n_samples_transform, n_samples_fit)

Xt[i, j] is assigned the weight of edge that connects i to j. Only the neighbors have an explicit value. The diagonal is always explicit. The matrix is of CSR format.