Move deprecation for sparse PCA to 1.2 and updated messages and tests accordingly

ogrisel · ogrisel · commit 6ea3f396a99d · 2022-06-24T16:50:54.000+02:00
diff --git a/doc/whats_new/v1.1.rst b/doc/whats_new/v1.1.rst
@@ -19,15 +19,6 @@ Changelog
   a node if there are duplicates in the dataset.
   :pr:`23395` by :user:`Jérémie du Boisberranger <jeremiedbb>`.
 
-:mod:`sklearn.decomposition`
-............................
-
-- |Fix| Fixed a bug in :class:`decomposition.MiniBatchSparsePCA` where `n_iter`
-  was not deprecated as for :class:`decomposition.MiniBatchDictionaryLearning`.
-  We also introduce the parameters `max_iter`, `tol`, and `max_no_improvement`
-  for consistency. `n_iter` will be removed in version 1.3.
-  :pr:`23726` by :user:`Guillaume Lemaitre <glemaitre>`.
-
 .. _changes_1_1_1:
 
 Version 1.1.1
diff --git a/doc/whats_new/v1.2.rst b/doc/whats_new/v1.2.rst
@@ -110,6 +110,16 @@ Changelog
   its memory footprint and runtime.
   :pr:`22268` by :user:`MohamedBsh <Bsh>`.
 
+:mod:`sklearn.decomposition`
+............................
+
+- |API| The `n_iter` parameter of :class:`decomposition.MiniBatchSparsePCA` is
+  deprecated and replaced by the parameters `max_iter`, `tol`, and
+  `max_no_improvement` to be consistent with
+  :class:`decomposition.MiniBatchDictionaryLearning`. `n_iter` will be removed
+  in version 1.3. :pr:`23726` by :user:`Guillaume Lemaitre <glemaitre>`.
+
+
 :mod:`sklearn.ensemble`
 .......................
 
diff --git a/sklearn/decomposition/_dict_learning.py b/sklearn/decomposition/_dict_learning.py
@@ -794,7 +794,7 @@ def dict_learning_online(
         Number of mini-batch iterations to perform.
 
         .. deprecated:: 1.1
-           `n_iter` is deprecated in 1.1 and will be removed in 1.3. Use
+           `n_iter` is deprecated in 1.1 and will be removed in 1.4. Use
            `max_iter` instead.
 
     max_iter : int, default=None
@@ -1758,7 +1758,7 @@ class MiniBatchDictionaryLearning(_BaseSparseCoding, BaseEstimator):
         Total number of iterations over data batches to perform.
 
         .. deprecated:: 1.1
-           ``n_iter`` is deprecated in 1.1 and will be removed in 1.3. Use
+           ``n_iter`` is deprecated in 1.1 and will be removed in 1.4. Use
            ``max_iter`` instead.
 
     max_iter : int, default=None
@@ -2255,7 +2255,7 @@ def fit(self, X, y=None):
         if self.n_iter != "deprecated":
             warnings.warn(
                 "'n_iter' is deprecated in version 1.1 and will be removed "
-                "in version 1.3. Use 'max_iter' and let 'n_iter' to its default "
+                "in version 1.4. Use 'max_iter' and let 'n_iter' to its default "
                 "value instead. 'n_iter' is also ignored if 'max_iter' is "
                 "specified.",
                 FutureWarning,
diff --git a/sklearn/decomposition/_sparse_pca.py b/sklearn/decomposition/_sparse_pca.py
@@ -273,16 +273,16 @@ class MiniBatchSparsePCA(SparsePCA):
     n_iter : int, default=100
         Number of iterations to perform for each mini batch.
 
-        .. deprecated:: 1.1
-           `n_iter` is deprecated in 1.1 and will be removed in 1.3. Use
+        .. deprecated:: 1.2
+           `n_iter` is deprecated in 1.2 and will be removed in 1.4. Use
            `max_iter` instead.
 
     max_iter : int, default=None
         Maximum number of iterations over the complete dataset before
         stopping independently of any early stopping criterion heuristics.
         If `max_iter` is not `None`, `n_iter` is ignored.
 
-        .. versionadded:: 1.1
+        .. versionadded:: 1.2
 
     callback : callable, default=None
         Callable that gets invoked every five iterations.
diff --git a/sklearn/decomposition/tests/test_dict_learning.py b/sklearn/decomposition/tests/test_dict_learning.py
@@ -721,7 +721,7 @@ def test_minibatch_dict_learning_n_iter_deprecated():
     # check the deprecation warning of n_iter
     # FIXME: remove in 1.3
     depr_msg = (
-        "'n_iter' is deprecated in version 1.1 and will be removed in version 1.3"
+        "'n_iter' is deprecated in version 1.1 and will be removed in version 1.4"
     )
     est = MiniBatchDictionaryLearning(
         n_components=2, batch_size=4, n_iter=5, random_state=0
@@ -1074,7 +1074,7 @@ def test_get_feature_names_out(estimator):
     )
 
 
-# TODO(1.3) remove
+# TODO(1.4) remove
 def test_minibatch_dictionary_learning_warns_and_ignore_n_iter():
     """Check that we always raise a warning when `n_iter` is set even if it is
     ignored if `max_iter` is set.
diff --git a/sklearn/decomposition/tests/test_sparse_pca.py b/sklearn/decomposition/tests/test_sparse_pca.py
@@ -267,7 +267,7 @@ def test_spca_feature_names_out(SPCA):
     assert_array_equal([f"{estimator_name}{i}" for i in range(4)], names)
 
 
-# TODO (1.3): remove this test
+# TODO (1.4): remove this test
 def test_spca_n_iter_deprecation():
     """Check that we raise a warning for the deprecation of `n_iter` and it is ignored
     when `max_iter` is specified.
