syne_tune.callbacks package

class syne_tune.callbacks.TensorboardCallback(ignore_metrics=None, target_metric=None, mode=None, log_hyperparameters=True)

Bases: TunerCallback

Logs relevant metrics reported from trial evaluations, so they can be visualized with Tensorboard.

Parameters:

• ignore_metrics (Optional[List[str]]) – Defines which metrics should be ignored. If None, all metrics are reported to Tensorboard.

• target_metric (Optional[str]) – Defines the metric we aim to optimize. If this argument is set, we report the cumulative optimum of this metric as well as the optimal hyperparameters we have found so far.

• mode (Optional[str]) – Determined whether we maximize (“max”) or minimize (“min”) the target metric.

• log_hyperparameters (bool) – If set to True, we also log all hyperparameters specified in the configurations space.

on_trial_result(trial, status, result, decision)

Called when a new result (reported by a trial) is observed

The arguments here are inputs or outputs of scheduler.on_trial_result (called just before).

Parameters:

• trial (Trial) – Trial whose report has been received

• status (str) – Status of trial before scheduler.on_trial_result has been called

• result (Dict[str, Any]) – Result dict received

• decision (str) – Decision returned by scheduler.on_trial_result

on_tuning_start(tuner)

Called at start of tuning loop

Parameters:

tuner – Tuner object

on_tuning_end()

Called once the tuning loop terminates

This is called before Tuner object is serialized (optionally), and also before running jobs are stopped.

Submodules

• syne_tune.callbacks.hyperband_remove_checkpoints_callback module
  • TrialStatus
    • TrialStatus.RUNNING
    • TrialStatus.PAUSED_WITH_CHECKPOINT
    • TrialStatus.PAUSED_NO_CHECKPOINT
    • TrialStatus.STOPPED_OR_COMPLETED
  • BetaBinomialEstimator
    • BetaBinomialEstimator.update()
    • BetaBinomialEstimator.num_one
    • BetaBinomialEstimator.num_total
    • BetaBinomialEstimator.posterior_mean()
  • TrialInformation
    • TrialInformation.trial_id
    • TrialInformation.level
    • TrialInformation.rank
    • TrialInformation.rung_len
    • TrialInformation.score_val
  • HyperbandRemoveCheckpointsCommon
    • HyperbandRemoveCheckpointsCommon.on_tuning_start()
    • HyperbandRemoveCheckpointsCommon.num_checkpoints_removed
    • HyperbandRemoveCheckpointsCommon.on_loop_end()
    • HyperbandRemoveCheckpointsCommon.on_trial_complete()
    • HyperbandRemoveCheckpointsCommon.on_trial_result()
    • HyperbandRemoveCheckpointsCommon.on_start_trial()
    • HyperbandRemoveCheckpointsCommon.on_resume_trial()
    • HyperbandRemoveCheckpointsCommon.trials_resumed_without_checkpoint()
    • HyperbandRemoveCheckpointsCommon.extra_results()
    • HyperbandRemoveCheckpointsCommon.extra_results_keys()
  • HyperbandRemoveCheckpointsCallback
    • HyperbandRemoveCheckpointsCallback.on_tuning_start()
    • HyperbandRemoveCheckpointsCallback.estimator_for_rung()
    • HyperbandRemoveCheckpointsCallback.on_trial_result()
  • HyperbandRemoveCheckpointsBaselineCallback
• syne_tune.callbacks.hyperband_remove_checkpoints_score module
  • compute_probabilities_of_getting_resumed()
• syne_tune.callbacks.remove_checkpoints_callback module
  • RemoveCheckpointsCallback
    • RemoveCheckpointsCallback.on_tuning_start()
    • RemoveCheckpointsCallback.on_loop_end()
  • DefaultRemoveCheckpointsSchedulerMixin
    • DefaultRemoveCheckpointsSchedulerMixin.trials_checkpoints_can_be_removed()
    • DefaultRemoveCheckpointsSchedulerMixin.callback_for_checkpoint_removal()
• syne_tune.callbacks.tensorboard_callback module
  • TensorboardCallback
    • TensorboardCallback.on_trial_result()
    • TensorboardCallback.on_tuning_start()
    • TensorboardCallback.on_tuning_end()