Add callbacks in SolverDO.solve()
#148
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
This will enable - logging to tools like Tensorboard or Optuna - timing out solvers - early stopping - discarding not promising trials during hyperparameters tuning Callback has a few methods to overwrite in order to execute some code - on_solve_start(): at the beginning of solve - on_solve_end(): at the end of solve - on_step_end(): at the end of each iteration As solvers can use several callbacks at the same time, we also provide a CallbackList utility that will call the methods on each included callback. We are deeply inspired by work from others: keras: https://github.com/keras-team/keras/blob/v3.0.2/keras/callbacks/callback.py tensorflow: https://github.com/tensorflow/tensorflow/blob/cafa8f3bd9b5740d1d37db799eec3168edc7e97b/tensorflow/python/training/session_run_hook.py#L94 or-tools: https://developers.google.com/optimization/reference/python/sat/python/cp_model#cp_model.CpSolverSolutionCallback sklearn-genetic-opt: https://github.com/rodrigo-arenas/Sklearn-genetic-opt/blob/0.10.1/sklearn_genetic/callbacks/base.py For now no solvers use them, the next step being using it in each solvers
Time-out, log and backup features can be implemented via callbacks to be reused in any solver. Thus we remove the "hard-coded" corresponding features in local search algorithms and implement them as callbacks. This is tested in tests/generic_tools/callbacks/test_sa_with_callbacks.py.
g-poveda
approved these changes
Jan 25, 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.
We create a Callback class to be used by solver.solve() to hook at some stages.
This will enable
Callback has a few methods to overwrite in order to execute some code
on_solve_start(): at the beginning of solveon_solve_end(): at the end of solveon_step_end(): at the end of each iterationWe are deeply inspired by work from others:
In this PR, we only make local search algorithms use them, we will add gradually this possibility to all solvers.
We replace some features (logging, backup, and timer) previously used by local search algos by the use of some basic callbacks that we implement, as shown in test tests/generic_tools/callbacks/test_sa_with_callbacks.py.