scikit-learn-intelex 2025.0.0__py311-none-manylinux_2_28_x86_64.whl

sklearnex/spmd/ensemble/forest.py

@@ -0,0 +1,71 @@
+# ==============================================================================
+# 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 onedal.spmd.ensemble import RandomForestClassifier as onedal_RandomForestClassifier
+from onedal.spmd.ensemble import RandomForestRegressor as onedal_RandomForestRegressor
+
+from ...ensemble import RandomForestClassifier as RandomForestClassifier_Batch
+from ...ensemble import RandomForestRegressor as RandomForestRegressor_Batch
+
+
+class RandomForestClassifier(RandomForestClassifier_Batch):
+    __doc__ = RandomForestClassifier_Batch.__doc__
+    _onedal_factory = onedal_RandomForestClassifier
+
+    def _onedal_cpu_supported(self, method_name, *data):
+        # TODO:
+        # check which methods supported SPMD interface on CPU.
+        ready = super()._onedal_cpu_supported(method_name, *data)
+        if not ready:
+            raise RuntimeError(
+                f"Method {method_name} in {self.__class__.__name__} "
+                "is not supported with given inputs."
+            )
+        return ready
+
+    def _onedal_gpu_supported(self, method_name, *data):
+        ready = super()._onedal_gpu_supported(method_name, *data)
+        if not ready:
+            raise RuntimeError(
+                f"Method {method_name} in {self.__class__.__name__} "
+                "is not supported with given inputs."
+            )
+        return ready
+
+
+class RandomForestRegressor(RandomForestRegressor_Batch):
+    __doc__ = RandomForestRegressor_Batch.__doc__
+    _onedal_factory = onedal_RandomForestRegressor
+
+    def _onedal_cpu_supported(self, method_name, *data):
+        # TODO:
+        # check which methods supported SPMD interface on CPU.
+        ready = super()._onedal_cpu_supported(method_name, *data)
+        if not ready:
+            raise RuntimeError(
+                f"Method {method_name} in {self.__class__.__name__} "
+                "is not supported with given inputs."
+            )
+        return ready
+
+    def _onedal_gpu_supported(self, method_name, *data):
+        ready = super()._onedal_gpu_supported(method_name, *data)
+        if not ready:
+            raise RuntimeError(
+                f"Method {method_name} in {self.__class__.__name__} "
+                "is not supported with given inputs."
+            )
+        return ready

sklearnex/spmd/ensemble/tests/test_forest_spmd.py

@@ -0,0 +1,265 @@
+# ==============================================================================
+# Copyright 2024 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 numpy as np
+import pytest
+from sklearn.datasets import make_regression
+
+from onedal.tests.utils._dataframes_support import (
+    _convert_to_dataframe,
+    get_dataframes_and_queues,
+)
+from sklearnex.tests._utils_spmd import (
+    _generate_classification_data,
+    _generate_regression_data,
+    _get_local_tensor,
+    _mpi_libs_and_gpu_available,
+    _spmd_assert_allclose,
+)
+
+
+@pytest.mark.skipif(
+    not _mpi_libs_and_gpu_available,
+    reason="GPU device and MPI libs required for test",
+)
+@pytest.mark.parametrize(
+    "dataframe,queue",
+    get_dataframes_and_queues(dataframe_filter_="dpnp,dpctl", device_filter_="gpu"),
+)
+@pytest.mark.mpi
+def test_rfcls_spmd_gold(dataframe, queue):
+    # Import spmd and batch algo
+    from sklearnex.ensemble import RandomForestClassifier as RandomForestClassifier_Batch
+    from sklearnex.spmd.ensemble import (
+        RandomForestClassifier as RandomForestClassifier_SPMD,
+    )
+
+    # Create gold data and convert to dataframe
+    X_train = np.array(
+        [
+            [0.0, 0.0],
+            [0.0, 1.0],
+            [1.0, 0.0],
+            [0.0, 2.0],
+            [2.0, 0.0],
+            [1.0, 1.0],
+            [0.0, -1.0],
+            [-1.0, 0.0],
+            [-1.0, -1.0],
+        ]
+    )
+    y_train = np.array([0, 2, 1, 2, 1, 0, 1, 2, 0])
+    X_test = np.array(
+        [
+            [1.0, -1.0],
+            [-1.0, 1.0],
+            [0.0, 1.0],
+            [10.0, -10.0],
+        ]
+    )
+
+    local_dpt_X_train = _convert_to_dataframe(
+        _get_local_tensor(X_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_y_train = _convert_to_dataframe(
+        _get_local_tensor(y_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_X_test = _convert_to_dataframe(
+        _get_local_tensor(X_test), sycl_queue=queue, target_df=dataframe
+    )
+
+    # Ensure predictions of batch algo match spmd
+    spmd_model = RandomForestClassifier_SPMD(n_estimators=3, random_state=0).fit(
+        local_dpt_X_train, local_dpt_y_train
+    )
+    batch_model = RandomForestClassifier_Batch(n_estimators=3, random_state=0).fit(
+        X_train, y_train
+    )
+    spmd_result = spmd_model.predict(local_dpt_X_test)
+    batch_result = batch_model.predict(X_test)
+
+    pytest.skip("SPMD and batch random forest results not aligned")
+    _spmd_assert_allclose(spmd_result, batch_result)
+
+
+@pytest.mark.skipif(
+    not _mpi_libs_and_gpu_available,
+    reason="GPU device and MPI libs required for test",
+)
+@pytest.mark.parametrize("n_samples", [200, 1000])
+@pytest.mark.parametrize("n_features_and_classes", [(5, 2), (25, 2), (25, 10)])
+@pytest.mark.parametrize("n_estimators", [10, 100])
+@pytest.mark.parametrize("max_depth", [3, None])
+@pytest.mark.parametrize(
+    "dataframe,queue",
+    get_dataframes_and_queues(dataframe_filter_="dpnp,dpctl", device_filter_="gpu"),
+)
+@pytest.mark.parametrize("dtype", [np.float32, np.float64])
+@pytest.mark.mpi
+def test_rfcls_spmd_synthetic(
+    n_samples, n_features_and_classes, n_estimators, max_depth, dataframe, queue, dtype
+):
+    n_features, n_classes = n_features_and_classes
+    # Import spmd and batch algo
+    from sklearnex.ensemble import RandomForestClassifier as RandomForestClassifier_Batch
+    from sklearnex.spmd.ensemble import (
+        RandomForestClassifier as RandomForestClassifier_SPMD,
+    )
+
+    # Generate data and convert to dataframe
+    X_train, X_test, y_train, _ = _generate_classification_data(
+        n_samples, n_features, n_classes, dtype=dtype
+    )
+
+    local_dpt_X_train = _convert_to_dataframe(
+        _get_local_tensor(X_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_y_train = _convert_to_dataframe(
+        _get_local_tensor(y_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_X_test = _convert_to_dataframe(
+        _get_local_tensor(X_test), sycl_queue=queue, target_df=dataframe
+    )
+
+    # Ensure predictions of batch algo match spmd
+    spmd_model = RandomForestClassifier_SPMD(
+        n_estimators=n_estimators, max_depth=max_depth, random_state=0
+    ).fit(local_dpt_X_train, local_dpt_y_train)
+    batch_model = RandomForestClassifier_Batch(
+        n_estimators=n_estimators, max_depth=max_depth, random_state=0
+    ).fit(X_train, y_train)
+    spmd_result = spmd_model.predict(local_dpt_X_test)
+    batch_result = batch_model.predict(X_test)
+
+    pytest.skip("SPMD and batch random forest results not aligned")
+    _spmd_assert_allclose(spmd_result, batch_result)
+
+
+@pytest.mark.skipif(
+    not _mpi_libs_and_gpu_available,
+    reason="GPU device and MPI libs required for test",
+)
+@pytest.mark.parametrize(
+    "dataframe,queue",
+    get_dataframes_and_queues(dataframe_filter_="dpnp,dpctl", device_filter_="gpu"),
+)
+@pytest.mark.mpi
+def test_rfreg_spmd_gold(dataframe, queue):
+    # Import spmd and batch algo
+    from sklearnex.ensemble import RandomForestRegressor as RandomForestRegressor_Batch
+    from sklearnex.spmd.ensemble import (
+        RandomForestRegressor as RandomForestRegressor_SPMD,
+    )
+
+    # Create gold data and convert to dataframe
+    X_train = np.array(
+        [
+            [0.0, 0.0],
+            [0.0, 1.0],
+            [1.0, 0.0],
+            [0.0, 2.0],
+            [2.0, 0.0],
+            [1.0, 1.0],
+            [0.0, -1.0],
+            [-1.0, 0.0],
+            [-1.0, -1.0],
+        ]
+    )
+    y_train = np.array([3.0, 5.0, 4.0, 7.0, 5.0, 6.0, 1.0, 2.0, 0.0])
+    X_test = np.array(
+        [
+            [1.0, -1.0],
+            [-1.0, 1.0],
+            [0.0, 1.0],
+            [10.0, -10.0],
+        ]
+    )
+
+    local_dpt_X_train = _convert_to_dataframe(
+        _get_local_tensor(X_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_y_train = _convert_to_dataframe(
+        _get_local_tensor(y_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_X_test = _convert_to_dataframe(
+        _get_local_tensor(X_test), sycl_queue=queue, target_df=dataframe
+    )
+
+    # Ensure predictions of batch algo match spmd
+    spmd_model = RandomForestRegressor_SPMD(n_estimators=3, random_state=0).fit(
+        local_dpt_X_train, local_dpt_y_train
+    )
+    batch_model = RandomForestRegressor_Batch(n_estimators=3, random_state=0).fit(
+        X_train, y_train
+    )
+    spmd_result = spmd_model.predict(local_dpt_X_test)
+    batch_result = batch_model.predict(X_test)
+
+    pytest.skip("SPMD and batch random forest results not aligned")
+    _spmd_assert_allclose(spmd_result, batch_result)
+
+
+@pytest.mark.skipif(
+    not _mpi_libs_and_gpu_available,
+    reason="GPU device and MPI libs required for test",
+)
+@pytest.mark.parametrize("n_samples", [200, 1000])
+@pytest.mark.parametrize("n_features", [5, 25])
+@pytest.mark.parametrize("n_estimators", [10, 100])
+@pytest.mark.parametrize("max_depth", [3, None])
+@pytest.mark.parametrize(
+    "dataframe,queue",
+    get_dataframes_and_queues(dataframe_filter_="dpnp,dpctl", device_filter_="gpu"),
+)
+@pytest.mark.parametrize("dtype", [np.float32, np.float64])
+@pytest.mark.mpi
+def test_rfreg_spmd_synthetic(
+    n_samples, n_features, n_estimators, max_depth, dataframe, queue, dtype
+):
+    # Import spmd and batch algo
+    from sklearnex.ensemble import RandomForestRegressor as RandomForestRegressor_Batch
+    from sklearnex.spmd.ensemble import (
+        RandomForestRegressor as RandomForestRegressor_SPMD,
+    )
+
+    # Generate data and convert to dataframe
+    X_train, X_test, y_train, _ = _generate_regression_data(
+        n_samples, n_features, dtype=dtype
+    )
+
+    local_dpt_X_train = _convert_to_dataframe(
+        _get_local_tensor(X_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_y_train = _convert_to_dataframe(
+        _get_local_tensor(y_train), sycl_queue=queue, target_df=dataframe
+    )
+    local_dpt_X_test = _convert_to_dataframe(
+        _get_local_tensor(X_test), sycl_queue=queue, target_df=dataframe
+    )
+
+    # Ensure predictions of batch algo match spmd
+    spmd_model = RandomForestRegressor_Batch(
+        n_estimators=n_estimators, max_depth=max_depth, random_state=0
+    ).fit(local_dpt_X_train, local_dpt_y_train)
+    batch_model = RandomForestRegressor_Batch(
+        n_estimators=n_estimators, max_depth=max_depth, random_state=0
+    ).fit(X_train, y_train)
+    spmd_result = spmd_model.predict(local_dpt_X_test)
+    batch_result = batch_model.predict(X_test)
+
+    # TODO: remove skips when SPMD and batch are aligned
+    pytest.skip("SPMD and batch random forest results not aligned")
+    _spmd_assert_allclose(spmd_result, batch_result)

sklearnex/spmd/linear_model/__init__.py

@@ -0,0 +1,21 @@
+# ==============================================================================
+# 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 .incremental_linear_model import IncrementalLinearRegression
+from .linear_model import LinearRegression
+from .logistic_regression import LogisticRegression
+
+__all__ = ["IncrementalLinearRegression", "LinearRegression", "LogisticRegression"]

sklearnex/spmd/linear_model/incremental_linear_model.py

@@ -0,0 +1,35 @@
+# ==============================================================================
+# Copyright 2024 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 onedal.spmd.linear_model import (
+    IncrementalLinearRegression as onedalSPMD_IncrementalLinearRegression,
+)
+
+from ...linear_model import (
+    IncrementalLinearRegression as base_IncrementalLinearRegression,
+)
+
+
+class IncrementalLinearRegression(base_IncrementalLinearRegression):
+    """
+    Distributed incremental estimator for linear regression.
+    Allows for distributed training of linear regression if data is split into batches.
+
+    API is the same as for `sklearnex.linear_model.IncrementalLinearRegression`.
+    """
+
+    _onedal_incremental_linear = staticmethod(onedalSPMD_IncrementalLinearRegression)

sklearnex/spmd/linear_model/linear_model.py

@@ -0,0 +1,21 @@
+# ==============================================================================
+# 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 onedal.spmd.linear_model import LinearRegression
+
+# TODO:
+# Currently it uses `onedal` module interface.
+# Add sklearnex dispatching.

sklearnex/spmd/linear_model/logistic_regression.py

@@ -0,0 +1,21 @@
+# ==============================================================================
+# Copyright 2024 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 onedal.spmd.linear_model import LogisticRegression
+
+# TODO:
+# Currently it uses `onedal` module interface.
+# Add sklearnex dispatching.