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)[源代码]#
实现给定半径内邻居投票的分类器。
在 用户指南 中阅读更多内容。
- 参数:
- radiusfloat, default=1.0
默认情况下,用于
radius_neighbors查询的参数空间范围。- weights{‘uniform’, ‘distance’}, callable 或 None, 默认值=’uniform’
预测中使用的权重函数。可能的值:
‘uniform’:均匀权重。邻域中的所有点都具有相同的权重。
‘distance’:按距离的倒数对点进行加权。在这种情况下,查询点越近的邻居将比越远的邻居具有更大的影响力。
[callable] : 一个用户定义的函数,它接受一个距离数组,并返回一个具有相同形状的数组,其中包含权重。
默认使用均匀权重。
- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’
用于计算最近邻居的算法
注意:对稀疏输入进行拟合将覆盖此参数的设置,使用暴力方法。
- leaf_sizeint, default=30
传递给 BallTree 或 KDTree 的叶子大小。这会影响构建和查询的速度,以及存储树所需的内存。最佳值取决于问题的性质。
- pfloat, default=2
Minkowski 度量的幂参数。当 p = 1 时,这相当于使用 manhattan_distance (l1),而 p = 2 时使用 euclidean_distance (l2)。对于任意 p,使用 minkowski_distance (l_p)。此参数预期为正数。
- metricstr or callable, default=’minkowski’
用于距离计算的度量。默认为“minkowski”,当 p = 2 时,它会产生标准的欧几里得距离。有关有效的度量值,请参阅scipy.spatial.distance的文档以及
distance_metrics中列出的度量。如果 metric 为 “precomputed”,则 X 被假定为一个距离矩阵,并且在 fit 时必须是方形的。X 可以是 稀疏图,在这种情况下,只有“非零”元素可能被视为邻居。
如果 metric 是可调用函数,它接受表示 1D 向量的两个数组作为输入,并且必须返回一个值来指示这些向量之间的距离。这适用于 Scipy 的度量,但效率低于将度量名称作为字符串传递。
- outlier_label{手动标签, ‘most_frequent’}, 默认=None
异常值样本的标签(在给定半径内没有邻居的样本)。
手动标签:str 或 int 标签(应与 y 的类型相同),如果使用多输出,则为手动标签列表。
‘most_frequent’ :将 y 的最常见标签分配给异常值。
None :检测到任何异常值时,将引发 ValueError。
异常值标签应从唯一的 ‘Y’ 标签中选择。如果指定了不同的值,将发出警告,并将所有异常值的类概率都设置为 0。
- metric_paramsdict, default=None
度量函数的附加关键字参数。
- n_jobsint, default=None
用于邻居搜索的并行作业数。
None表示 1,除非在joblib.parallel_backend上下文中。-1表示使用所有处理器。有关详细信息,请参阅 词汇表。
- 属性:
- classes_ndarray of shape (n_classes,)
分类器已知的类标签。
- 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
拟合数据中的样本数量。
- outlier_label_int 或 array-like,形状为 (n_class,)
为异常值样本(在给定半径内没有邻居的样本)指定的标签。
- outputs_2d_bool
在 fit 期间,当 `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{array-like, sparse matrix} of shape (n_samples,) or (n_samples, n_outputs)
目标值。
- 返回:
- selfRadiusNeighborsClassifier
已拟合的半径近邻分类器。
- get_metadata_routing()[源代码]#
获取此对象的元数据路由。
请查阅 用户指南,了解路由机制如何工作。
- 返回:
- routingMetadataRequest
封装路由信息的
MetadataRequest。
- get_params(deep=True)[源代码]#
获取此估计器的参数。
- 参数:
- deepbool, default=True
如果为 True,将返回此估计器以及包含的子对象(如果它们是估计器)的参数。
- 返回:
- paramsdict
参数名称映射到其值。
- predict(X)[源代码]#
预测输入数据的类标签。
- 参数:
- X{array-like, sparse matrix} of shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’, or None
测试样本。如果为
None,则返回所有索引点的预测;在这种情况下,点不被视为其自身的邻居。
- 返回:
- yndarray,形状为 (n_queries,) 或 (n_queries, n_outputs)
每个数据样本的类标签。
- predict_proba(X)[源代码]#
返回测试数据 X 的概率估计。
- 参数:
- X{array-like, sparse matrix} of shape (n_queries, n_features), or (n_queries, n_indexed) if metric == ‘precomputed’, or None
测试样本。如果为
None,则返回所有索引点的预测;在这种情况下,点不被视为其自身的邻居。
- 返回:
- pndarray,形状为 (n_queries, n_classes),或当 n_outputs > 1 时,为包含此类数组的列表(长度为 n_outputs)。
输入样本的类概率。类按字典顺序排序。
- 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.]])
- score(X, y, sample_weight=None)[源代码]#
Return the mean accuracy on the given test data and labels.
在多标签分类中,这是子集准确率 (subset accuracy),这是一个严格的指标,因为它要求每个样本的每个标签集都被正确预测。
- 参数:
- Xarray-like,形状为 (n_samples, n_features),或 None
测试样本。如果为 `None`,则使用所有索引点的预测;在这种情况下,点不被视为自身的邻居。这意味着 `knn.fit(X, y).score(None, y)` 隐式执行留一法交叉验证过程,并且等效于 `cross_val_score(knn, X, y, cv=LeaveOneOut())`,但通常快得多。
- yshape 为 (n_samples,) 或 (n_samples, n_outputs) 的 array-like
X的真实标签。- sample_weightshape 为 (n_samples,) 的 array-like, default=None
样本权重。
- 返回:
- scorefloat
self.predict(X)相对于y的平均准确率。
- set_params(**params)[源代码]#
设置此估计器的参数。
此方法适用于简单的估计器以及嵌套对象(如
Pipeline)。后者具有<component>__<parameter>形式的参数,以便可以更新嵌套对象的每个组件。- 参数:
- **paramsdict
估计器参数。
- 返回:
- selfestimator instance
估计器实例。
- 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 中新增。
- 参数:
- sample_weightstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED
score方法中sample_weight参数的元数据路由。
- 返回:
- selfobject
更新后的对象。