ray.tune.syncer.SyncerCallback#

class ray.tune.syncer.SyncerCallback(enabled: bool = True, sync_period: float = 300)[source]#

Bases: ray.tune.callback.Callback

Callback to synchronize trial directories on a worker node with the driver.

DeveloperAPI: This API may change across minor Ray releases.

Methods

get_state()

Get the state of the callback.

on_experiment_end(trials, **info)

Wait for background sync processes to finish on experiment end.

on_step_begin(iteration, trials, **info)

Called at the start of each tuning loop step.

on_step_end(iteration, trials, **info)

Called at the end of each tuning loop step.

on_trial_recover(iteration, trials, trial, ...)

Called after a trial instance failed (errored) but the trial is scheduled for retry.

on_trial_restore(iteration, trials, trial, ...)

Called after restoring a trial instance.

on_trial_save(iteration, trials, trial, **info)

Called after receiving a checkpoint from a trial.

set_state(state)

Set the state of the callback.

setup([stop, num_samples, total_num_samples])

Called once at the very beginning of training.