RadiusNeighborsClassifier#

class sklearn.neighbors.RadiusNeighborsClassifier(radius=1.0, *, weights='uniform', algorithm='auto', leaf_size=30, p=2, metric='minkowski', outlier_label=None, metric_params=None, n_jobs=None)[源代码]#

实现给定半径内邻居投票的分类器。

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

参数:

radius浮点型, 默认值=1.0

默认用于radius_neighbors查询的参数空间范围。

weights{'uniform', 'distance'}, 可调用对象或 None, 默认值='uniform'

预测中使用的权重函数。可能的值：

‘uniform’ : 均匀权重。每个邻域中的所有点都具有相同的权重。
‘distance’ : 按距离的倒数对点进行加权。在这种情况下，查询点附近更近的邻居将比更远的邻居具有更大的影响力。
[可调用对象] : 用户自定义函数，接受距离数组并返回包含权重的相同形状数组。

默认使用均匀权重。

algorithm{'auto', 'ball_tree', 'kd_tree', 'brute'}, 默认值='auto'

用于计算最近邻的算法

‘ball_tree’ 将使用 BallTree
‘kd_tree’ 将使用 KDTree
‘brute’ 将使用暴力搜索。
‘auto’ 将尝试根据传递给 fit 方法的值来决定最合适的算法。

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

leaf_size整型, 默认值=30

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

p浮点型, 默认值=2

Minkowski 度量的幂参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)；当 p = 2 时，等同于 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。此参数预期为正值。

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

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

如果度量为“precomputed”，则假定 X 是一个距离矩阵，并且在拟合期间必须为方阵。X 可以是稀疏图，在这种情况下，只有“非零”元素才可能被视为邻居。

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

outlier_label{手动标签, 'most_frequent'}, 默认值=None

异常样本（在给定半径内没有邻居的样本）的标签。

手动标签：字符串或整型标签（应与 y 的类型相同），如果使用多输出，则为手动标签列表。
‘most_frequent’ : 将 y 中最常见的标签分配给异常值。
None : 当检测到任何异常值时，将引发 ValueError。

异常值标签应从唯一的“Y”标签中选择。如果指定了不同的值，将引发警告，并且异常值的所有类概率都将设置为 0。

metric_params字典, 默认值=None

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

n_jobs整型, 默认值=None

邻居搜索要运行的并行作业数。None 表示 1，除非在 joblib.parallel_backend 上下文中。-1 表示使用所有处理器。有关更多详细信息，请参阅术语表。

属性:

classes_形状为 (n_classes,) 的 ndarray: 分类器已知的类别标签。
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_整型: 拟合数据中的样本数量。
outlier_label_整型或形状为 (n_class,) 的类数组对象: 为异常样本（在给定半径内没有邻居的样本）指定的标签。
outputs_2d_布尔型: 在拟合期间，当 y 的形状为 (n_samples, ) 或 (n_samples, 1) 时为 False，否则为 True。

另请参阅

KNeighborsClassifier: 实现 k-最近邻投票的分类器。
RadiusNeighborsRegressor: 基于固定半径内邻居的回归。
KNeighborsRegressor: 基于 k-最近邻的回归。
NearestNeighbors: 用于实现邻居搜索的无监督学习器。

注释

有关 algorithm 和 leaf_size 选择的讨论，请参阅在线文档中的最近邻。

https://en.wikipedia.org/wiki/K-nearest_neighbor_algorithm

示例

>>> X = [[0], [1], [2], [3]]
>>> y = [0, 0, 1, 1]
>>> from sklearn.neighbors import RadiusNeighborsClassifier
>>> neigh = RadiusNeighborsClassifier(radius=1.0)
>>> neigh.fit(X, y)
RadiusNeighborsClassifier(...)
>>> print(neigh.predict([[1.5]]))
[0]
>>> print(neigh.predict_proba([[1.0]]))
[[0.66666667 0.33333333]]

fit(X, y)[源代码]#

从训练数据集拟合半径邻居分类器。

参数:

X{类数组, 稀疏矩阵}, 形状为 (n_samples, n_features) 或 (n_samples, n_samples) 如果 metric='precomputed': 训练数据。
y{类数组, 稀疏矩阵}, 形状为 (n_samples,) 或 (n_samples, n_outputs): 目标值。

返回:

selfRadiusNeighborsClassifier: 拟合后的半径邻居分类器。

get_metadata_routing()[源代码]#

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

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

返回:

routingMetadataRequest: 一个包含路由信息的MetadataRequest。

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

获取此估计器的参数。

参数:

deep布尔型, 默认值=True: 如果为 True，将返回此估计器及其包含的子对象（如果它们是估计器）的参数。

返回:

params字典: 参数名称及其对应值的映射。

predict(X)[源代码]#

预测所提供数据的类别标签。

参数:

X{类数组, 稀疏矩阵}, 形状为 (n_queries, n_features)，如果 metric == 'precomputed' 则为 (n_queries, n_indexed)，或 None: 测试样本。如果为 None，则返回所有索引点的预测结果；在这种情况下，点不被视为其自身的邻居。

返回:

y形状为 (n_queries,) 或 (n_queries, n_outputs) 的 ndarray: 每个数据样本的类别标签。

predict_proba(X)[源代码]#

返回测试数据 X 的概率估计。

参数:

X{类数组, 稀疏矩阵}, 形状为 (n_queries, n_features)，如果 metric == 'precomputed' 则为 (n_queries, n_indexed)，或 None: 测试样本。如果为 None，则返回所有索引点的预测结果；在这种情况下，点不被视为其自身的邻居。

返回:

p形状为 (n_queries, n_classes) 的 ndarray，如果 n_outputs > 1，则为 n_outputs 个此类数组的列表。: 输入样本的类别概率。类别按字典顺序排序。

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

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

返回查询数组点周围半径为 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)[源代码]#

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

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

参数:

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] 表示连接 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.]])

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

返回给定测试数据和标签的平均准确度。

在多标签分类中，这是子集准确度，这是一个严格的度量，因为它要求每个样本的每个标签集都正确预测。

参数:

X形状为 (n_samples, n_features) 的类数组对象，或 None: 测试样本。如果为 None，则使用所有索引点的预测结果；在这种情况下，点不被视为其自身的邻居。这意味着 knn.fit(X, y).score(None, y) 隐式执行留一法交叉验证过程，等同于 cross_val_score(knn, X, y, cv=LeaveOneOut())，但通常快得多。
y形状为 (n_samples,) 或 (n_samples, n_outputs) 的类数组对象: X 的真实标签。
sample_weight形状为 (n_samples,) 的类数组对象, 默认值=None: 样本权重。

返回:

score浮点型: self.predict(X) 相对于 y 的平均准确度。

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

设置此估计器的参数。

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

参数:

**params字典: 估计器参数。

返回:

self估计器实例: 估计器实例。

set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') → RadiusNeighborsClassifier[源代码]#

请求传递给 score 方法的元数据。

请注意，此方法仅在 enable_metadata_routing=True 时相关（请参阅 sklearn.set_config）。请参阅用户指南以了解路由机制的工作原理。

每个参数的选项是：

True: 请求元数据，如果提供则传递给 score。如果未提供元数据，则忽略该请求。
False: 不请求元数据，元估计器不会将其传递给 score。
None: 不请求元数据，如果用户提供，元估计器将引发错误。
str: 元数据应使用此给定别名而非原始名称传递给元估计器。

默认值 (sklearn.utils.metadata_routing.UNCHANGED) 保留现有请求。这允许您更改某些参数的请求，而不更改其他参数。

1.3 版本新增。

注意

此方法仅在将此估计器用作元估计器（例如在 Pipeline 内部使用）的子估计器时才相关。否则它没有效果。

参数:

sample_weight字符串, True, False, 或 None, 默认值=sklearn.utils.metadata_routing.UNCHANGED: 在 score 中 sample_weight 参数的元数据路由。

返回:

self对象: 更新后的对象。

RadiusNeighborsClassifier#

此页