Skip to content

update: update algorithm and preview #2354

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

yuejiaointel
Copy link
Contributor

This PR updates the sklearnex doc with new features implemented in past year
PR completeness and readability

  • 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 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.
  • I have extended testing suite if new functionality was introduced in this PR.

Performance

  • I have measured performance for affected algorithms using scikit-learn_bench and provided at least summary table with measured data, if performance change is expected.
  • I have provided justification why performance has changed or why changes are not expected.
  • I have provided justification why quality metrics have changed or why changes are not expected.
  • I have extended benchmarking suite and provided corresponding scikit-learn_bench PR if new measurable functionality was introduced in this PR.

Copy link

codecov bot commented Mar 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

see 54 files with indirect coverage changes

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

Copy link
Contributor

@david-cortes-intel david-cortes-intel left a comment

Choose a reason for hiding this comment

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

I think it's also missing some details about specifics of support - for example, for TSNE, it only works with n_components=2.

@@ -100,6 +100,12 @@ Regression
- ``normalize`` != `False`
- ``sample_weight`` != `None`
- Only dense data is supported.
* - `IncrementalLinearRegression`
Copy link
Contributor

Choose a reason for hiding this comment

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

This is not a scikit-learn estimator and the top of the doc mentions "the following sklearn estimators", so shouldn't be listed here. Docs about what it supports could be moved to its docstrings, or to a new section at the end of this doc.

Same for the other incremental algorithms.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thx! Removed all incremental algos.

Copy link
Contributor

Choose a reason for hiding this comment

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

Please add the limitations in what they support to their docstrings.

@david-cortes-intel
Copy link
Contributor

Also appears to be missing some algorithms like ExtraTrees.

@yuejiaointel
Copy link
Contributor Author

Also appears to be missing some algorithms like ExtraTrees.

Added! thx

@david-cortes-intel
Copy link
Contributor

Not related to the aim of this PR, but I'm thinking it'd be nice to have the classes listed here offer clickable links to the sklearn docs. Since we have intersphinx with sklearn confgured on it, it could be done with something like this:

:obj:`sklearn.ensemble.ExtraTreesClassifier`

or

:obj:`ExtraTreesClassifier <sklearn.ensemble.ExtraTreesClassifier>`

@icfaust icfaust changed the title update: update aldorithm and preview update: update algorithm and preview Mar 18, 2025
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