Skip to content

DOC: Reword description about patching in preview mode #2491

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 3 commits into
base: main
Choose a base branch
from

Conversation

david-cortes-intel
Copy link
Contributor

Description

This PR rewords the documentation about patching in preview mode to make it less ambiguous.


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

Copy link

codecov bot commented Jun 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure ?
github 71.62% <ø> (ø)

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

see 41 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@@ -29,8 +29,9 @@ for being enabled by default for all users:
This type of functionality is available under **preview mode** of |sklearnex| and located in
the corresponding module (`sklearnex.preview`).

Preview functionality *may* or *may not* participate in patching of Scikit-learn.
For example, a preview estimator may be a replacement for a stock one or a completely new one.
Functionalities under preview will be made available after patching when preview mode is enabled,
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we sure that the sklearnex-only estimators don't get patched-in? https://github.com/uxlfoundation/scikit-learn-intelex/blob/main/sklearnex/dispatcher.py#L62 It takes the mapping without preview, and then adds the preview estimators on top, and for the sklearnex-only estimators, if it didn't patch in, we would not have sklearn conformance deselections for those estimators (mostly for test_common.py). Maybe I misunderstood? Let me know. This PR should be quick to approve once we iron this out (figure out what I got wrong here).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, looks like patching still makes them importable from sklearn. Modified the docs here and in the section about extension estimators.

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.

2 participants