DOC: Describe behaviors from array API#2707
Merged
david-cortes-intel merged 5 commits intouxlfoundation:mainfrom Oct 10, 2025
Merged
DOC: Describe behaviors from array API#2707david-cortes-intel merged 5 commits intouxlfoundation:mainfrom
david-cortes-intel merged 5 commits intouxlfoundation:mainfrom
Conversation
david-cortes-intel
requested review from
Alexsandruss and
napetrov
as code owners
david-cortes-intel
requested review from
ahuber21,
ethanglaser and
homksei
as code owners
david-cortes-intel
requested review from
Vika-F,
icfaust,
maria-Petrova,
syakov-intel and
yuejiaointel
as code owners
|
|
||
| When passing array API inputs to methods such as ``.predict()`` of estimators with array API support, the output | ||
| will always be of the same class as the inputs, but be aware that array attributes of fitted models (e.g. ``coef_`` | ||
| in a linear model) will not necessarily be of the same class as array API inputs passed to ``.fit()``, even though |
Contributor
Author
There was a problem hiding this comment.
@icfaust Feel free to add a better paragraph here.
Contributor
There was a problem hiding this comment.
I'll give it a look! Thanks for the work!
6 tasks
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
icfaust
approved these changes
Oct 10, 2025
| DPCTL or DPNP inputs are not required to use `config_context(target_offload=device)`. | ||
| `sklearnex` will use input usm_ndarray sycl context for device offloading. | ||
| .. note:: | ||
| Unlike |sklearn|, |sklearnex| does not require `array-api-compat <https://github.com/data-apis/array-api-compat>`__ |
Contributor
There was a problem hiding this comment.
This note unfortunately needs to be removed. array-api-compat is necessary via sklearn's get_namespace which is used throughout on our side, as well as in validate_data. We just don't insist on array-api-compat in the onedal module/estimators (hence why its either lazy loaded there or functions like get_namespace are avoided).
Contributor
Author
There was a problem hiding this comment.
Removed.
Comment on lines
+105
to
+109
| While full array API support is currently not implemented for all classes, :external+dpnp:doc:`dpnp.ndarray <reference/ndarray>` | ||
| and :external+dpctl:doc:`dpctl.tensor <api_reference/dpctl/tensor>` inputs are supported by all the classes | ||
| that have :ref:`GPU support <oneapi_gpu>`. Note however that if array API support is not enabled in |sklearn|, | ||
| when passing these classes as inputs, data will be transferred to host and then back to device instead of being | ||
| used directly. |
david-cortes-intel
merged commit 3d86aeb
into
uxlfoundation:main
12 of 13 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the doc section about array API support to reflect the behaviors of the library as of today.
Since it looks like there won't be major changes in the dispatching logic for a while, the PR tries to describe all of the current behaviors, even if they might not sound very logical.
I am not 100% certain that I'm getting all the details right so @icfaust please give it a thorough read. In particular, I am not sure when sklearnex models will have attributes that are array API classes and when not.
During the changes here, I noticed that the doc page for array API was linking to examples that pass dpnp/dpctl data, but those weren't using array API so data was being moved back and forth regardless. Since those do not have 'array_api' in their names I simply removed them and added a more descriptive example.
Checklist:
Completeness and readability
Testing