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

Rename "Stop Window" to "Convergence Checker" #56

Merged
merged 14 commits into from
Sep 29, 2024

Conversation

bqth29
Copy link
Owner

@bqth29 bqth29 commented Jan 2, 2024

💬 Pull Request Description

⚠️ This PR contains breaking changes.

Requirements: PR #55 must have been merged before merging this pull request

With the latest evolutions of the StopWindow, it becomes more relevant to rename it ConvergenceChecker so its purpose is more easily understandable. Documentation has been updated.

Besides, the use_window parameter used in the various optimization functions and methods has been renamed early_stopping for relevance sake.

✔️ Check list

  • The code matches the styling rules
  • The new code is covered by relevant tests
  • Documentation was added

🚀 New features

None.

🐞 Bug fixes

None.

📣 Supplementary information

Renaming StopWindow and use_window to respectively ConvergenceChecker and early_stopping introduced breaking changes with respect to versions <= 1.2.1.

Copy link

codecov bot commented Jan 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6194a9e) to head (debf45f).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #56   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           36        36           
  Lines         1600      1537   -63     
=========================================
- Hits          1600      1537   -63     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bqth29 bqth29 added the refactoring Existing code is refactored (no new feature, no breaking change) label May 28, 2024
@bqth29 bqth29 changed the base branch from main to feature/more_efficient_window September 29, 2024 21:17
@bqth29 bqth29 changed the base branch from feature/more_efficient_window to main September 29, 2024 21:25
@bqth29 bqth29 changed the base branch from main to feature/more_efficient_window September 29, 2024 21:26
@bqth29 bqth29 merged commit c7984b6 into feature/more_efficient_window Sep 29, 2024
@bqth29 bqth29 deleted the rename_stop_window branch September 29, 2024 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Existing code is refactored (no new feature, no breaking change)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant