半徑近鄰轉換器 #
- 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 轉換為半徑內鄰居的（加權）圖。
轉換後的資料是由
radius_neighbors_graph返回的稀疏圖。請參閱使用者指南以了解更多資訊。
於 0.22 版本新增。
- 參數:
- mode{‘distance’, ‘connectivity’}, default=’distance’
返回矩陣的類型：‘connectivity’ 將返回由 1 和 0 組成的連通性矩陣，而 ‘distance’ 將根據給定的度量返回鄰居之間的距離。
- radiusfloat, default=1.0
轉換後的稀疏圖中鄰域的半徑。
- algorithm{‘auto’, ‘ball_tree’, ‘kd_tree’, ‘brute’}, default=’auto’
用於計算最近鄰的演算法
注意：在稀疏輸入上進行擬合將覆蓋此參數的設定，使用暴力搜尋。
- leaf_sizeint, default=30
傳遞給 BallTree 或 KDTree 的葉節點大小。這會影響建構和查詢的速度，以及儲存樹所需的記憶體。最佳值取決於問題的性質。
- metricstr 或 callable, default=’minkowski’
用於距離計算的度量。預設為「minkowski」，當 p = 2 時，會產生標準的歐幾里得距離。請參閱 scipy.spatial.distance 的文件和
distance_metrics中列出的度量，以取得有效的度量值。如果 metric 是一個可呼叫的函數，它會將兩個代表一維向量的陣列作為輸入，並且必須返回一個表示這些向量之間距離的值。這適用於 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
在 fit 期間看到的特徵數量。
於 0.24 版本新增。
- feature_names_in_形狀為 (
n_features_in_,) 的 ndarray 在 fit 期間看到的特徵名稱。僅當
X具有全部為字串的特徵名稱時才定義。於 1.0 版本新增。
- n_samples_fit_int
擬合資料中的樣本數量。
另請參閱
k 近鄰圖 (kneighbors_graph)計算 X 中點的 k 個鄰居的加權圖。
K 近鄰轉換器 (KNeighborsTransformer)將 X 轉換為 k 個最近鄰的加權圖。
範例
>>> 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)[原始碼]#
從訓練資料集擬合半徑鄰居轉換器。
- 參數:
- X形狀為 (n_samples, n_features) 或如果 metric=’precomputed’ 則為 (n_samples, n_samples) 的 {array-like, sparse matrix}
訓練資料。
- y忽略
不使用，依慣例為 API 一致性而存在。
- 返回:
- selfRadiusNeighborsTransformer
擬合的半徑鄰居轉換器。
- fit_transform(X, y=None)[原始碼]#
擬合資料，然後進行轉換。
使用可選的 fit_params 將轉換器擬合到 X 和 y，並返回 X 的轉換版本。
- 參數:
- X形狀為 (n_samples, n_features) 的 array-like
訓練集。
- y忽略
不使用，依慣例為 API 一致性而存在。
- 返回:
- Xt形狀為 (n_samples, n_samples) 的稀疏矩陣
Xt[i, j] 被指定為連接 i 到 j 的邊的權重。只有鄰居具有明確的值。對角線始終是明確的。該矩陣為 CSR 格式。
- get_feature_names_out(input_features=None)[原始碼]#
取得轉換的輸出特徵名稱。
輸出的特徵名稱會加上小寫的類別名稱作為前綴。例如，如果轉換器輸出 3 個特徵，則輸出的特徵名稱為：
["class_name0", "class_name1", "class_name2"]。- 參數:
- input_featuresarray-like of str 或 None，預設為 None
僅用於驗證特徵名稱是否與
fit中看到的名稱一致。
- 返回:
- feature_names_outstr 物件的 ndarray
轉換後的特徵名稱。
- get_metadata_routing()[來源]#
取得此物件的中繼資料路由。
請查看 使用者指南，了解路由機制如何運作。
- 返回:
- routingMetadataRequest
一個
MetadataRequest，封裝路由資訊。
- get_params(deep=True)[來源]#
取得此估計器的參數。
- 參數:
- deepbool，預設為 True
如果為 True，將返回此估計器及其包含的子物件（亦為估計器）的參數。
- 返回:
- paramsdict
參數名稱對應到它們的值。
- radius_neighbors(X=None, radius=None, return_distance=True, sort_results=False)[來源]#
尋找在給定半徑內，一點或多點的鄰居。
返回每個點的索引和距離，這些點來自資料集，且位於查詢陣列的點周圍，大小為
radius的球體內。邊界上的點也包含在結果中。結果點不一定會依與其查詢點的距離排序。
- 參數:
- X{array-like，稀疏矩陣}，形狀為 (n_samples, n_features)，預設為 None
查詢點或多個點。如果未提供，則會返回每個索引點的鄰居。在這種情況下，查詢點不會被視為自己的鄰居。
- radiusfloat，預設為 None
限制返回的鄰居距離。預設值是傳遞給建構函數的值。
- return_distancebool，預設為 True
是否返回距離。
- sort_resultsbool，預設為 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會返回物件陣列，其中每個物件都是索引或距離的 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 中點的鄰居的（加權）圖。
鄰域限制為距離小於半徑的點。
- 參數:
- X{array-like，稀疏矩陣}，形狀為 (n_samples, n_features)，預設為 None
查詢點或多個點。如果未提供，則會返回每個索引點的鄰居。在這種情況下，查詢點不會被視為自己的鄰居。
- radiusfloat，預設為 None
鄰域的半徑。預設值是傳遞給建構函數的值。
- mode{‘connectivity’，‘distance’}，預設為 ‘connectivity’
返回矩陣的類型： ‘connectivity’ 將返回具有 1 和 0 的連通性矩陣，在 ‘distance’ 中，邊是點之間的距離，距離的類型取決於 NearestNeighbors 類別中選定的度量參數。
- sort_resultsbool，預設為 False
如果為 True，則在結果的每一行中，非零條目將按遞增的距離排序。如果為 False，則非零條目可能不會排序。僅用於 mode=’distance’。
於 0.22 版本新增。
- 返回:
- A形狀為 (n_queries, n_samples_fit) 的稀疏矩陣
n_samples_fit是擬合資料中的樣本數。A[i, j]給出連接i到j的邊的權重。該矩陣為 CSR 格式。
另請參閱
k 近鄰圖 (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.]])
- set_output(*, transform=None)[來源]#
設定輸出容器。
請參閱 介紹 set_output API 以了解如何使用此 API 的範例。
- 參數:
- transform{“default”, “pandas”, “polars”}, default=None
設定
transform和fit_transform的輸出格式。"default": 轉換器的預設輸出格式"pandas": DataFrame 輸出"polars": Polars 輸出None: 轉換設定保持不變
1.4 版本新增: 新增了
"polars"選項。
- 返回:
- self估算器實例
估算器實例。