Skip to content

update: update algorithm.rst based on current implementation #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

Merged
merged 34 commits into from
Jun 11, 2025

Conversation

yuejiaointel
Copy link
Contributor

@yuejiaointel yuejiaointel commented Mar 13, 2025

This PR updates the sklearnex doc with new features implemented. Specifically, it gets updated based on each algorithm file _onedal_supported function.
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.

Copy link

codecov bot commented Mar 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure 79.91% <ø> (?)
github 71.62% <ø> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...x/basic_statistics/incremental_basic_statistics.py 96.03% <ø> (ø)
sklearnex/covariance/incremental_covariance.py 91.42% <ø> (ø)
sklearnex/linear_model/incremental_linear.py 83.45% <ø> (ø)
sklearnex/linear_model/incremental_ridge.py 86.66% <ø> (ø)

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

@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
@david-cortes-intel
Copy link
Contributor

@yuejiaointel Please merge the main branch here which has the numpydoc check. Some headers like 'Data formats' are not part of numpydoc format.

@yuejiaointel yuejiaointel changed the title update: update algorithm and preview update: update algorithm.rst based on current implementation May 29, 2025
@yuejiaointel yuejiaointel marked this pull request as ready for review May 29, 2025 05:07
@david-cortes-intel
Copy link
Contributor

david-cortes-intel commented May 29, 2025

@yuejiaointel It still seems to be missing some algorithms. For example, logistic regression is supported on GPU under some constraints, but it's not mentioned in this table. Just realized this was a case of github not rendering the .rst file correctly, now I see they are actually included.

@yuejiaointel yuejiaointel marked this pull request as draft May 29, 2025 18:34
@david-cortes-intel
Copy link
Contributor

LGTM, but please address the formatting errors catched by the doc CI.

@yuejiaointel yuejiaointel marked this pull request as ready for review June 6, 2025 01:24
@yuejiaointel yuejiaointel merged commit 7062a1e into uxlfoundation:main Jun 11, 2025
27 checks passed
@yuejiaointel yuejiaointel deleted the update_doc_algo_section branch June 11, 2025 17:06
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.

3 participants