Fix/document average range values across the board

scikit-learn · Feb 8, 2024 · d181bda · d181bda
1 parent 97d5b4d
commit d181bda
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/sklearn/linear_model/_stochastic_gradient.py b/sklearn/linear_model/_stochastic_gradient.py
@@ -1125,7 +1125,7 @@ class SGDClassifier(BaseSGDClassifier):
         an int greater than 1, averaging will begin once the total number of
         samples seen reaches `average`. So ``average=10`` will begin
         averaging after seeing 10 samples.
-        Integer values must be in the range `[1, n_samples]`.
+        Integer values must be in the range `[0, n_samples]`.
 
     Attributes
     ----------
@@ -1915,6 +1915,7 @@ class SGDRegressor(BaseSGDRegressor):
         an int greater than 1, averaging will begin once the total number of
         samples seen reaches `average`. So ``average=10`` will begin
         averaging after seeing 10 samples.
+        Integer values must be in the range `[0, n_samples]`.
 
     Attributes
     ----------
@@ -2130,6 +2131,7 @@ class SGDOneClassSVM(BaseSGD, OutlierMixin):
         averaging will begin once the total number of samples seen reaches
         average. So ``average=10`` will begin averaging after seeing 10
         samples.
+        Integer values must be in the range `[0, n_samples]`.
 
     Attributes
     ----------