DOC: Update quick-start instructions #2282
Closed
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
Screenshow of how it'd look like after the PR: |
david-cortes-intel
requested review from
maria-Petrova,
napetrov,
Alexsandruss,
samir-nasibli and
icfaust
as code owners
icfaust
reviewed
Jan 29, 2025
| @@ -370,12 +310,15 @@ Software Requirements | |||
|
|
|||
| If you use accelerators, refer to `oneAPI DPC++/C++ Compiler System Requirements <https://www.intel.com/content/www/us/en/developer/articles/system-requirements/intel-oneapi-dpcpp-system-requirements.html>`_. | |||
|
|
|||
| Intel(R) Extension for Scikit-learn is compatible with the last four versions of scikit-learn: | |||
| Intel(R) Extension for Scikit-learn is compatible with the last stable releases of scikit-learn: | |||
There was a problem hiding this comment.
@napetrov @syakov-intel please review this, I'd prefer something a little more ambiguous. "compatible with four major releases of scikit-learn.
|
Closing in favor of a larger PR where these changes were merged: #2282 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
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)
The current installation instructions suggest installing sklearnex from the conda-forge channel as the recommended way, but this channel does not come with GPU support per the table. It also mentions that the package can be installed from the main anaconda channel as a third option.
This PR changes the docs so that the conda intel channel would be recommended over the conda-forge one, and removes the instructions for the main anaconda channel, as they do not distribute recent versions of sklearnex (last release there is 2023.1.1)
It also updates the list of supported sklearn versions to include the latest releases (which are now supported), as well as the list of supported python versions to include 3.13, for which there hopefully will be wheels available by the next sklearnex release.
Since right now there is no differentiation of features by OS or python version, it also changes the format of the support tables to something simpler and easier to read.
Besides the support for CPU/GPU, the PR also adds info about other supported devices (FPGAs, which are covered by DPC) and about SPMD mode, which is currently not available in all distribution channels.
Checklist to comply with before moving PR from draft:
PR completeness and readability
Testing
Performance
Not applicable.