-
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
Make StopWindow
more efficient and rename it to ConvergenceChecker
#55
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #55 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 36 36
Lines 1600 1537 -63
=========================================
- Hits 1600 1537 -63
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
src/simulated_bifurcation/optimizer/simulated_bifurcation_optimizer.py
Outdated
Show resolved
Hide resolved
…ted-bifurcation-algorithm into rename_stop_window
Possible bug when combining this new window with the keyboard interrupt feature from #51: if the user stops the optimization manually between the moment when the window is reduced but not the oscillators in the optimizer, this may create shape conflicts when combining both in the final spins that are returned. Need to discuss this. |
StopWindow
more efficient and rename it to ConvergenceChecker
StopWindow
more efficient and rename it to ConvergenceChecker
StopWindow
more efficient and rename it to ConvergenceChecker
Rename "Stop Window" to "Convergence Checker"
💬 Pull Request Description
When the Stop Window detects that an agent has converged, it is stored in the window's memory and a boolean tensor is sent back to the optimizer to indicate which agents still have not converged. Thus, the oscillators corresponding to converged agents are removed which reduces the computation size and time.
It also becomes more relevant to rename
StopWindow
asConvergenceChecker
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
None.
Renaming
StopWindow
anduse_window
to respectivelyConvergenceChecker
andearly_stopping
introduced breaking changes with respect to versions <=1.2.1
.