Skip to content

[enhancement] simplify array_api enabling tags via wrapper #2566

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.

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

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

icfaust
Copy link
Contributor

@icfaust icfaust commented Jun 20, 2025

Description

Add enable_array_api wrapper for classes. This will set the necessary method (__sklearn_tags__ for sklearn>=1.6 or _more_tags for sklearn > 1.3) to signify to the sklearnex infrastructure that array_api_dispatch would work with onedal for that estimator when enabled. Otherwise this code would have to be manually added to each estimator, this will simplify development.

No performance benchmarks necessary as it is an import time cost.


PR should start as a draft, then move to ready for review state after CI is passed and all applicable checkboxes are closed.
This approach ensures that reviewers don't spend extra time asking for regular requirements.

You can remove a checkbox as not applicable only if it doesn't relate to this PR in any way.
For example, PR with docs update doesn't require checkboxes for performance while PR with any change in actual code should have checkboxes and justify how this code change is expected to affect performance (or justification should be self-evident).

Checklist to comply with before moving PR from draft:

PR completeness and readability

  • I have reviewed my changes thoroughly before submitting this pull request.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes or created a separate PR with update and provided its number in the description, if necessary.
  • Git commit message contains an appropriate signed-off-by string (see CONTRIBUTING.md for details).
  • I have added a respective label(s) to PR if I have a permission for that.
  • I have resolved any merge conflicts that might occur with the base branch.

Testing

  • I have run it locally and tested the changes extensively.
  • All CI jobs are green or I have provided justification why they aren't.
  • I have extended testing suite if new functionality was introduced in this PR.

Performance

  • I have measured performance for affected algorithms using scikit-learn_bench and provided at least summary table with measured data, if performance change is expected.
  • I have provided justification why performance has changed or why changes are not expected.
  • I have provided justification why quality metrics have changed or why changes are not expected.
  • I have extended benchmarking suite and provided corresponding scikit-learn_bench PR if new measurable functionality was introduced in this PR.

Copy link

codecov bot commented Jun 20, 2025

Codecov Report

Attention: Patch coverage is 26.66667% with 11 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
sklearnex/utils/_array_api.py 26.66% 11 Missing ⚠️
Flag Coverage Δ
azure 79.82% <20.00%> (-0.14%) ⬇️
github 72.98% <26.66%> (-0.08%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
sklearnex/utils/_array_api.py 59.25% <26.66%> (-40.75%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@icfaust icfaust changed the title [WIP, enhancement] simplify array_api enabling tags via wrapper [enhancement] simplify array_api enabling tags via wrapper Jun 22, 2025
@icfaust icfaust marked this pull request as ready for review June 22, 2025 08:34
@icfaust
Copy link
Contributor Author

icfaust commented Jun 22, 2025

/intelci: run

@david-cortes-intel
Copy link
Contributor

After the latest merges, is there something blocking this PR from applying this function to the current classes that can work with array API?

@icfaust
Copy link
Contributor Author

icfaust commented Jun 23, 2025

After the latest merges, is there something blocking this PR from applying this function to the current classes that can work with array API?

You are right on point with that comment. Unfortunately none of the current estimators are fully array api compliant (realized I didn't include it while writing the first part of the docs), but a deluge of estimators should be ready for review using it in <1 month.

@icfaust
Copy link
Contributor Author

icfaust commented Jun 23, 2025

/intelci: run

@david-cortes-intel
Copy link
Contributor

After the latest merges, is there something blocking this PR from applying this function to the current classes that can work with array API?

You are right on point with that comment. Unfortunately none of the current estimators are fully array api compliant (realized I didn't include it while writing the first part of the docs), but a deluge of estimators should be ready for review using it in <1 month.

@icfaust Then I think it'd be better to hold off this PR until there are estimators ready to apply and test in the same PR.

icfaust added a commit to icfaust/scikit-learn-intelex that referenced this pull request Jul 8, 2025
icfaust added a commit to icfaust/scikit-learn-intelex that referenced this pull request Jul 9, 2025
@Vika-F
Copy link
Contributor

Vika-F commented Jul 15, 2025

Maybe a stupid question, but wouldn't it require checking the version of sklearn (1.3, 1.6) further in the code of each estimator to use the proper API?
Is it possible to decrease the number of sklearn versions check in the code of the sklearnex estimators?

@icfaust
Copy link
Contributor Author

icfaust commented Jul 15, 2025

Maybe a stupid question, but wouldn't it require checking the version of sklearn (1.3, 1.6) further in the code of each estimator to use the proper API? Is it possible to decrease the number of sklearn versions check in the code of the sklearnex estimators?

That is a good question, this will take care of all issues related to array API support at class definition time (import time), meaning those additional checks throughout the codebase are all taken care of here: https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/sklearnex/_device_offload.py#L118 in combination with https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/sklearnex/_utils.py#L31-L43 . These will hide all of the sklearn version oddities related to it from the developer and user and are all done at import time, and makes all of the interfaces look like latest release sklearn with respect to tag interfaces.

@icfaust icfaust requested a review from Copilot July 15, 2025 12:29
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Adds a decorator to automatically attach the right tags for array API support to oneDALEstimator subclasses, reducing boilerplate across estimators.

  • Imports oneDALEstimator and Tags to build the wrapper
  • Adds enable_array_api function that sets __sklearn_tags__ for sklearn ≥1.6 or _more_tags for sklearn ≥1.3
  • Returns the modified class so users can apply @enable_array_api on estimators
Comments suppressed due to low confidence (2)

sklearnex/utils/_array_api.py:90

  • No unit tests were added to verify that enable_array_api correctly attaches __sklearn_tags__ and _more_tags under the intended sklearn versions. Consider adding tests for both code paths.
def enable_array_api(original_class: type[oneDALEstimator]) -> type[oneDALEstimator]:

sklearnex/utils/_array_api.py:117

  • The return type annotation dict[bool] is invalid. It should specify key and value types, e.g., dict[str, bool].
        def _more_tags(self) -> dict[bool]:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants