8000 Make the array API check strict for unit tests by betatim · Pull Request #29571 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Make the array API check strict for unit tests #29571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Make the array API check strict for unit tests #29571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1edd800
Make the array API check strict for unit tests
betatim Jul 26, 2024
bb5c87a
Use explicit scipy variable to check array API config
betatim Jul 30, 2024
119ec90
Move strict array API check
betatim Jul 31, 2024
7eaf420
Update SciPy mock for test
betatim Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 25 additions & 15 deletions sklearn/utils/_array_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

import itertools
import math
import os
import warnings
from functools import wraps

import numpy
import scipy._lib._array_api
import scipy.special as special

from .._config import get_config
Expand Down Expand Up @@ -86,11 +86,19 @@ def yield_namespace_device_dtype_combinations(include_numpy_namespaces=True):
yield array_namespace, None, None


def _check_array_api_dispatch(array_api_dispatch):
"""Check that array_api_compat is installed and NumPy version is compatible.
def _check_array_api_dispatch(array_api_dispatch, misconfigured_scipy="warn"):
"""Check that required dependencies are installed in new enough versions.

array_api_compat follows NEP29, which has a higher minimum NumPy version than
scikit-learn.
We need the array_api_compat package as well as new enough versions of
NumPy and SciPy.

Parameters
----------
array_api_dispatch : bool
Enable or disable array API checks.

misconfigured_scipy : str, default="warn"
Warn or raise an exception when misconfigured SciPy is detected.
"""
if array_api_dispatch:
try:
Expand All @@ -108,17 +116,19 @@ def _check_array_api_dispatch(array_api_dispatch):
f"NumPy must be {min_numpy_version} or newer to dispatch array using"
" the API specification"
)
if os.environ.get("SCIPY_ARRAY_API") != "1":
warnings.warn(
(
"Some scikit-learn array API features might rely on enabling "
"SciPy's own support for array API to function properly. "
"Please set the SCIPY_ARRAY_API=1 environment variable "
"before importing sklearn or scipy. More details at: "
"https://docs.scipy.org/doc/scipy/dev/api-dev/array_api.html"
),
UserWarning,

if not scipy._lib._array_api.SCIPY_ARRAY_API:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since is this private API I would do something link:

try:
   scipy_array_api_enabled = scipy._lib._array_api.SCIPY_ARRAY_API
except AttributeError:
   warnings.warn(
       "Could not inspect if scipy array API support is enabled or not, assuming it is."
   )
   scipy_array_api_enabled = True

if not scipy_array_api_enabled:
   message = ...

Otherwise, a future version of scipy where array API support is enabled by default and does not define this private attribute anymore might break scikit-learn.

message = (
"Some scikit-learn array API features rely on enabling "
"SciPy's own support for array API to function properly. "
"Please set the SCIPY_ARRAY_API=1 environment variable "
"before importing sklearn or scipy. More details at: "
"https://docs.scipy.org/doc/scipy/dev/api-dev/array_api.html"
)
if misconfigured_scipy == "raise":
raise RuntimeError(message)
else:
warnings.warn(message, UserWarning)


def _single_array_device(array):
Expand Down
1 change: 1 addition & 0 deletions sklearn/utils/_testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -987,6 +987,7 @@ def fit_transform(self, X, y=None):


def _array_api_for_tests(array_namespace, device):
_check_array_api_dispatch(True, misconfigured_scipy="raise")
try:
array_mod = importlib.import_module(array_namespace)
except ModuleNotFoundError:
Expand Down
10 changes: 3 additions & 7 deletions sklearn/utils/tests/test_array_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import os
import re
from functools import partial

import numpy
import pytest
import scipy
from numpy.testing import assert_allclose

from sklearn._config import config_context
Expand Down Expand Up @@ -91,12 +91,8 @@ def test_get_namespace_array_api(monkeypatch):
with pytest.raises(TypeError):
xp_out, is_array_api_compliant = get_namespace(X_xp, X_np)

def mock_getenv(key):
if key == "SCIPY_ARRAY_API":
return "0"

monkeypatch.setattr("os.environ.get", mock_getenv)
assert os.environ.get("SCIPY_ARRAY_API") != "1"
monkeypatch.setattr("scipy._lib._array_api.SCIPY_ARRAY_API", False)
assert not scipy._lib._array_api.SCIPY_ARRAY_API
with pytest.warns(
UserWarning,
match="enabling SciPy's own support for array API to function properly. ",
Expand Down
Loading
0