ray.tune.Callback — Ray 2.45.0 (original) (raw)

class ray.tune.Callback[source]#

Tune base callback that can be extended and passed to a TrialRunner

Tune callbacks are called from within the TrialRunner class. There are several hooks that can be used, all of which are found in the submethod definitions of this base class.

The parameters passed to the **info dict vary between hooks. The parameters passed are described in the docstrings of the methods.

This example will print a metric each time a result is received:

from ray import tune from ray.tune import Callback

class MyCallback(Callback): def on_trial_result(self, iteration, trials, trial, result, **info): print(f"Got result: {result['metric']}")

def train_func(config): for i in range(10): tune.report(metric=i)

tuner = tune.Tuner( train_func, run_config=tune.RunConfig( callbacks=[MyCallback()] ) ) tuner.fit()

PublicAPI (beta): This API is in beta and may change before becoming stable.

Methods