update: update algorithm.rst based on current implementation (#2354)

* update: update aldorithm and preview

* fix: remove incremental algos and added extra trees and tsne n_compoents description

* fix: fix basic stats

* fix: fix basic stats

* fix: went through all algos

* fix: address comments

* fix move incremental imiltaiton under notes

* fix: add notes in other incremental algos

* fix: sklearn < 1.5

* fix: removed versions

* Update doc/sources/algorithms.rst

Co-authored-by: david-cortes-intel <david.cortes@intel.com>

* fix: various chagnes based on comments

* fix: add verbose note

* Update doc/sources/algorithms.rst

Co-authored-by: david-cortes-intel <david.cortes@intel.com>

* fix: verbose html

* fix: verbose note

* fix: address comments

* fix: increoemtn notes

* fix: verbose

* fix: LogisticRegression

* fix: doc ci

* fix: fix basic stats format

* fix: fix basic stats

* fix: fix basic stats

* fix: format

* fix: fix indent

* fix: format

* fix: address comments

* fix: fix logistic regression cpu

* fix: fix logistic regression cpu

* fix: fix spmd logistic regression

---------

Co-authored-by: david-cortes-intel <david.cortes@intel.com>

Author: yuejiaointel

doc/sources/algorithms.rst

@@ -19,6 +19,10 @@
 Supported Algorithms
 ####################
 
+.. note::
+   To verify that oneDAL is being used for these algorithms, you can enable verbose mode. 
+   See :ref:`verbose mode documentation <verbose>` for details.
+
 Applying |sklearnex| impacts the following |sklearn| estimators:
 
 on CPU
@@ -48,6 +52,13 @@ Classification
        - ``ccp_alpha`` != `0`
        - ``criterion`` != `'gini'`
      - Multi-output and sparse data are not supported
+   * - `ExtraTreesClassifier`
+     - All parameters are supported except:
+
+       - ``warm_start`` = `True`
+       - ``ccp_alpha`` != `0`
+       - ``criterion`` != `'gini'`
+     - Multi-output and sparse data are not supported
    * - `KNeighborsClassifier`
      -
        - For ``algorithm`` == `'kd_tree'`:
@@ -58,12 +69,8 @@ Classification
          all parameters except ``metric`` not in [`'euclidean'`, `'manhattan'`, `'minkowski'`, `'chebyshev'`, `'cosine'`]
      - Multi-output and sparse data are not supported
    * - `LogisticRegression`
-     - All parameters are supported except:
-
-       - ``solver`` not in [`'lbfgs'`, `'newton-cg'`]
-       - ``class_weight`` != `None`
-       - ``sample_weight`` != `None`
-     - Only dense data is supported
+     - All parameters are supported
+     - No limitations
 
 Regression
 **********
@@ -89,6 +96,13 @@ Regression
        - ``ccp_alpha`` != `0`
        - ``criterion`` != `'mse'`
      - Multi-output and sparse data are not supported
+   * - `ExtraTreesRegressor`
+     - All parameters are supported except:
+
+       - ``warm_start`` = `True`
+       - ``ccp_alpha`` != `0`
+       - ``criterion`` != `'mse'`
+     - Multi-output and sparse data are not supported
    * - `KNeighborsRegressor`
      - All parameters are supported except:
 
@@ -97,16 +111,17 @@ Regression
    * - `LinearRegression`
      - All parameters are supported except:
 
-       - ``normalize`` != `False`
        - ``sample_weight`` != `None`
+       - ``positive`` = `True`
      - Only dense data is supported.
    * - `Ridge`
      - All parameters are supported except:
 
-       - ``normalize`` != `False`
        - ``solver`` != `'auto'`
        - ``sample_weight`` != `None`
-     - Only dense data is supported, `#observations` should be >= `#features`.
+       - ``positive`` = `True`
+       - ``alpha`` must be scalar
+     - Only dense data is supported.
    * - `ElasticNet`
      - All parameters are supported except:
 
@@ -132,8 +147,10 @@ Clustering
    * - `KMeans`
      - All parameters are supported except:
 
-       - ``precompute_distances``
-       - ``sample_weight`` != `None`
+       - ``algorithm`` != ``'lloyd'`` ('elkan' falls back to 'lloyd')
+       - ``n_clusters`` = ``1``
+       - ``sample_weight`` must be None, constant, or equal weights
+       - ``init`` = `'k-means++'` falls back to CPU
      - No limitations
    * - `DBSCAN`
      - All parameters are supported except:
@@ -156,16 +173,16 @@ Dimensionality Reduction
    * - `PCA`
      - All parameters are supported except:
 
-       - ``svd_solver`` not in [`'full'`, `'covariance_eigh'`]
-     - Sparse data is not supported
-   * - `IncrementalPCA`
-     - All parameters are supported
+       - ``svd_solver`` not in [`'full'`, `'covariance_eigh'`, `'onedal_svd'`]
+       - For |sklearn| < 1.5: `'full'` solver is automatically mapped to `'covariance_eigh'`
      - Sparse data is not supported
    * - `TSNE`
      - All parameters are supported except:
 
        - ``metric`` != 'euclidean' or `'minkowski'` with ``p`` != `2`
 
+       - ``n_components`` can only be `2`
+
        Refer to :ref:`TSNE acceleration details <acceleration_tsne>` to learn more.
      - Sparse data is not supported
 
@@ -204,17 +221,33 @@ Other Tasks
    * - `EmpiricalCovariance`
      - All parameters are supported
      - Only dense data is supported
+   * - `BasicStatistics`
+     - All parameters are supported
+     - Supported data formats:
+
+       - Dense data
+       - CSR sparse matrices
+       - Sample weights **not** supported for CSR data format
    * - `train_test_split`
      - All parameters are supported
-     - Only dense data is supported
+     - Supported data formats:
+        
+       - Only dense data is supported
+       - Only integer and 32/64-bits floating point types are supported
+       - Data with more than 3 dimensions is not supported
+       - Only ``np.ndarray`` inputs are supported.
    * - `assert_all_finite`
      - All parameters are supported
      - Only dense data is supported
    * - `pairwise_distance`
      - All parameters are supported except:
 
        - ``metric`` not in [`'cosine'`, `'correlation'`]
-     - Only dense data is supported
+     - Supported data formats:
+
+       - Only dense data is supported
+       - ``Y`` must be `None`
+       - Input dtype must be `np.float64`
    * - `roc_auc_score`
      - All parameters are supported except:
 
@@ -255,6 +288,15 @@ Classification
        - ``oob_score`` = `True`
        - ``sample_weight`` != `None`
      - Multi-output and sparse data are not supported
+   * - `ExtraTreesClassifier`
+     - All parameters are supported except:
+
+       - ``warm_start`` = `True`
+       - ``ccp_alpha`` != `0`
+       - ``criterion`` != `'gini'`
+       - ``oob_score`` = `True`
+       - ``sample_weight`` != `None`
+     - Multi-output and sparse data are not supported
    * - `KNeighborsClassifier`
      - All parameters are supported except:
 
@@ -269,7 +311,13 @@ Classification
        - ``class_weight`` != `None`
        - ``sample_weight`` != `None`
        - ``penalty`` != `'l2'`
-     - Only dense data is supported
+       - ``dual`` = `True`
+       - ``intercept_scaling`` != `1`
+       - ``multi_class`` != `'multinomial'`
+       - ``warm_start`` = `True`
+       - ``l1_ratio`` != `None`
+       - Only binary classification is supported
+     - No limitations
 
 Regression
 **********
@@ -291,6 +339,15 @@ Regression
        - ``oob_score`` = `True`
        - ``sample_weight`` != `None`
      - Multi-output and sparse data are not supported
+   * - `ExtraTreesRegressor`
+     - All parameters are supported except:
+
+       - ``warm_start`` = `True`
+       - ``ccp_alpha`` != `0`
+       - ``criterion`` != `'mse'`
+       - ``oob_score`` = `True`
+       - ``sample_weight`` != `None`
+     - Multi-output and sparse data are not supported
    * - `KNeighborsRegressor`
      - All parameters are supported except:
 
@@ -301,8 +358,8 @@ Regression
    * - `LinearRegression`
      - All parameters are supported except:
 
-       - ``normalize`` != `False`
        - ``sample_weight`` != `None`
+       - ``positive`` = `True`
      - Only dense data is supported.
 
 Clustering
@@ -319,10 +376,11 @@ Clustering
    * - `KMeans`
      - All parameters are supported except:
 
-       - ``precompute_distances``
-       - ``sample_weight`` != `None`
-       - ``Init`` = `'k-means++'` fallbacks to CPU.
-     - Sparse data is not supported
+       - ``algorithm`` != ``'lloyd'`` ('elkan' falls back to 'lloyd')
+       - ``n_clusters`` = ``1``
+       - ``sample_weight`` must be None, constant, or equal weights
+       - ``init`` = `'k-means++'` falls back to CPU
+     - No limitations
    * - `DBSCAN`
      - All parameters are supported except:
 
@@ -344,7 +402,8 @@ Dimensionality Reduction
    * - `PCA`
      - All parameters are supported except:
 
-       - ``svd_solver`` not in [`'full'`, `'covariance_eigh'`]
+       - ``svd_solver`` not in [`'full'`, `'covariance_eigh'`, `'onedal_svd'`]
+       - For |sklearn| < 1.5: `'full'` solver is automatically mapped to `'covariance_eigh'`
      - Sparse data is not supported
 
 Nearest Neighbors
@@ -380,6 +439,13 @@ Other Tasks
    * - `EmpiricalCovariance`
      - All parameters are supported
      - Only dense data is supported
+   * - `BasicStatistics`
+     - All parameters are supported
+     - Supported data formats:
+
+       - Dense data
+       - CSR sparse matrices
+       - Sample weights **not** supported for CSR data format
 
 .. _spmd-support:
 
@@ -408,6 +474,15 @@ Classification
        - ``oob_score`` = `True`
        - ``sample_weight`` != `None`
      - Multi-output and sparse data are not supported
+   * - `ExtraTreesClassifier`
+     - All parameters are supported except:
+
+       - ``warm_start`` = `True`
+       - ``ccp_alpha`` != `0`
+       - ``criterion`` != `'gini'`
+       - ``oob_score`` = `True`
+       - ``sample_weight`` != `None`
+     - Multi-output and sparse data are not supported
    * - `KNeighborsClassifier`
      - All parameters are supported except:
 
@@ -423,7 +498,13 @@ Classification
        - ``class_weight`` != `None`
        - ``sample_weight`` != `None`
        - ``penalty`` != `'l2'`
-     - Only dense data is supported
+       - ``dual`` = `True`
+       - ``intercept_scaling`` != `1`
+       - ``multi_class`` != `'multinomial'`
+       - ``warm_start`` = `True`
+       - ``l1_ratio`` != `None`
+       - Only binary classification is supported
+     - No limitations
 
 Regression
 **********
@@ -445,6 +526,15 @@ Regression
        - ``oob_score`` = `True`
        - ``sample_weight`` != `None`
      - Multi-output and sparse data are not supported
+   * - `ExtraTreesRegressor`
+     - All parameters are supported except:
+
+       - ``warm_start`` = `True`
+       - ``ccp_alpha`` != `0`
+       - ``criterion`` != `'mse'`
+       - ``oob_score`` = `True`
+       - ``sample_weight`` != `None`
+     - Multi-output and sparse data are not supported
    * - `KNeighborsRegressor`
      - All parameters are supported except:
 
@@ -455,8 +545,8 @@ Regression
    * - `LinearRegression`
      - All parameters are supported except:
 
-       - ``normalize`` != `False`
        - ``sample_weight`` != `None`
+       - ``positive`` = `True`
      - Only dense data is supported.
 
 Clustering
@@ -473,10 +563,11 @@ Clustering
    * - `KMeans`
      - All parameters are supported except:
 
-       - ``precompute_distances``
-       - ``sample_weight`` != `None`
-       - ``Init`` = `'k-means++'` fallbacks to CPU.
-     - Sparse data is not supported
+       - ``algorithm`` != ``'lloyd'`` ('elkan' falls back to 'lloyd')
+       - ``n_clusters`` = ``1``
+       - ``sample_weight`` must be None, constant, or equal weights
+       - ``init`` = `'k-means++'` falls back to CPU
+     - No limitations
    * - `DBSCAN`
      - All parameters are supported except:
 
@@ -498,8 +589,8 @@ Dimensionality Reduction
    * - `PCA`
      - All parameters are supported except:
 
-       - ``svd_solver`` not in [`'full'`, `'covariance_eigh'`]
-       - ``fit`` is the only method supported
+       - ``svd_solver`` not in [`'full'`, `'covariance_eigh'`, `'onedal_svd'`]
+       - For |sklearn| < 1.5: `'full'` solver is automatically mapped to `'covariance_eigh'`
      - Sparse data is not supported
 
 Nearest Neighbors
@@ -535,6 +626,13 @@ Other Tasks
    * - `EmpiricalCovariance`
      - All parameters are supported
      - Only dense data is supported
+   * - `BasicStatistics`
+     - All parameters are supported
+     - Supported data formats:
+
+       - Dense data
+       - CSR sparse matrices
+       - Sample weights **not** supported for CSR data format
 
 Scikit-learn Tests
 ------------------

sklearnex/basic_statistics/incremental_basic_statistics.py

@@ -106,7 +106,9 @@ class IncrementalBasicStatistics(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
+    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%
 

sklearnex/covariance/incremental_covariance.py

@@ -98,6 +98,10 @@ class IncrementalEmpiricalCovariance(oneDALEstimator, BaseEstimator):
     n_features_in_ : int
         Number of features seen during ``fit`` or ``partial_fit``.
 
+    Notes
+    -----
+    Sparse data formats are not supported. Input dtype must be ``float32`` or ``float64``.
+
     %incremental_serialization_note%
 
     Examples

sklearnex/linear_model/incremental_linear.py

@@ -110,6 +110,10 @@ class IncrementalLinearRegression(
     n_features_in_ : int
         Number of features seen during ``fit`` or ``partial_fit``.
 
+    Notes
+    -----
+    Sparse data formats are not supported. Input dtype must be ``float32`` or ``float64``.
+
     %incremental_serialization_note%
 
     Examples

sklearnex/linear_model/incremental_ridge.py

@@ -97,6 +97,10 @@ class IncrementalRidge(MultiOutputMixin, RegressorMixin, oneDALEstimator, BaseEs
     batch_size_ : int
         Inferred batch size from ``batch_size``.
 
+    Notes
+    -----
+    Sparse data formats are not supported. Input dtype must be ``float32`` or ``float64``.
+
     %incremental_serialization_note%
     """