scikit-learn-intelex 2025.10.0__py313-none-win_amd64.whl

scikit_learn_intelex-2025.10.0.data/data/Lib/site-packages/onedal/dummy/dummy.py

@@ -0,0 +1,137 @@
+# ==============================================================================
+# Copyright Contributors to the oneDAL Project
+#
+# 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.
+# ==============================================================================
+
+"""This file describes necessary characteristics and design patterns of onedal estimators.
+
+This can be used as a foundation for developing other estimators. Most
+comments guiding code development should be removed unless pertinent to the
+implementation."""
+
+from .._device_offload import supports_queue
+from ..common._backend import bind_default_backend
+from ..datatypes import from_table, to_table
+
+
+class DummyEstimator:
+    # This class creates a constant 2d array of specific size as an example
+
+    def __init__(self, constant=False):
+        # The __init__ method should only assign class attributes matching
+        # the input parameters (similar to sklearn).  It is not to assign
+        # any attributes which aren't related to the operation of oneDAL.
+        # This is means that it should not conform to sklearn, only to
+        # oneDAL. Don't add unnecessary attributes which only match sklearn,
+        # these should be translated by the sklearnex estimator. In this case
+        # the only parameter for the dummy algorithm is the `constant` param.
+        self.constant = constant
+        self._onedal_model = None
+
+    # see documentation on bind_default_backend. There exists three possible
+    # oneDAL pybind11 interfaces, 'host', 'dpc' and 'spmd'. These are for
+    # cpu-only, cpu and gpu, and multi-device computation respectively. Logic
+    # in the onedal module will determine which can be used at import time.
+    # It will attempt to use the `dpc` interface if possible (which enables
+    # gpu computation) but requires a SYCL runtime. If not possible it will
+    # silently fall back to the 'host' pybind11 interface. The backend
+    # binding logic will seamlessly handle this for the estimator. The 'spmd'
+    # backend is specific to onedal estimators defined in the 'spmd' folder.
+    # The binding makes the pybind11 function a method of this class with
+    # the same name (in this case ProtoTypeEstimator.compute should call
+    # the pybind11 function onedal.backend.dummy.generate.train)
+    # where backend can be one of 'host', 'dpc' or 'spmd'.
+    @bind_default_backend("dummy.generate")
+    def train(self, params, data_table): ...
+
+    @bind_default_backend("dummy.generate")
+    def infer(self, params, model, data_table): ...
+
+    @supports_queue
+    def fit(self, X, y, queue=None):
+        # convert the data to oneDAL tables in preparation for use by the
+        # oneDAL pybind11 interfaces/objects.
+        X_t, y_t = to_table(X, y)
+
+        # Generating the params dict can be centralized into a class method,
+        # but it must be named ``_get_onedal_params``. Parameter 'fptype' is
+        # specific to the pybind11 interface, and cannot be found in oneDAL
+        # documentation. This tells oneDAL what float type to use for the
+        # computation. The safest and best way to assign this value is after
+        # the input data has been converted to a oneDAL table, as the dtype
+        # is standardized (taken care of by ``to_table``).  This dtype is a
+        # ``numpy`` dtype due to its ubiquity and native support in pybind11.
+        params = {
+            "fptype": y_t.dtype,  # normally X_t.dtype is used
+            "method": "dense",
+            "constant": self.constant,
+        }
+
+        # This is the call to the oneDAL pybind11 backend, which was
+        # previously bound using ``bind_default_backend``. It returns a
+        # pybind11 Python interface to the oneDAL C++ result object.
+        result = self.train(params, y_t)
+        # In general the naming conventions of ``fit`` match to ``train``,
+        # and ``predict`` match oneDAL's ``infer``. Please refer to the oneDAL
+        # design documentation to determine the best translation (headers
+        # under oneDAL/tree/main/cpp/oneapi/dal in the oneDAL repository,
+        # like for other correlaries like ``compute`` and ``partial_train``.
+        # Generally the sklearn naming scheme for class methods should be
+        # used here, but calls to the pybind11 interfaces should follow
+        # oneDAL naming.
+
+        # Oftentimes oneDAL table objects are attributes of the oneDAL C++
+        # object. These can be converted into various common data frameworks
+        # like ``numpy`` or ``dpctl.tensor`` using ``from_table``. In this
+        # case the output is a basic python type (bool) which can be handled
+        # easily just with pybind11 without any special code. Attributes of
+        # the result object are copied to attributes of the onedal estimator
+        # object.
+
+        self.constant_, self.fit_X_, self.fit_y_ = from_table(
+            result.data, X_t, y_t, like=X
+        )
+        # The fit_X_ and fit_y_ attributes are not required and are generally
+        # discouraged. They are set in order to show the process of setting
+        # and returning array values (and is just an example).  In setting
+        # return attributes, post processing of the values beyond conversion
+        # needed for sklearn must occur in the sklearnex estimator.
+
+    def _create_model(self):
+        # While doing something rather trivial, this is closer to what may
+        # occur in other estimators which can generate models just in time.
+        # Necessary attributes are collected, converted to oneDAL tables
+        # and set to the oneDAL object. In general there should be a oneDAL
+        # model class defined with serialization and deserialization with a
+        # pybind11 interface.
+
+        # When the model is a oneDAL object (see svm), it must maintain a
+        # pybind11 interface to the `serialization` and `deserialization`
+        # oneDAL routines for proper pickling of the oneDAL object. oneDAL
+        # tables must be converted to the array type of the fitted estimator
+        # for pickling/unpickling (see any incremental estimator pybind11
+        # implementation).
+
+        # This example just treats a oneDAL table as the model.
+        return to_table(self.constant_)
+
+    @supports_queue
+    def predict(self, X, queue=None):
+        X_t = to_table(X)
+        if self._onedal_model is None:
+            self._onedal_model = self._create_model()
+
+        params = {"fptype": X_t.dtype, "method": "dense", "constant": self.constant}
+        result = self.infer(params, self._onedal_model, X_t)
+        return from_table(result.data, like=X)

scikit_learn_intelex-2025.10.0.data/data/Lib/site-packages/onedal/ensemble/__init__.py

@@ -0,0 +1,29 @@
+# ==============================================================================
+# Copyright 2023 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 .forest import (
+    ExtraTreesClassifier,
+    ExtraTreesRegressor,
+    RandomForestClassifier,
+    RandomForestRegressor,
+)
+
+__all__ = [
+    "RandomForestClassifier",
+    "RandomForestRegressor",
+    "ExtraTreesClassifier",
+    "ExtraTreesRegressor",
+]