syne_tune.optimizer.schedulers.remove_checkpoints module

class syne_tune.optimizer.schedulers.remove_checkpoints.RemoveCheckpointsSchedulerMixin

Bases: object

Methods to be implemented by pause-and-resume schedulers (in that on_trial_result() can return SchedulerDecision.PAUSE) which support early removal of checkpoints. Typically, model checkpoints are retained for paused trials, because they may get resumed later on. This can lead to the disk filling up, so removing checkpoints which are no longer needed, can be important.

Early checkpoint removal is implemented as a callback used with Tuner, which is created by callback_for_checkpoint_removal() here.

callback_for_checkpoint_removal(stop_criterion)

Parameters:

stop_criterion (Callable[[TuningStatus], bool]) – Stopping criterion, as passed to Tuner

Return type:

Optional[TunerCallback]

Returns:

CP removal callback, or None if CP removal is not activated