DOC Improve _check_sample_weight docstring (#30908)

lucyleeow · web-flow · commit 9ce8be699599 · 2025-03-02T12:24:23.000+05:00
diff --git a/sklearn/ensemble/_weight_boosting.py b/sklearn/ensemble/_weight_boosting.py
@@ -139,7 +139,7 @@ def fit(self, X, y, sample_weight=None):
         )
 
         sample_weight = _check_sample_weight(
-            sample_weight, X, np.float64, copy=True, ensure_non_negative=True
+            sample_weight, X, dtype=np.float64, copy=True, ensure_non_negative=True
         )
         sample_weight /= sample_weight.sum()
 
diff --git a/sklearn/tree/_classes.py b/sklearn/tree/_classes.py
@@ -358,7 +358,7 @@ def _fit(
             )
 
         if sample_weight is not None:
-            sample_weight = _check_sample_weight(sample_weight, X, DOUBLE)
+            sample_weight = _check_sample_weight(sample_weight, X, dtype=DOUBLE)
 
         if expanded_class_weight is not None:
             if sample_weight is not None:
diff --git a/sklearn/utils/validation.py b/sklearn/utils/validation.py
@@ -2127,7 +2127,7 @@ def _check_psd_eigenvalues(lambdas, enable_warnings=False):
 
 
 def _check_sample_weight(
-    sample_weight, X, dtype=None, copy=False, ensure_non_negative=False
+    sample_weight, X, *, dtype=None, ensure_non_negative=False, copy=False
 ):
     """Validate sample weights.
 
@@ -2144,18 +2144,22 @@ def _check_sample_weight(
     X : {ndarray, list, sparse matrix}
         Input data.
 
+    dtype : dtype, default=None
+        dtype of the validated `sample_weight`.
+        If None, and `sample_weight` is an array:
+
+            - If `sample_weight.dtype` is one of `{np.float64, np.float32}`,
+              then the dtype is preserved.
+            - Else the output has NumPy's default dtype: `np.float64`.
+
+        If `dtype` is not `{np.float32, np.float64, None}`, then output will
+        be `np.float64`.
+
     ensure_non_negative : bool, default=False,
         Whether or not the weights are expected to be non-negative.
 
         .. versionadded:: 1.0
 
-    dtype : dtype, default=None
-        dtype of the validated `sample_weight`.
-        If None, and the input `sample_weight` is an array, the dtype of the
-        input is preserved; otherwise an array with the default numpy dtype
-        is be allocated.  If `dtype` is not one of `float32`, `float64`,
-        `None`, the output will be of dtype `float64`.
-
     copy : bool, default=False
         If True, a copy of sample_weight will be created.
 

Original file line number	Diff line number	Diff line change
`@@ -139,7 +139,7 @@ def fit(self, X, y, sample_weight=None):`
`139`	`139`	`)`
`140`	`140`
`141`	`141`	`sample_weight = _check_sample_weight(`
`142`		`- sample_weight, X, np.float64, copy=True, ensure_non_negative=True`
	`142`	`+ sample_weight, X, dtype=np.float64, copy=True, ensure_non_negative=True`
`143`	`143`	`)`
`144`	`144`	`sample_weight /= sample_weight.sum()`
`145`	`145`
Original file line number	Diff line number	Diff line change
`@@ -358,7 +358,7 @@ def _fit(`
`358`	`358`	`)`
`359`	`359`
`360`	`360`	`if sample_weight is not None:`
`361`		`- sample_weight = _check_sample_weight(sample_weight, X, DOUBLE)`
	`361`	`+ sample_weight = _check_sample_weight(sample_weight, X, dtype=DOUBLE)`
`362`	`362`
`363`	`363`	`if expanded_class_weight is not None:`
`364`	`364`	`if sample_weight is not None:`