-
Notifications
You must be signed in to change notification settings - Fork 28
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
…ted-bifurcation-algorithm into rename_stop_window
bqth29
added
the
refactoring
Existing code is refactored (no new feature, no breaking change)
label
May 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
💬 Pull Request Description
With the latest evolutions of the
StopWindow
, it becomes more relevant to rename itConvergenceChecker
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 renamedearly_stopping
for relevance sake.✔️ Check list
🚀 New features
None.
🐞 Bug fixes
None.
📣 Supplementary information
Renaming
StopWindow
anduse_window
to respectivelyConvergenceChecker
andearly_stopping
introduced breaking changes with respect to versions <=1.2.1
.