scikit-learn-intelex 2025.1.0__py310-none-manylinux_2_28_x86_64.whl

sklearnex/spmd/decomposition/tests/test_incremental_pca_spmd.py

@@ -0,0 +1,269 @@
+# ==============================================================================
+# 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 numpy.testing import assert_allclose
+
+from onedal.tests.utils._dataframes_support import (
+    _as_numpy,
+    _convert_to_dataframe,
+    get_dataframes_and_queues,
+)
+from sklearnex.tests.utils.spmd import (
+    _generate_statistic_data,
+    _get_local_tensor,
+    _mpi_libs_and_gpu_available,
+)
+
+attributes_to_compare = [
+    "n_components_",
+    "components_",
+    "singular_values_",
+    "mean_",
+    "var_",
+    "explained_variance_",
+    "explained_variance_ratio_",
+]
+
+
+@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.parametrize("whiten", [True, False])
+@pytest.mark.parametrize("dtype", [np.float32, np.float64])
+@pytest.mark.mpi
+def test_incremental_pca_fit_spmd_gold(dataframe, queue, whiten, dtype):
+    # Import spmd and non-SPMD algo
+    from sklearnex.preview.decomposition import IncrementalPCA
+    from sklearnex.spmd.decomposition import IncrementalPCA as IncrementalPCA_SPMD
+
+    # Create gold data and process into dpt
+    X = np.array(
+        [
+            [0.0, 0.0],
+            [1.0, 2.0],
+            [2.0, 4.0],
+            [3.0, 8.0],
+            [4.0, 16.0],
+            [5.0, 32.0],
+            [6.0, 64.0],
+            [7.0, 128.0],
+        ],
+        dtype=dtype,
+    )
+    dpt_X = _convert_to_dataframe(X, sycl_queue=queue, target_df=dataframe)
+    local_X = _get_local_tensor(X)
+    local_dpt_X = _convert_to_dataframe(local_X, sycl_queue=queue, target_df=dataframe)
+
+    incpca_spmd = IncrementalPCA_SPMD(whiten=whiten)
+    incpca = IncrementalPCA(whiten=whiten)
+
+    incpca_spmd.fit(local_dpt_X)
+    incpca.fit(dpt_X)
+
+    for attribute in attributes_to_compare:
+        assert_allclose(
+            getattr(incpca, attribute),
+            getattr(incpca_spmd, attribute),
+            err_msg=f"{attribute} is incorrect",
+        )
+
+
+@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.parametrize("whiten", [True, False])
+@pytest.mark.parametrize("num_blocks", [1, 2])
+@pytest.mark.parametrize("dtype", [np.float32, np.float64])
+@pytest.mark.mpi
+def test_incremental_pca_partial_fit_spmd_gold(
+    dataframe, queue, whiten, num_blocks, dtype
+):
+    # Import spmd and non-SPMD algo
+    from sklearnex.preview.decomposition import IncrementalPCA
+    from sklearnex.spmd.decomposition import IncrementalPCA as IncrementalPCA_SPMD
+
+    # Create gold data and process into dpt
+    X = np.array(
+        [
+            [0.0, 0.0],
+            [1.0, 2.0],
+            [2.0, 4.0],
+            [3.0, 8.0],
+            [4.0, 16.0],
+            [5.0, 32.0],
+            [6.0, 64.0],
+            [7.0, 128.0],
+            [8.0, 0.0],
+            [9.0, 2.0],
+            [10.0, 4.0],
+            [11.0, 8.0],
+            [12.0, 16.0],
+            [13.0, 32.0],
+            [14.0, 64.0],
+            [15.0, 128.0],
+        ],
+        dtype=dtype,
+    )
+    X_split = np.array_split(X, num_blocks)
+    local_X = _get_local_tensor(X)
+    split_local_X = np.array_split(local_X, num_blocks)
+
+    incpca_spmd = IncrementalPCA_SPMD(whiten=whiten)
+    incpca = IncrementalPCA(whiten=whiten)
+
+    for i in range(num_blocks):
+        local_dpt_X = _convert_to_dataframe(
+            split_local_X[i], sycl_queue=queue, target_df=dataframe
+        )
+        dpt_X = _convert_to_dataframe(X_split[i], sycl_queue=queue, target_df=dataframe)
+        incpca.partial_fit(dpt_X)
+        incpca_spmd.partial_fit(local_dpt_X)
+
+    for attribute in attributes_to_compare:
+        assert_allclose(
+            getattr(incpca, attribute),
+            getattr(incpca_spmd, attribute),
+            err_msg=f"{attribute} is incorrect",
+        )
+
+
+@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.parametrize("whiten", [True, False])
+@pytest.mark.parametrize("n_components", [None, 2, 5])
+@pytest.mark.parametrize("num_samples", [100, 200])
+@pytest.mark.parametrize("num_features", [10, 20])
+@pytest.mark.parametrize("dtype", [np.float32, np.float64])
+@pytest.mark.mpi
+def test_incremental_pca_fit_spmd_random(
+    dataframe, queue, whiten, n_components, num_samples, num_features, dtype
+):
+    # Import spmd and non-SPMD algo
+    from sklearnex.preview.decomposition import IncrementalPCA
+    from sklearnex.spmd.decomposition import IncrementalPCA as IncrementalPCA_SPMD
+
+    # Increased test dataset size requires a higher tol setting in comparison to other tests
+    tol = 7e-5 if dtype == np.float32 else 1e-7
+
+    # Create data and process into dpt
+    X = _generate_statistic_data(num_samples, num_features, dtype)
+    dpt_X = _convert_to_dataframe(X, sycl_queue=queue, target_df=dataframe)
+    X_test = _generate_statistic_data(num_samples // 5, num_features, dtype)
+    dpt_X_test = _convert_to_dataframe(X_test, sycl_queue=queue, target_df=dataframe)
+    local_X = _get_local_tensor(X)
+    local_dpt_X = _convert_to_dataframe(local_X, sycl_queue=queue, target_df=dataframe)
+
+    incpca_spmd = IncrementalPCA_SPMD(n_components=n_components, whiten=whiten)
+    incpca = IncrementalPCA(n_components=n_components, whiten=whiten)
+
+    incpca_spmd.fit(local_dpt_X)
+    incpca.fit(dpt_X)
+
+    for attribute in attributes_to_compare:
+        assert_allclose(
+            getattr(incpca, attribute),
+            getattr(incpca_spmd, attribute),
+            atol=tol,
+            err_msg=f"{attribute} is incorrect",
+        )
+
+    y_trans_spmd = incpca_spmd.transform(dpt_X_test)
+    y_trans = incpca.transform(dpt_X_test)
+
+    assert_allclose(_as_numpy(y_trans_spmd), _as_numpy(y_trans), atol=tol)
+
+
+@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.parametrize("whiten", [True, False])
+@pytest.mark.parametrize("n_components", [None, 2, 5])
+@pytest.mark.parametrize("num_blocks", [1, 2])
+@pytest.mark.parametrize("num_samples", [200, 400])
+@pytest.mark.parametrize("num_features", [10, 20])
+@pytest.mark.parametrize("dtype", [np.float32, np.float64])
+@pytest.mark.mpi
+def test_incremental_pca_partial_fit_spmd_random(
+    dataframe,
+    queue,
+    whiten,
+    n_components,
+    num_blocks,
+    num_samples,
+    num_features,
+    dtype,
+):
+    # Import spmd and non-SPMD algo
+    from sklearnex.preview.decomposition import IncrementalPCA
+    from sklearnex.spmd.decomposition import IncrementalPCA as IncrementalPCA_SPMD
+
+    tol = 3e-4 if dtype == np.float32 else 1e-7
+
+    # Create data and process into dpt
+    X = _generate_statistic_data(num_samples, num_features, dtype)
+    dpt_X = _convert_to_dataframe(X, sycl_queue=queue, target_df=dataframe)
+    X_test = _generate_statistic_data(num_samples // 5, num_features, dtype)
+    dpt_X_test = _convert_to_dataframe(X_test, sycl_queue=queue, target_df=dataframe)
+    local_X = _get_local_tensor(X)
+    X_split = np.array_split(X, num_blocks)
+    split_local_X = np.array_split(local_X, num_blocks)
+
+    incpca_spmd = IncrementalPCA_SPMD(n_components=n_components, whiten=whiten)
+    incpca = IncrementalPCA(n_components=n_components, whiten=whiten)
+
+    for i in range(num_blocks):
+        local_dpt_X = _convert_to_dataframe(
+            split_local_X[i], sycl_queue=queue, target_df=dataframe
+        )
+        dpt_X = _convert_to_dataframe(X_split[i], sycl_queue=queue, target_df=dataframe)
+        incpca_spmd.partial_fit(local_dpt_X)
+        incpca.partial_fit(dpt_X)
+
+    for attribute in attributes_to_compare:
+        assert_allclose(
+            getattr(incpca, attribute),
+            getattr(incpca_spmd, attribute),
+            atol=tol,
+            err_msg=f"{attribute} is incorrect",
+        )
+
+    y_trans_spmd = incpca_spmd.transform(dpt_X_test)
+    y_trans = incpca.transform(dpt_X_test)
+
+    assert_allclose(_as_numpy(y_trans_spmd), _as_numpy(y_trans), atol=tol)

sklearnex/spmd/decomposition/tests/test_pca_spmd.py

@@ -0,0 +1,128 @@
+# ==============================================================================
+# 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 numpy.testing import assert_allclose
+
+from onedal.tests.utils._dataframes_support import (
+    _convert_to_dataframe,
+    get_dataframes_and_queues,
+)
+from sklearnex.tests.utils.spmd import (
+    _generate_statistic_data,
+    _get_local_tensor,
+    _mpi_libs_and_gpu_available,
+)
+
+
+@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_pca_spmd_gold(dataframe, queue):
+    # Import spmd and batch algo
+    from sklearnex.decomposition import PCA as PCA_Batch
+    from sklearnex.spmd.decomposition import PCA as PCA_SPMD
+
+    # Create gold data and convert to dataframe
+    data = np.array(
+        [
+            [0.0, 0.0, 0.0],
+            [0.0, 1.0, 2.0],
+            [0.0, 2.0, 4.0],
+            [0.0, 3.0, 8.0],
+            [0.0, 4.0, 16.0],
+            [0.0, 5.0, 32.0],
+            [0.0, 6.0, 64.0],
+            [0.0, 7.0, 128.0],
+        ]
+    )
+
+    local_dpt_data = _convert_to_dataframe(
+        _get_local_tensor(data), sycl_queue=queue, target_df=dataframe
+    )
+
+    # Ensure results of batch algo match spmd
+    spmd_result = PCA_SPMD(n_components=2).fit(local_dpt_data)
+    batch_result = PCA_Batch(n_components=2).fit(data)
+
+    assert_allclose(spmd_result.mean_, batch_result.mean_)
+    assert_allclose(spmd_result.components_, batch_result.components_)
+    assert_allclose(spmd_result.singular_values_, batch_result.singular_values_)
+    assert_allclose(
+        spmd_result.noise_variance_,
+        batch_result.noise_variance_,
+        atol=1e-7,
+    )
+    assert_allclose(
+        spmd_result.explained_variance_ratio_, batch_result.explained_variance_ratio_
+    )
+
+
+@pytest.mark.skipif(
+    not _mpi_libs_and_gpu_available,
+    reason="GPU device and MPI libs required for test",
+)
+@pytest.mark.parametrize("n_samples", [100, 10000])
+@pytest.mark.parametrize("n_features", [10, 100])
+@pytest.mark.parametrize("n_components", [0.5, 3, "mle", None])
+@pytest.mark.parametrize("whiten", [True, False])
+@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_pca_spmd_synthetic(
+    n_samples, n_features, n_components, whiten, dataframe, queue, dtype
+):
+    # TODO: Resolve issues with batch fallback and lack of support for n_rows_rank < n_cols
+    if n_components == "mle" or n_components == 3:
+        pytest.skip("Avoid error in case of batch fallback to sklearn")
+    if n_samples <= n_features:
+        pytest.skip("Avoid n_samples < n_features error from spmd data split")
+
+    # Import spmd and batch algo
+    from sklearnex.decomposition import PCA as PCA_Batch
+    from sklearnex.spmd.decomposition import PCA as PCA_SPMD
+
+    # Generate data and convert to dataframe
+    data = _generate_statistic_data(n_samples, n_features, dtype=dtype)
+
+    local_dpt_data = _convert_to_dataframe(
+        _get_local_tensor(data), sycl_queue=queue, target_df=dataframe
+    )
+
+    # Ensure results of batch algo match spmd
+    spmd_result = PCA_SPMD(n_components=n_components, whiten=whiten).fit(local_dpt_data)
+    batch_result = PCA_Batch(n_components=n_components, whiten=whiten).fit(data)
+
+    tol = 1e-3 if dtype == np.float32 else 1e-7
+    assert_allclose(spmd_result.mean_, batch_result.mean_, atol=tol)
+    assert_allclose(spmd_result.components_, batch_result.components_, atol=tol, rtol=tol)
+    assert_allclose(spmd_result.singular_values_, batch_result.singular_values_, atol=tol)
+    assert_allclose(spmd_result.noise_variance_, batch_result.noise_variance_, atol=tol)
+    assert_allclose(
+        spmd_result.explained_variance_ratio_,
+        batch_result.explained_variance_ratio_,
+        atol=tol,
+    )

sklearnex/spmd/ensemble/__init__.py

@@ -0,0 +1,19 @@
+# ==============================================================================
+# 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 RandomForestClassifier, RandomForestRegressor
+
+__all__ = ["RandomForestClassifier", "RandomForestRegressor"]

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