simulated-bifurcation-algorithm
simulated-bifurcation-algorithm copied to clipboard
Rename "Stop Window" to "Convergence Checker"
💬 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
- [x] The code matches the styling rules
- [x] The new code is covered by relevant tests
- [x] 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.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
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
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.