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

[CI] clang-format C++ code and add to linting #2244

Merged
merged 27 commits into from
Jan 9, 2025

Conversation

icfaust
Copy link
Contributor

@icfaust icfaust commented Jan 7, 2025

Description

the _clang_format file is used by generator/gen_daal4py.py though it is not stated anywhere. However, this is not used to format the codebase. Therefore file is moved with the daal4py code and now also formats it. A general .clang-format is added so that clang-formatting can be applied to specific folders without applying everywhere. The onedal/ folder contains its own .clang-format and is now applied to the C++ code there. It is used, applied, and is now included in the .pre-commit-config.yaml. It will be tested going forward like black and isort.

Majority of the changes are due to applying clang-format.


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.

@icfaust icfaust changed the title [CI] add clang-formatting to C++ code [CI] clang-format C++ code and add to linting Jan 7, 2025
@icfaust icfaust changed the title [CI] clang-format C++ code and add to linting [CI] clang-format C++ code in onedal/ and add to linting Jan 7, 2025
@icfaust
Copy link
Contributor Author

icfaust commented Jan 7, 2025

/intelci: run

@icfaust icfaust marked this pull request as ready for review January 7, 2025 15:37
@icfaust icfaust requested a review from Alexsandruss as a code owner January 7, 2025 15:37
@icfaust icfaust requested a review from samir-nasibli as a code owner January 7, 2025 15:37
Copy link

codecov bot commented Jan 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
github 83.18% <ø> (ø)

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

@icfaust icfaust changed the title [CI] clang-format C++ code in onedal/ and add to linting [CI] clang-format C++ code and add to linting Jan 7, 2025
@icfaust
Copy link
Contributor Author

icfaust commented Jan 7, 2025

/intelci: run

@icfaust icfaust merged commit 8f7b5b7 into uxlfoundation:main Jan 9, 2025
31 checks passed
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.

2 participants