半径近邻分类器#
- 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)[source]#
实现给定半径内邻居投票的分类器。
更多信息请参见用户指南。
- 参数：
- radiusfloat, default=1.0
默认情况下，用于
radius_neighbors查询的参数空间范围。- weights{‘uniform’, ‘distance’}, callable or None, default=’uniform’
预测中使用的权重函数。可能的值
‘uniform’：均匀权重。每个邻域中的所有点权重相等。
‘distance’：根据距离的倒数加权点。在这种情况下，查询点的较近邻域将比较远邻域具有更大的影响。
[callable]：用户定义的函数，它接受一个距离数组，并返回一个包含权重的相同形状的数组。
默认使用均匀权重。
- 算法{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, 默认值='auto’
用于计算最近邻的算法
注意：对稀疏输入进行拟合将覆盖此参数的设置，使用暴力搜索。
- leaf_sizeint, 默认值=30
传递给 BallTree 或 KDTree 的叶子大小。这会影响构建和查询的速度，以及存储树所需的内存。最佳值取决于问题的性质。
- pfloat, 默认值=2
Minkowski 度量的幂参数。当 p = 1 时，这等效于使用曼哈顿距离 (l1)，而对于 p = 2，则使用欧几里得距离 (l2)。对于任意 p，使用 minkowski 距离 (l_p)。此参数应为正数。
- metricstr 或 callable，默认值='minkowski’
用于距离计算的度量。默认为“minkowski”，当 p = 2 时，结果为标准欧几里得距离。有关有效的度量值，请参见 scipy.spatial.distance 的文档和
distance_metrics中列出的度量。如果度量为“预计算”，则假定 X 为距离矩阵，并且在拟合过程中必须为方阵。X 可以是 稀疏图，在这种情况下，只有“非零”元素可以被视为邻居。
如果度量是可调用函数，则它将两个表示一维向量的数组作为输入，并且必须返回一个值，表示这些向量之间的距离。这适用于 Scipy 的度量，但效率低于将度量名称作为字符串传递。
- outlier_label{手动标签，‘most_frequent’}，默认值=None
异常值样本的标签（在给定半径内没有邻居的样本）。
手动标签：str 或 int 标签（应与 y 类型相同）或如果使用多输出则为手动标签列表。
‘most_frequent’：将 y 的最频繁标签分配给异常值。
None：检测到任何异常值时，将引发 ValueError。
异常值标签应从唯一的“Y”标签中选择。如果使用不同的值指定它，则会发出警告，并且异常值的所有类概率都将被分配为 0。
- metric_paramsdict, 默认值=None
度量函数的其他关键字参数。
- n_jobsint, 默认值=None
为邻居搜索运行的并行作业数。
None表示 1，除非在joblib.parallel_backend上下文中。-1表示使用所有处理器。有关更多详细信息，请参见 词汇表。
- 属性:
- classes_形状为 (n_classes,) 的 ndarray
分类器已知的类标签。
- effective_metric_str 或 callable
使用的距离度量。它将与
metric参数相同，或者它的同义词，例如，如果metric参数设置为’minkowski’并且p参数设置为 2，则为’euclidean’。- effective_metric_params_dict
度量函数的其他关键字参数。对于大多数度量，它将与
metric_params参数相同，但也可能包含p参数值（如果effective_metric_属性设置为’minkowski’）。- n_features_in_int
在 拟合期间看到的特征数量。
在 0.24 版中添加。
- feature_names_in_形状为 (
n_features_in_,) 的 ndarray 在 拟合期间看到的特征名称。仅当
X具有全部为字符串的特征名称时才定义。在 1.0 版中添加。
- n_samples_fit_int
拟合数据中的样本数。
- outlier_label_int 或形状为 (n_class,) 的类似数组
为异常值样本（在给定半径内没有邻居的样本）提供的标签。
- outputs_2d_bool
当在拟合期间
y的形状为 (n_samples,) 或 (n_samples, 1) 时为 False，否则为 True。
备注
请参阅在线文档中的 最近邻，了解
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)[source]#
从训练数据集拟合半径邻居分类器。
- 参数：
- X形状为 (n_samples, n_features) 或 (n_samples, n_samples) 的{类数组，稀疏矩阵}（如果 metric='precomputed’）
训练数据。
- y形状为 (n_samples,) 或 (n_samples, n_outputs) 的{类数组，稀疏矩阵}
目标值。
- 返回值:
- selfRadiusNeighborsClassifier
拟合的半径邻居分类器。
- get_metadata_routing()[source]#
获取此对象的元数据路由。
请查看用户指南，了解路由机制的工作原理。
- 返回值:
- routingMetadataRequest
一个
MetadataRequest，封装了路由信息。
- get_params(deep=True)[source]#
获取此估计器的参数。
- 参数：
- deepbool, default=True
如果为 True，则将返回此估计器和包含的作为估计器的子对象的参数。
- 返回值:
- paramsdict
参数名称与其值的映射。
- predict(X)[source]#
预测提供数据的类别标签。
- 参数：
- X{array-like, sparse matrix} of shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’, or None
测试样本。如果为
None，则返回所有索引点的预测；在这种情况下，点不被认为是其自身的邻居。
- 返回值:
- yndarray of shape (n_queries,) or (n_queries, n_outputs)
每个数据样本的类别标签。
- predict_proba(X)[source]#
返回测试数据 X 的概率估计。
- 参数：
- X{array-like, sparse matrix} of shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’, or None
测试样本。如果为
None，则返回所有索引点的预测；在这种情况下，点不被认为是其自身的邻居。
- 返回值:
- pndarray of shape (n_queries, n_classes), or a list of n_outputs of such arrays if n_outputs > 1.
输入样本的类别概率。类别按字典序排序。
- radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[source]#
查找点或点周围给定半径内的邻居。
返回数据集每个点到查询数组点的球体（大小为
radius）内的索引和距离。位于边界上的点包含在结果中。结果点不一定按与其查询点的距离排序。
- 参数：
- X{array-like, sparse matrix} of (n_samples, n_features), default=None
查询点或点。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被认为是其自身的邻居。
- radiusfloat, default=None
要返回的邻居的限制距离。默认为传递给构造函数的值。
- return_distancebool, default=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)[source]#
计算 X 中点的邻居的（加权）图。
邻域限制在距离小于半径的点。
- 参数：
- 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 格式。
另请参见
K近邻图计算 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)[source]#
返回给定测试数据和标签上的平均准确率。
在多标签分类中，这是子集准确率，这是一个严格的度量，因为您要求对每个样本来说，每个标签集都必须被正确预测。
- 参数：
- 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)[source]#
设置此估计器的参数。
此方法适用于简单的估计器以及嵌套对象（例如
Pipeline）。后者具有<component>__<parameter>形式的参数，因此可以更新嵌套对象的每个组件。- 参数：
- **params字典
估计器参数。
- 返回值:
- self估计器实例
估计器实例。
- set_score_request(*, sample_weight: bool | None | str = '$UNCHANGED$') RadiusNeighborsClassifier[source]#
请求传递给
score方法的元数据。请注意，只有在
enable_metadata_routing=True时，此方法才相关（参见sklearn.set_config）。请参阅 用户指南，了解路由机制的工作原理。每个参数的选项是
True：请求元数据，如果提供则将其传递给score。如果未提供元数据，则忽略请求。False：不请求元数据，元估计器不会将其传递给score。None：不请求元数据，如果用户提供元数据，则元估计器将引发错误。str：元数据应使用此给定的别名而不是原始名称传递给元估计器。
默认值（
sklearn.utils.metadata_routing.UNCHANGED）保留现有的请求。这允许您更改某些参数的请求，而无需更改其他参数。1.3 版中添加。
注意
只有在此估计器用作元估计器的子估计器时（例如，在
Pipeline中使用），此方法才相关。否则，它没有效果。- 参数：
- sample_weightstr、True、False 或 None，默认为 sklearn.utils.metadata_routing.UNCHANGED
score中sample_weight参数的元数据路由。
- 返回值:
- self对象
更新后的对象。