Revert "MAINT: Remove deprecated attributes for BasicStatistics (#2897)"

This reverts commit c760965.

Author: homksei

onedal/basic_statistics/basic_statistics.py

@@ -35,34 +35,34 @@ class BasicStatistics:
 
     Attributes
     ----------
-        min_ : ndarray of shape (n_features,)
+        min : ndarray of shape (n_features,)
             Minimum of each feature over all samples.
 
-        max_ : ndarray of shape (n_features,)
+        max : ndarray of shape (n_features,)
             Maximum of each feature over all samples.
 
-        sum_ : ndarray of shape (n_features,)
+        sum : ndarray of shape (n_features,)
             Sum of each feature over all samples.
 
-        mean_ : ndarray of shape (n_features,)
+        mean : ndarray of shape (n_features,)
             Mean of each feature over all samples.
 
-        variance_ : ndarray of shape (n_features,)
+        variance : ndarray of shape (n_features,)
             Variance of each feature over all samples.
 
-        variation_ : ndarray of shape (n_features,)
+        variation : ndarray of shape (n_features,)
             Variation of each feature over all samples.
 
-        sum_squares_ : ndarray of shape (n_features,)
+        sum_squares : ndarray of shape (n_features,)
             Sum of squares for each feature over all samples.
 
-        standard_deviation_ : ndarray of shape (n_features,)
+        standard_deviation : ndarray of shape (n_features,)
             Standard deviation of each feature over all samples.
 
-        sum_squares_centered_ : ndarray of shape (n_features,)
+        sum_squares_centered : ndarray of shape (n_features,)
             Centered sum of squares for each feature over all samples.
 
-        second_order_raw_moment_ : ndarray of shape (n_features,)
+        second_order_raw_moment : ndarray of shape (n_features,)
             Second order moment of each feature over all samples.
 
     Notes

onedal/basic_statistics/incremental_basic_statistics.py

@@ -35,34 +35,34 @@ class IncrementalBasicStatistics(BasicStatistics):
 
     Attributes
     ----------
-        min_ : ndarray of shape (n_features,)
+        min : ndarray of shape (n_features,)
             Minimum of each feature over all samples.
 
-        max_ : ndarray of shape (n_features,)
+        max : ndarray of shape (n_features,)
             Maximum of each feature over all samples.
 
-        sum_ : ndarray of shape (n_features,)
+        sum : ndarray of shape (n_features,)
             Sum of each feature over all samples.
 
-        mean_ : ndarray of shape (n_features,)
+        mean : ndarray of shape (n_features,)
             Mean of each feature over all samples.
 
-        variance_ : ndarray of shape (n_features,)
+        variance : ndarray of shape (n_features,)
             Variance of each feature over all samples.
 
-        variation_ : ndarray of shape (n_features,)
+        variation : ndarray of shape (n_features,)
             Variation of each feature over all samples.
 
-        sum_squares_ : ndarray of shape (n_features,)
+        sum_squares : ndarray of shape (n_features,)
             Sum of squares for each feature over all samples.
 
-        standard_deviation_ : ndarray of shape (n_features,)
+        standard_deviation : ndarray of shape (n_features,)
             Standard deviation of each feature over all samples.
 
-        sum_squares_centered_ : ndarray of shape (n_features,)
+        sum_squares_centered : ndarray of shape (n_features,)
             Centered sum of squares for each feature over all samples.
 
-        second_order_raw_moment_ : ndarray of shape (n_features,)
+        second_order_raw_moment : ndarray of shape (n_features,)
             Second order moment of each feature over all samples.
 
     Notes

sklearnex/_utils.py

@@ -187,16 +187,16 @@ def reset_hyperparameters(self, op):
     return decorator
 
 
-def _add_inc_serialization_note(class_docstrings: str, plural: bool = False) -> str:
+def _add_inc_serialization_note(class_docstrings: str) -> str:
     """Adds a small note note about serialization for extension estimators that are incremental.
     The class docstrings should leave a placeholder '%incremental_serialization_note%' inside
     their docstrings, which will be replaced by this note.
     """
     # In python versions >=3.13, leading whitespace in docstrings defined through
     # static strings (but **not through other ways**) is automatically removed
     # from the final docstrings, while in earlier versions is kept.
-    inc_serialization_note = f"""Note{'s' if plural else ''}
-----{'-' if plural else ''}
+    inc_serialization_note = """Note
+----
 Serializing instances of this class will trigger a forced finalization of calculations
 when the inputs are in a sycl queue or when using GPUs. Since (internal method)
 finalize_fit can't be dispatched without directly provided queue and the dispatching

sklearnex/basic_statistics/basic_statistics.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 # ==============================================================================
 
+import warnings
+
 from sklearn.base import BaseEstimator
 
 from daal4py.sklearn._n_jobs_support import control_n_jobs
@@ -75,6 +77,9 @@ class BasicStatistics(oneDALEstimator, BaseEstimator):
     -----
     Attribute exists only if corresponding result option has been provided.
 
+    Names of attributes without the trailing underscore are
+    supported currently but deprecated in 2025.1 and will be removed in 2026.0
+
     Some results can exhibit small variations due to
     floating point error accumulation and multithreading.
 
@@ -124,6 +129,24 @@ def _save_attributes(self):
             option += "_"
             setattr(self, option, getattr(self._onedal_estimator, option))
 
+    def __getattr__(self, attr):
+        is_deprecated_attr = (
+            attr in self._onedal_estimator.options
+            if "_onedal_estimator" in self.__dict__
+            else False
+        )
+        if is_deprecated_attr:
+            warnings.warn(
+                "Result attributes without a trailing underscore were deprecated in version 2025.1 and will be removed in 2026.0"
+            )
+            attr += "_"
+        if attr in self.__dict__:
+            return self.__dict__[attr]
+
+        raise AttributeError(
+            f"'{self.__class__.__name__}' object has no attribute '{attr}'"
+        )
+
     def _onedal_cpu_supported(self, method_name, *data):
         patching_status = PatchingConditionsChain(
             f"sklearnex.basic_statistics.{self.__class__.__name__}.{method_name}"

sklearnex/basic_statistics/incremental_basic_statistics.py

@@ -34,6 +34,7 @@
     from sklearn.utils._param_validation import Interval, StrOptions
 
 import numbers
+import warnings
 
 
 @enable_array_api
@@ -100,12 +101,17 @@ class IncrementalBasicStatistics(oneDALEstimator, BaseEstimator):
         n_features_in_ : int
             Number of features seen during :meth:`fit` or  :meth:`partial_fit`.
 
-    %incremental_serialization_note%
-
+    Notes
+    -----
     Attribute exists only if corresponding result option has been provided.
 
+    Names of attributes without the trailing underscore are supported
+    currently but deprecated in 2025.1 and will be removed in 2026.0.
+
     Sparse data formats are not supported. Input dtype must be ``float32`` or ``float64``.
 
+    %incremental_serialization_note%
+
     Examples
     --------
     >>> import numpy as np
@@ -125,7 +131,7 @@ class IncrementalBasicStatistics(oneDALEstimator, BaseEstimator):
     np.array([3., 4.])
     """
 
-    __doc__ = _add_inc_serialization_note(__doc__, plural=True)
+    __doc__ = _add_inc_serialization_note(__doc__)
 
     _onedal_incremental_basic_statistics = staticmethod(onedal_IncrementalBasicStatistics)
 
@@ -246,8 +252,18 @@ def __getattr__(self, attr):
         if is_statistic_attr:
             if self._need_to_finalize:
                 self._onedal_finalize_fit()
+            if sattr == attr:
+                warnings.warn(
+                    "Result attributes without a trailing underscore were deprecated in version 2025.1 and will be removed in 2026.0"
+                )
+                attr += "_"
             return getattr(self._onedal_estimator, attr)
-        return self.__getattribute__(attr)
+        if attr in self.__dict__:
+            return self.__dict__[attr]
+
+        raise AttributeError(
+            f"'{self.__class__.__name__}' object has no attribute '{attr}'"
+        )
 
     def partial_fit(self, X, sample_weight=None, check_input=True):
         """Incremental fit with X. All of X is processed as a single batch.

sklearnex/basic_statistics/tests/test_basic_statistics.py

@@ -387,17 +387,19 @@ def test_1d_input_on_random_data(
     assert_allclose(gtr, res, atol=tol)
 
 
-@pytest.mark.parametrize("underscore_first", [False, True])
-def test_results_have_underscores(underscore_first):
-    X = np.arange(10).reshape((-1, 1))
-    bs = BasicStatistics().fit(X)
-
-    # Note: these are generated dynamically. Need to
-    # test them in different order to ensure calling
-    # one doesn't set the other and then change results.
-    if underscore_first:
-        assert hasattr(bs, "mean_")
-        assert not hasattr(bs, "mean")
-    else:
-        assert not hasattr(bs, "mean")
-        assert hasattr(bs, "mean_")
+def test_warning():
+    basicstat = BasicStatistics("all")
+    data = np.array([0, 1])
+
+    basicstat.fit(data)
+    for i in basicstat._onedal_estimator.get_all_result_options():
+        with pytest.warns(
+            UserWarning,
+            match="Result attributes without a trailing underscore were deprecated in version 2025.1 and will be removed in 2026.0",
+        ) as warn_record:
+            getattr(basicstat, i)
+
+        if daal_check_version((2026, "P", 0)):
+            assert len(warn_record) == 0, i
+        else:
+            assert len(warn_record) == 1, i