DOC add meaning of max_patches=None in _compute_n_patches (scikit-l…

…earn#25999) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
REDVM · Nov 16, 2023 · ad1b01c · ad1b01c
1 parent 5170e8b
commit ad1b01c
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/sklearn/feature_extraction/image.py b/sklearn/feature_extraction/image.py
@@ -261,9 +261,9 @@ def _compute_n_patches(i_h, i_w, p_h, p_w, max_patches=None, stride=(1, 1)):
     p_w : int
         The width of a patch
     max_patches : int or float, default=None
-        The maximum number of patches to extract. If max_patches is a float
+        The maximum number of patches to extract. If `max_patches` is a float
         between 0 and 1, it is taken to be a proportion of the total number
-        of patches.
+        of patches. If `max_patches` is None, all possible patches are extracted.
     stride : tuple of length arr.ndim, default=(1, 1)
         Indicates stride at which extraction shall be performed.
     """