Skip to content
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

DOC: Clarify requirements for running on GPU and supported configurations #2286

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

Conversation

david-cortes-intel
Copy link
Contributor

@david-cortes-intel david-cortes-intel commented Jan 29, 2025

Description

Add a comprehensive description of proposed changes

List associated issue number(s) if exist(s): #6 (for example)

Documentation PR (if needed): #1340 (for example)

Benchmarks PR (if needed): IntelPython/scikit-learn_bench#155 (for example)


This PR:

  • Updates the information about which configurations are supported on each distribution channel (latest conda-forge release has DPC and SPMD modules).
  • Updates the list of supported python and sklearn versions to reflect the current situation in the main branch.
  • Updates the description of GPU support logic.
  • Updates the requirements on GPU software that is needed.
  • Improves the examples by adding direct links to DPCTL docs, more code snippets, fixing typos, etc.

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 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.

Performance

Not applicable.

Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure 77.96% <ø> (ø)
github 71.00% <ø> (ø)

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

@david-cortes-intel david-cortes-intel changed the title DOC: Clarify requirements for running on GPU DOC: Clarify requirements for running on GPU and supported configurations Jan 29, 2025
README.md Outdated Show resolved Hide resolved
Copy link

@syakov-intel syakov-intel left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@ethanglaser ethanglaser left a comment

Choose a reason for hiding this comment

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

Very nice work on this, the docs are much improved

README.md Outdated Show resolved Hide resolved
doc/sources/distributed-mode.rst Show resolved Hide resolved
doc/sources/quick-start.rst Show resolved Hide resolved
- [CPU]
- [CPU]
- [CPU]
*Note: the main Anaconda channel also provides distributions of scikit-learn-intelex, but it does not provide the latest versions, nor does it provide GPU-enabled builds. It is highly recommended to install it from either Intel's channel or conda-forge instead.*
Copy link
Contributor

Choose a reason for hiding this comment

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

Not entirely true: conda-forge linux build contains dpc and spmd_dpc libs starting from 2025 release. However, GPU support is not tested for it due to HW unavailability in conda-forge-feedstock CI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Alexsandruss Thanks for the clarification.

But does the build from conda-forge differ from the build from intel-conda in some way that would affect GPU support? As I understand it, both of them are built with the exact same build-time dependencies (compiler, headers, TBB, MKL, MPI) in the exact same versions.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Alexsandruss Thanks for the clarification.

But does the build from conda-forge differ from the build from intel-conda in some way that would affect GPU support? As I understand it, both of them are built with the exact same build-time dependencies (compiler, headers, TBB, MKL, MPI) in the exact same versions.

Toolchains are different: intel conda channel used internal, conda-forge - public.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

But then again: what differences are there in those toolchains that could affect GPU support, if they are at the same version numbers?

Copy link
Contributor

@maria-Petrova maria-Petrova left a comment

Choose a reason for hiding this comment

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

LGTM

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

Successfully merging this pull request may close these issues.

6 participants