Skip to content
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

[testing, CI] fix coverage statistics issue caused by test_common.py tracer patching #2237

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

icfaust
Copy link
Contributor

@icfaust icfaust commented Jan 1, 2025

Description

Python code coverage has been introduced in #2222 and #2225. Some code, while properly covered with tests, was showing incorrect coverage. It was discovered that the tracing used in test_common.py interferes with the tracing collected by pytest-cov. Any tests alphabetically after test_common.py have been neglected in codecov and by coverage.py. Correcting this can be done by tracing the estimators in a separate process and passing the data back to the pytest-cov parent process.

This has been implemented using python multiprocessing due to the time overhead of loading sklearnex for each estimator and method. The process persists for the period of all test_common.py tests as a daemon process. The test passing/xfail/etc rate has been verified to match to main.

No performance metrics are generated due to purely for testing and CI.

The effectiveness of this change can be observed by the ~1.2% improvement in code coverage (as indirect changes).


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 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 Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
github 84.39% <ø> (+1.20%) ⬆️

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

see 13 files with indirect coverage changes

@icfaust
Copy link
Contributor Author

icfaust commented Jan 2, 2025

/intelci: run

@icfaust icfaust changed the title [WIP, CI] fix coverage statistics issue caused by test_common.py tracer patching [CI] fix coverage statistics issue caused by test_common.py tracer patching Jan 2, 2025
@icfaust icfaust changed the title [CI] fix coverage statistics issue caused by test_common.py tracer patching [testing, CI] fix coverage statistics issue caused by test_common.py tracer patching Jan 2, 2025
@icfaust
Copy link
Contributor Author

icfaust commented Jan 2, 2025

/intelci: run

@icfaust icfaust marked this pull request as ready for review January 3, 2025 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant