KNeighborsTransformer#
- class sklearn.neighbors.KNeighborsTransformer(*, mode='distance', n_neighbors=5, algorithm='auto', leaf_size=30, metric='minkowski', p=2, metric_params=None, n_jobs=None)[source]#
将 X 转换为 k 最近邻的（加权）图。
转换后的数据是一个稀疏图，由 kneighbors_graph 返回。
在用户指南中阅读更多信息。
版本 0.22 新增。
- 参数:
- mode{'distance', 'connectivity'}，默认='distance'
返回矩阵的类型：‘connectivity’将返回连接矩阵，其中包含1和0，‘distance’将根据给定的度量返回邻居之间的距离。
- n_neighborsint, default=5
转换后的稀疏图中每个样本的邻居数量。出于兼容性原因，由于每个样本都被视为其自身的邻居，因此当 mode == 'distance' 时，将额外计算一个邻居。在这种情况下，稀疏图包含 (n_neighbors + 1) 个邻居。
- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’
用于计算最近邻居的算法
注意：对稀疏输入进行拟合将覆盖此参数的设置，使用暴力方法。
- 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
来自 sklearn.metrics.pairwise.pairwise_distances 的 Minkowski 度量的参数。当 p = 1 时，这等同于使用 manhattan_distance (l1)；当 p = 2 时，等同于使用 euclidean_distance (l2)。对于任意 p，使用 minkowski_distance (l_p)。此参数预期为正数。
- metric_paramsdict, default=None
度量函数的附加关键字参数。
- n_jobsint, default=None
用于邻居搜索的并行作业数量。如果为
-1，则作业数量设置为 CPU 核心数量。
- 属性:
- 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-邻居加权图。
RadiusNeighborsTransformer将 X 转换为一个半径内邻居的加权图。
注意事项
有关
KNeighborsTransformer与TSNE结合使用的示例，请参见 TSNE 中的近似最近邻。示例
>>> from sklearn.datasets import load_wine >>> from sklearn.neighbors import KNeighborsTransformer >>> X, _ = load_wine(return_X_y=True) >>> X.shape (178, 13) >>> transformer = KNeighborsTransformer(n_neighbors=5, mode='distance') >>> X_dist_graph = transformer.fit_transform(X) >>> X_dist_graph.shape (178, 178)
- fit(X, y=None)[source]#
从训练数据集拟合 k-最近邻转换器。
- 参数:
- X{类数组, 稀疏矩阵}，形状为 (n_samples, n_features) 或 (n_samples, n_samples) 如果 metric='precomputed'
训练数据。
- y被忽略
未使用，按照惯例为保持 API 一致性而存在。
- 返回:
- selfKNeighborsTransformer
拟合的 k-最近邻转换器。
- fit_transform(X, y=None)[source]#
拟合数据，然后对其进行转换。
使用可选参数 fit_params 拟合转换器到 X 和 y，并返回 X 的转换版本。
- 参数:
- Xshape 为 (n_samples, n_features) 的 array-like
Training set.
- y被忽略
未使用，按照惯例为保持 API 一致性而存在。
- 返回:
- Xt稀疏矩阵，形状为 (n_samples, n_samples)
Xt[i, j] 被赋为连接 i 到 j 的边的权重。只有邻居才有明确的值。对角线总是明确的。矩阵为 CSR 格式。
- get_feature_names_out(input_features=None)[source]#
获取转换的输出特征名称。
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()[source]#
获取此对象的元数据路由。
请查阅 用户指南，了解路由机制如何工作。
- 返回:
- routingMetadataRequest
封装路由信息的
MetadataRequest。
- get_params(deep=True)[source]#
获取此估计器的参数。
- 参数:
- deepbool, default=True
如果为 True，将返回此估计器以及包含的子对象（如果它们是估计器）的参数。
- 返回:
- paramsdict
参数名称映射到其值。
- kneighbors(X=None, n_neighbors=None, return_distance=True)[source]#
找到一个点的 K-邻居。
返回每个点的邻居的索引和距离。
- 参数:
- X{类数组, 稀疏矩阵}，形状为 (n_queries, n_features)，如果 metric == ‘precomputed’ 则为 (n_queries, n_indexed)，默认=None
查询点或点集。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。
- n_neighborsint, default=None
每个样本所需的邻居数量。默认值为构造函数中传递的值。
- return_distance布尔值，默认=True
是否返回距离。
- 返回:
- neigh_distndarray，形状为 (n_queries, n_neighbors)
表示到点的长度的数组，仅当 return_distance=True 时存在。
- neigh_indndarray，形状为 (n_queries, n_neighbors)
总体矩阵中最近点的索引。
示例
在以下示例中，我们从表示我们数据集的数组构建了一个 NearestNeighbors 类，并询问哪个点离 [1,1,1] 最近。
>>> samples = [[0., 0., 0.], [0., .5, 0.], [1., 1., .5]] >>> from sklearn.neighbors import NearestNeighbors >>> neigh = NearestNeighbors(n_neighbors=1) >>> neigh.fit(samples) NearestNeighbors(n_neighbors=1) >>> print(neigh.kneighbors([[1., 1., 1.]])) (array([[0.5]]), array([[2]]))
正如您所看到的，它返回 [[0.5]] 和 [[2]]，这意味着该元素距离为 0.5，并且是样本中的第三个元素（索引从 0 开始）。您还可以查询多个点。
>>> X = [[0., 1., 0.], [1., 0., 1.]] >>> neigh.kneighbors(X, return_distance=False) array([[1], [2]]...)
- kneighbors_graph(X=None, n_neighbors=None, mode='connectivity')[source]#
计算 X 中点的 k-Neighbors（加权）图。
- 参数:
- X{类数组, 稀疏矩阵}，形状为 (n_queries, n_features)，如果 metric == ‘precomputed’ 则为 (n_queries, n_indexed)，默认=None
查询点或点集。如果未提供，则返回每个索引点的邻居。在这种情况下，查询点不被视为其自身的邻居。对于
metric='precomputed'，形状应为 (n_queries, n_indexed)。否则，形状应为 (n_queries, n_features)。- n_neighborsint, default=None
每个样本的邻居数量。默认值为构造函数中传递的值。
- mode{‘connectivity’, ‘distance’}, default=’connectivity’
返回矩阵的类型：‘connectivity’ 将返回包含 1 和 0 的连通性矩阵，‘distance’ 中边是点之间的距离，距离类型取决于 NearestNeighbors 类中选择的度量参数。
- 返回:
- A稀疏矩阵，形状为 (n_queries, n_samples_fit)
n_samples_fit是拟合数据中的样本数量。A[i, j]给出连接i到j的边的权重。矩阵为 CSR 格式。
另请参阅
NearestNeighbors.radius_neighbors_graph计算 X 中点的 Neighbors（加权）图。
示例
>>> X = [[0], [3], [1]] >>> from sklearn.neighbors import NearestNeighbors >>> neigh = NearestNeighbors(n_neighbors=2) >>> neigh.fit(X) NearestNeighbors(n_neighbors=2) >>> A = neigh.kneighbors_graph(X) >>> A.toarray() array([[1., 0., 1.], [0., 1., 1.], [1., 0., 1.]])
- set_output(*, transform=None)[source]#
设置输出容器。
有关如何使用 API 的示例，请参阅引入 set_output API。
- 参数:
- transform{“default”, “pandas”, “polars”}, default=None
配置
transform和fit_transform的输出。"default": 转换器的默认输出格式"pandas": DataFrame 输出"polars": Polars 输出None: 转换配置保持不变
1.4 版本新增: 添加了
"polars"选项。
- 返回:
- selfestimator instance
估计器实例。
