scikit-learn-intelex 2025.4.0__py313-none-manylinux_2_28_x86_64.whl

daal4py/sklearn/_utils.py

@@ -0,0 +1,245 @@
+# ==============================================================================
+# Copyright 2014 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+import functools
+import os
+import sys
+import warnings
+from typing import Any, Tuple
+
+import numpy as np
+from numpy.lib.recfunctions import require_fields
+from sklearn import __version__ as sklearn_version
+
+from daal4py import _get__daal_link_version__ as dv
+
+DaalVersionTuple = Tuple[int, str, int]
+
+import logging
+
+try:
+    from packaging.version import Version
+except ImportError:
+    from distutils.version import LooseVersion as Version
+
+try:
+    from pandas import DataFrame
+    from pandas.core.dtypes.cast import find_common_type
+
+    pandas_is_imported = True
+except (ImportError, ModuleNotFoundError):
+    pandas_is_imported = False
+
+
+def set_idp_sklearn_verbose():
+    logLevel = os.environ.get("IDP_SKLEARN_VERBOSE")
+    try:
+        if logLevel is not None:
+            logging.basicConfig(
+                stream=sys.stdout,
+                format="%(levelname)s: %(message)s",
+                level=logLevel.upper(),
+            )
+    except Exception:
+        warnings.warn(
+            'Unknown level "{}" for logging.\n'
+            'Please, use one of "CRITICAL", "ERROR", '
+            '"WARNING", "INFO", "DEBUG".'.format(logLevel)
+        )
+
+
+def get_daal_version() -> DaalVersionTuple:
+    return int(dv()[0:4]), str(dv()[10:11]), int(dv()[4:8])
+
+
+@functools.lru_cache(maxsize=256, typed=False)
+def daal_check_version(
+    required_version: Tuple[Any, ...],
+    daal_version: Tuple[Any, ...] = get_daal_version(),
+) -> bool:
+    """Check daal version provided as (MAJOR, STATUS, MINOR+PATCH)
+
+    This function also accepts a list or tuple of daal versions. It will return true if
+    any version in the list/tuple is <= `daal_version`.
+    """
+    if isinstance(required_version[0], (list, tuple)):
+        # a list of version candidates was provided, recursively check if any is <= daal_version
+        return any(
+            map(lambda ver: daal_check_version(ver, daal_version), required_version)
+        )
+
+    major_required, status_required, patch_required = required_version
+    major, status, patch = daal_version
+
+    if status != status_required:
+        return False
+
+    if major_required < major:
+        return True
+    if major == major_required:
+        return patch_required <= patch
+
+    return False
+
+
+def _package_check_version(version_to_check, available_version):
+    if hasattr(Version(version_to_check), "base_version"):
+        base_package_version = Version(available_version).base_version
+        res = bool(Version(base_package_version) >= Version(version_to_check))
+    else:
+        # packaging module not available
+        res = bool(Version(available_version) >= Version(version_to_check))
+    return res
+
+
+@functools.lru_cache(maxsize=256, typed=False)
+def sklearn_check_version(ver):
+    return _package_check_version(ver, sklearn_version)
+
+
+def parse_dtype(dt):
+    if dt == np.double:
+        return "double"
+    if dt == np.single:
+        return "float"
+    raise ValueError(f"Input array has unexpected dtype = {dt}")
+
+
+def getFPType(X):
+    if pandas_is_imported:
+        if isinstance(X, DataFrame):
+            dt = find_common_type(X.dtypes.tolist())
+            return parse_dtype(dt)
+
+    dt = getattr(X, "dtype", None)
+    return parse_dtype(dt)
+
+
+def make2d(X):
+    if np.isscalar(X):
+        X = np.asarray(X)[np.newaxis, np.newaxis]
+    elif isinstance(X, np.ndarray) and X.ndim == 1:
+        X = X.reshape((X.size, 1))
+    return X
+
+
+def get_patch_message(s):
+    if s == "daal":
+        message = "running accelerated version on CPU"
+
+    elif s == "sklearn":
+        message = "fallback to original Scikit-learn"
+    elif s == "sklearn_after_daal":
+        message = "failed to run accelerated version, fallback to original Scikit-learn"
+    else:
+        raise ValueError(
+            f"Invalid input - expected one of 'daal','sklearn',"
+            f" 'sklearn_after_daal', got {s}"
+        )
+    return message
+
+
+def is_DataFrame(X):
+    if pandas_is_imported:
+        return isinstance(X, DataFrame)
+    else:
+        return False
+
+
+def get_dtype(X):
+    if pandas_is_imported:
+        return find_common_type(list(X.dtypes)) if is_DataFrame(X) else X.dtype
+    else:
+        return getattr(X, "dtype", None)
+
+
+def get_number_of_types(dataframe):
+    dtypes = getattr(dataframe, "dtypes", None)
+    try:
+        return len(set(dtypes))
+    except TypeError:
+        return 1
+
+
+def check_tree_nodes(tree_nodes):
+    def convert_to_old_tree_nodes(tree_nodes):
+        # conversion from sklearn>=1.3 tree nodes format to previous format:
+        # removal of 'missing_go_to_left' field from node dtype
+        new_field = "missing_go_to_left"
+        new_dtype = tree_nodes.dtype
+        old_dtype = np.dtype(
+            [
+                (key, value[0])
+                for key, value in new_dtype.fields.items()
+                if key != new_field
+            ]
+        )
+        return require_fields(tree_nodes, old_dtype)
+
+    if sklearn_check_version("1.3"):
+        return tree_nodes
+    else:
+        return convert_to_old_tree_nodes(tree_nodes)
+
+
+class PatchingConditionsChain:
+    def __init__(self, scope_name):
+        self.scope_name = scope_name
+        self.patching_is_enabled = True
+        self.messages = []
+        self.logger = logging.getLogger("sklearnex")
+
+    def _iter_conditions(self, conditions_and_messages):
+        result = []
+        for condition, message in conditions_and_messages:
+            result.append(condition)
+            if not condition:
+                self.messages.append(message)
+        return result
+
+    def and_conditions(self, conditions_and_messages, conditions_merging=all):
+        self.patching_is_enabled &= conditions_merging(
+            self._iter_conditions(conditions_and_messages)
+        )
+        return self.patching_is_enabled
+
+    def and_condition(self, condition, message):
+        return self.and_conditions([(condition, message)])
+
+    def or_conditions(self, conditions_and_messages, conditions_merging=all):
+        self.patching_is_enabled |= conditions_merging(
+            self._iter_conditions(conditions_and_messages)
+        )
+        return self.patching_is_enabled
+
+    def write_log(self):
+        if self.patching_is_enabled:
+            self.logger.info(f"{self.scope_name}: {get_patch_message('daal')}")
+        else:
+            self.logger.debug(
+                f"{self.scope_name}: debugging for the patch is enabled to track"
+                " the usage of Intel® oneAPI Data Analytics Library (oneDAL)"
+            )
+            for message in self.messages:
+                self.logger.debug(
+                    f"{self.scope_name}: patching failed with cause - {message}"
+                )
+            self.logger.info(f"{self.scope_name}: {get_patch_message('sklearn')}")
+
+    def get_status(self, logs=False):
+        if logs:
+            self.write_log()
+        return self.patching_is_enabled

daal4py/sklearn/cluster/__init__.py

@@ -0,0 +1,20 @@
+# ==============================================================================
+# Copyright 2014 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+from .dbscan import DBSCAN
+from .k_means import KMeans
+
+__all__ = ["KMeans", "DBSCAN"]

daal4py/sklearn/cluster/dbscan.py

@@ -0,0 +1,165 @@
+# ==============================================================================
+# Copyright 2014 Intel Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ==============================================================================
+
+import numbers
+
+import numpy as np
+from scipy import sparse as sp
+from sklearn.cluster import DBSCAN as DBSCAN_original
+from sklearn.utils import check_array
+from sklearn.utils.validation import _check_sample_weight
+
+import daal4py
+
+from .._n_jobs_support import control_n_jobs
+from .._utils import PatchingConditionsChain, getFPType, make2d, sklearn_check_version
+
+if sklearn_check_version("1.1") and not sklearn_check_version("1.2"):
+    from sklearn.utils import check_scalar
+
+
+def _daal_dbscan(X, eps=0.5, min_samples=5, sample_weight=None):
+    ww = make2d(sample_weight) if sample_weight is not None else None
+    XX = make2d(X)
+
+    fpt = getFPType(XX)
+    alg = daal4py.dbscan(
+        method="defaultDense",
+        fptype=fpt,
+        epsilon=float(eps),
+        minObservations=int(min_samples),
+        memorySavingMode=False,
+        resultsToCompute="computeCoreIndices",
+    )
+
+    daal_res = alg.compute(XX, ww)
+    assignments = daal_res.assignments.ravel()
+    if daal_res.coreIndices is not None:
+        core_ind = daal_res.coreIndices.ravel()
+    else:
+        core_ind = np.array([], dtype=np.intc)
+
+    return (core_ind, assignments)
+
+
+@control_n_jobs(decorated_methods=["fit"])
+class DBSCAN(DBSCAN_original):
+    __doc__ = DBSCAN_original.__doc__
+
+    if sklearn_check_version("1.2"):
+        _parameter_constraints: dict = {**DBSCAN_original._parameter_constraints}
+
+    def __init__(
+        self,
+        eps=0.5,
+        min_samples=5,
+        metric="euclidean",
+        metric_params=None,
+        algorithm="auto",
+        leaf_size=30,
+        p=None,
+        n_jobs=None,
+    ):
+        self.eps = eps
+        self.min_samples = min_samples
+        self.metric = metric
+        self.metric_params = metric_params
+        self.algorithm = algorithm
+        self.leaf_size = leaf_size
+        self.p = p
+        self.n_jobs = n_jobs
+
+    def fit(self, X, y=None, sample_weight=None):
+        if sklearn_check_version("1.2"):
+            self._validate_params()
+        elif sklearn_check_version("1.1"):
+            check_scalar(
+                self.eps,
+                "eps",
+                target_type=numbers.Real,
+                min_val=0.0,
+                include_boundaries="neither",
+            )
+            check_scalar(
+                self.min_samples,
+                "min_samples",
+                target_type=numbers.Integral,
+                min_val=1,
+                include_boundaries="left",
+            )
+            check_scalar(
+                self.leaf_size,
+                "leaf_size",
+                target_type=numbers.Integral,
+                min_val=1,
+                include_boundaries="left",
+            )
+            if self.p is not None:
+                check_scalar(
+                    self.p,
+                    "p",
+                    target_type=numbers.Real,
+                    min_val=0.0,
+                    include_boundaries="left",
+                )
+            if self.n_jobs is not None:
+                check_scalar(self.n_jobs, "n_jobs", target_type=numbers.Integral)
+        else:
+            if self.eps <= 0.0:
+                raise ValueError(f"eps == {self.eps}, must be > 0.0.")
+
+        if sklearn_check_version("1.0"):
+            self._check_feature_names(X, reset=True)
+
+        if sample_weight is not None:
+            sample_weight = _check_sample_weight(sample_weight, X)
+
+        _patching_status = PatchingConditionsChain("sklearn.cluster.DBSCAN.fit")
+        _dal_ready = _patching_status.and_conditions(
+            [
+                (
+                    self.algorithm in ["auto", "brute"],
+                    f"'{self.algorithm}' algorithm is not supported. "
+                    "Only 'auto' and 'brute' algorithms are supported",
+                ),
+                (
+                    self.metric == "euclidean"
+                    or (self.metric == "minkowski" and self.p == 2),
+                    f"'{self.metric}' (p={self.p}) metric is not supported. "
+                    "Only 'euclidean' or 'minkowski' with p=2 metrics are supported.",
+                ),
+                (not sp.issparse(X), "X is sparse. Sparse input is not supported."),
+            ]
+        )
+
+        _patching_status.write_log()
+        if _dal_ready:
+            X = check_array(X, accept_sparse="csr", dtype=[np.float64, np.float32])
+            core_ind, assignments = _daal_dbscan(
+                X, self.eps, self.min_samples, sample_weight=sample_weight
+            )
+            self.core_sample_indices_ = core_ind
+            self.labels_ = assignments
+            self.components_ = np.take(X, core_ind, axis=0)
+            self.n_features_in_ = X.shape[1]
+            return self
+        return super().fit(X, y, sample_weight=sample_weight)
+
+    def fit_predict(self, X, y=None, sample_weight=None):
+        return super().fit_predict(X, y, sample_weight)
+
+    fit.__doc__ = DBSCAN_original.fit.__doc__
+    fit_predict.__doc__ = DBSCAN_original.fit_predict.__doc__