ray.tune.回调#

class ray.tune.Callback[源代码]#

基类:object

可以扩展并传递给 TrialRunner 的调优基础回调

回调调优是在 TrialRunner 类内部调用的。有几个钩子可以使用,所有这些钩子都可以在这个基类的子方法定义中找到。

传递给 **info 字典的参数因钩子而异。传递的参数在方法的文档字符串中描述。

这个示例将在每次接收到结果时打印一个指标:

from ray import train, 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=train.RunConfig(
        callbacks=[MyCallback()]
    )
)
tuner.fit()

PublicAPI (测试版): 此API目前处于测试阶段,在成为稳定版本之前可能会发生变化。

方法

__init__

get_state

获取回调的状态。

on_checkpoint

在Tune保存检查点后调用。

on_experiment_end

在实验结束后且所有试验均已完成时调用。

on_step_begin

在每个调优循环步骤开始时调用。

on_step_end

在每个调优循环步骤结束时调用。

on_trial_complete

在试验实例完成后调用。

on_trial_error

在试验实例失败(出错)后调用。

on_trial_recover

在一个试验实例失败(出错)后调用,但该试验已安排重试。

on_trial_restore

在恢复试验实例后调用。

on_trial_result

在接收到试验结果后调用。

on_trial_save

在从试验中接收到检查点后调用。

on_trial_start

在启动试验实例后调用。

set_state

设置回调的状态。

setup

在训练开始时调用一次。