Skip to content

MAINT: Remove separate daal4py docs#2429

Merged
david-cortes-intel merged 3 commits into
uxlfoundation:mainfrom
david-cortes-intel:remove_d4p_docs
Apr 15, 2025
Merged

MAINT: Remove separate daal4py docs#2429
david-cortes-intel merged 3 commits into
uxlfoundation:mainfrom
david-cortes-intel:remove_d4p_docs

Conversation

@david-cortes-intel
Copy link
Copy Markdown
Contributor

Description

After previous PR: #2395

All the technical documentation about daal4py has been merged into the sklearnex docs, and doc sections about the relevant parts of daal4py have been added.

Thus, there's no further need to keep a separate documentation system for daal4py, the more so since it isn't used or deployed anywhere.

This PR removes those docs and all remaining references to them.

Note that this also removes a file with third-party licenses which is currently being bundled by the packaging scripts, so updates elsewhere might be required afterwards. All of the contents in that file are already present in the same third-party licenses under sklearnex so nothing is being missed.


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

  • All CI jobs are green or I have provided justification why they aren't.

Performance

Not applicable.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
azure 79.73% <ø> (ø)
github 72.02% <ø> (ø)

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

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

@ethanglaser
Copy link
Copy Markdown
Contributor

/intelci: run

@david-cortes-intel
Copy link
Copy Markdown
Contributor Author

Error in azure pipelines is unrelated to the changes here:

E           AssertionError: Size of extra allocated memory after using garbage collector is greater than 15.0% of input data
E             	Algorithm: KMeans
E             	Input data size: 808000 bytes
E             	Extra allocated memory size: 124067 bytes / 15.35 %
E           assert 124067 < (0.15 * 808000)

Error in internal CI is also unrelated, will try to re-run to see if it's fixed.

@david-cortes-intel
Copy link
Copy Markdown
Contributor Author

/intelci: run

@icfaust
Copy link
Copy Markdown
Contributor

icfaust commented Apr 15, 2025

Error in azure pipelines is unrelated to the changes here:

E           AssertionError: Size of extra allocated memory after using garbage collector is greater than 15.0% of input data
E             	Algorithm: KMeans
E             	Input data size: 808000 bytes
E             	Extra allocated memory size: 124067 bytes / 15.35 %
E           assert 124067 < (0.15 * 808000)

Error in internal CI is also unrelated, will try to re-run to see if it's fixed.

Yeah, this is quite worrisome as its occurring in lots of PRs (including some of mine). I don't think you need to waste the effort rolling the dice in getting it to pass. I was sort of hoping that we could get someone on the team to attack kMeans with asan...

Copy link
Copy Markdown
Contributor

@icfaust icfaust left a comment

Choose a reason for hiding this comment

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

thanks for the 3k+ line reduction! Just a small request, otherwise good to go.

Comment thread deselected_tests.yaml
- svm/tests/test_svm.py::test_custom_kernel_not_array_input[SVR]

# test_non_uniform_strategies fails due to differences in handling of vacuous clusters after update
# See https://github.com/IntelPython/daal4py/issues/69
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

wow, I've been through deselected tests hundreds of times and never paid attention to this. Crazy that 1 we still have references to IntelPython here, and 2 we haven't properly closed that issue.

Comment thread setup.py
project_urls = {
"Bug Tracker": "https://github.com/uxlfoundation/scikit-learn-intelex",
"Documentation": "https://intelpython.github.io/daal4py/",
"Documentation": "https://uxlfoundation.github.io/scikit-learn-intelex/",
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hate to be a bother: could you also change the other project urls? It looks like for example that the source code line should be https://github.com/uxlfoundation/scikit-learn-intelex instead of https://github.com/uxlfoundation/scikit-learn-intelex/daal4py and that bug tracker should probably link to /issues. You can say 'not in scope of the PR' if you really don't want to.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated.

@david-cortes-intel david-cortes-intel merged commit b1869bb into uxlfoundation:main Apr 15, 2025
27 checks passed
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