DOC: Array API support #1918

samir-nasibli · 2024-07-05T10:06:35Z

Description

Docs update for functional support of array API in 2025.0 rls version

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, if necessary (updated in # - add PR number)
The unit tests pass successfully.
I have run it locally and tested the changes extensively.
I have resolved any merge conflicts that might occur with the base branch.
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.

doc/sources/array_api.rst

icfaust

Here is a deep review of the text. We can still aim to have this integrated today.

doc/sources/array_api.rst

examples/sklearnex/dbscan_array_api.py

samir-nasibli · 2024-10-18T08:52:24Z

/intelci: run

samir-nasibli · 2024-10-18T08:53:10Z

/intelci: run

For new example run validation.

doc/sources/array_api.rst

tests/run_examples.py

doc/sources/array_api.rst

examples/sklearnex/dbscan_array_api.py

samir-nasibli · 2024-10-18T11:41:11Z

/intelci: run

icfaust

Further english suggestions.

doc/sources/array_api.rst

icfaust · 2024-10-18T11:43:43Z

doc/sources/array_api.rst

+`Data Parallel Control usm_ndarray <https://intelpython.github.io/dpctl/latest/index.html>`__ all computation
+will be only accomplished on CPU.
+
+Stock scikit-learn uses `config_context(array_api_dispatch=True)` for enabling Array API `support <https://scikit-learn.org/1.5/modules/array_api.html>`__.


Suggested change

Stock scikit-learn uses `config_context(array_api_dispatch=True)` for enabling Array API `support <https://scikit-learn.org/1.5/modules/array_api.html>`__.

Scikit-learn uses `config_context(array_api_dispatch=True)` for enabling Array API `support <https://scikit-learn.org/1.5/modules/array_api.html>`__.

Double check capitalization of Scikit-learn vs Scikit-Learn in this file, it could be that my suggestions to 'Scikit-Learn' are incorrect, but they need to be consistent.

I would like to leave stock prefix here just for the context.
Everywhere in our docs and repository Scikit-learn is used. If updates are required then that alignment could be done as a follow up in separate PR

What does stock mean in this case?

Stock means base or original scikit-learn: https://scikit-learn.org/stable/

I am referencing other to other parts of our docs where this is used.

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/README.md?plain=1#L91

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/README.md?plain=1#L94

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/examples/sklearnex/verbose_mode.py#L18

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/doc/sources/tutorials.rst#L63

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/doc/sources/oneapi-gpu.rst#L64

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/doc/sources/kaggle/regression.rst#L21

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/doc/sources/quick-start.rst#L166

https://github.com/intel/scikit-learn-intelex/blob/b077b6c35c5fb8ff191c9ea4c636cf73964005ba/doc/sources/kaggle/classification.rst#L21

Also it is used in docstrings everywhere through the repo.

samir-nasibli · 2024-10-18T12:47:11Z

/intelci: run

doc/sources/array_api.rst

david-cortes-intel · 2024-10-18T12:49:24Z

doc/sources/array_api.rst

+`Data Parallel Control usm_ndarray <https://intelpython.github.io/dpctl/latest/index.html>`__ all computation
+will be only accomplished on CPU unless specified by a config_context with an available GPU device.


Suggested change

`Data Parallel Control usm_ndarray <https://intelpython.github.io/dpctl/latest/index.html>`__ all computation

will be only accomplished on CPU unless specified by a config_context with an available GPU device.

`Data Parallel Control usm_ndarray <https://intelpython.github.io/dpctl/latest/index.html>`__ all computations

will be performed only on CPU unless specified by a config_context with an available GPU device.

Why this suggestion is needed?

Not strictly needed, but I'd say it sounds more grammatical.

reorder the sections

samir-nasibli · 2024-10-18T14:28:32Z

/intelci: run

icfaust

Dependent on Davids concerns being properly addressed.

samir-nasibli · 2024-10-21T01:39:22Z

/intelci: run

doc/sources/array_api.rst

samir-nasibli · 2024-10-21T13:17:20Z

@mergify backport rls/2025.0.0-rls

mergify · 2024-10-21T13:17:29Z

backport rls/2025.0.0-rls

✅ Backports have been created

#2122 DOC: Array API support (backport #1918) has been created for branch rls/2025.0.0-rls but encountered conflicts

* DOC: Array API suport * Example for DBSCAN array API (cherry picked from commit cde94da) # Conflicts: # doc/sources/index.rst

* DOC: Array API support (#1918) * Example for DBSCAN array API (cherry picked from commit cde94da) # Conflicts: # doc/sources/index.rst * fix merge conflict --------- Co-authored-by: Samir Nasibli <samir.nasibli@intel.com>

DOC: Array API suport

e301d16

samir-nasibli added the Array API label Jul 5, 2024

samir-nasibli mentioned this pull request Jul 17, 2024

ENH: functional support for Array API #1861

Merged

8 tasks

samir-nasibli added 4 commits August 10, 2024 04:50

Minor update array_api.rst

86ccd38

Merge branch 'intel:main' into doc/array_api

ab177e6

Merge branch 'intel:main' into doc/array_api

7a84504

update

1910969

samir-nasibli added the documentation label Oct 14, 2024

samir-nasibli mentioned this pull request Oct 15, 2024

FIX: update functional support fallback logic for a DPNP/DPCTL ndarray inputs #2113

Merged

13 tasks

Merge branch 'main' into doc/array_api

ff372f7

samir-nasibli commented Oct 17, 2024

View reviewed changes

doc/sources/array_api.rst Outdated Show resolved Hide resolved

update

fd49f44

samir-nasibli commented Oct 18, 2024

View reviewed changes

doc/sources/array_api.rst Outdated Show resolved Hide resolved

icfaust reviewed Oct 18, 2024

View reviewed changes

update; examples added

ac0c44f

samir-nasibli marked this pull request as ready for review October 18, 2024 08:44

samir-nasibli requested review from maria-Petrova, Alexsandruss, napetrov and emmwalsh as code owners October 18, 2024 08:44

samir-nasibli requested review from olegkkruglov, david-cortes-intel and ethanglaser October 18, 2024 08:45

samir-nasibli commented Oct 18, 2024

View reviewed changes

examples/sklearnex/dbscan_array_api.py Outdated Show resolved Hide resolved

david-cortes-intel reviewed Oct 18, 2024

View reviewed changes

doc/sources/array_api.rst Outdated Show resolved Hide resolved

tests/run_examples.py Show resolved Hide resolved

doc/sources/array_api.rst Outdated Show resolved Hide resolved

samir-nasibli added 2 commits October 18, 2024 03:38

corrections

3f67756

minor update for Support for Array API-compatible inputs

c79b818

samir-nasibli commented Oct 18, 2024

View reviewed changes

examples/sklearnex/dbscan_array_api.py Outdated Show resolved Hide resolved

Update examples/sklearnex/dbscan_array_api.py

f543a27

samir-nasibli requested review from icfaust and david-cortes-intel October 18, 2024 11:41

icfaust reviewed Oct 18, 2024

View reviewed changes

english corrections

64f53d6

samir-nasibli requested a review from icfaust October 18, 2024 12:46

david-cortes-intel reviewed Oct 18, 2024

View reviewed changes

english correction

14c1503

reorder the sections

icfaust approved these changes Oct 18, 2024

View reviewed changes

samir-nasibli requested a review from david-cortes-intel October 18, 2024 14:40

Merge branch 'intel:main' into doc/array_api

d1a450f

david-cortes-intel approved these changes Oct 21, 2024

View reviewed changes

doc/sources/array_api.rst Outdated Show resolved Hide resolved

doc/sources/array_api.rst Outdated Show resolved Hide resolved

english corrections

e9e02f4

samir-nasibli merged commit cde94da into uxlfoundation:main Oct 21, 2024
9 of 12 checks passed

samir-nasibli deleted the doc/array_api branch October 21, 2024 13:16

mergify bot pushed a commit that referenced this pull request Oct 21, 2024

DOC: Array API support (#1918)

d58aa1b

* DOC: Array API suport * Example for DBSCAN array API (cherry picked from commit cde94da) # Conflicts: # doc/sources/index.rst

mergify bot mentioned this pull request Oct 21, 2024

DOC: Array API support (backport #1918) #2122

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Array API support #1918

DOC: Array API support #1918

samir-nasibli commented Jul 5, 2024 •

edited

Loading

icfaust left a comment

samir-nasibli commented Oct 18, 2024

samir-nasibli commented Oct 18, 2024

samir-nasibli commented Oct 18, 2024

icfaust left a comment

icfaust Oct 18, 2024

icfaust Oct 18, 2024

samir-nasibli Oct 18, 2024

icfaust Oct 18, 2024

samir-nasibli Oct 18, 2024

samir-nasibli commented Oct 18, 2024

david-cortes-intel Oct 18, 2024

samir-nasibli Oct 18, 2024

david-cortes-intel Oct 21, 2024

samir-nasibli commented Oct 18, 2024

icfaust left a comment

samir-nasibli commented Oct 21, 2024

samir-nasibli commented Oct 21, 2024

mergify bot commented Oct 21, 2024 •

edited

Loading

	Stock scikit-learn uses `config_context(array_api_dispatch=True)` for enabling Array API `support <https://scikit-learn.org/1.5/modules/array_api.html>`__.
	Scikit-learn uses `config_context(array_api_dispatch=True)` for enabling Array API `support <https://scikit-learn.org/1.5/modules/array_api.html>`__.

		`Data Parallel Control usm_ndarray <https://intelpython.github.io/dpctl/latest/index.html>`__ all computation
		will be only accomplished on CPU unless specified by a config_context with an available GPU device.

DOC: Array API support #1918

DOC: Array API support #1918

Conversation

samir-nasibli commented Jul 5, 2024 • edited Loading

Description

icfaust left a comment

Choose a reason for hiding this comment

samir-nasibli commented Oct 18, 2024

samir-nasibli commented Oct 18, 2024

samir-nasibli commented Oct 18, 2024

icfaust left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samir-nasibli commented Oct 18, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samir-nasibli commented Oct 18, 2024

icfaust left a comment

Choose a reason for hiding this comment

samir-nasibli commented Oct 21, 2024

samir-nasibli commented Oct 21, 2024

mergify bot commented Oct 21, 2024 • edited Loading

✅ Backports have been created

samir-nasibli commented Jul 5, 2024 •

edited

Loading

mergify bot commented Oct 21, 2024 •

edited

Loading