ray.air.integrations.comet.CometLoggerCallback#

class ray.air.integrations.comet.CometLoggerCallback(online: bool = True, tags: List[str] = None, save_checkpoints: bool = False, **experiment_kwargs)[源代码]#

基类：LoggerCallback

用于将 Tune 结果记录到 Comet 的 CometLoggerCallback。

Comet (https://comet.ml/site/) 是一个管理并优化整个机器学习生命周期的工具，从实验跟踪、模型优化和数据集版本控制到模型生产监控。

这个 Ray Tune LoggerCallback 将指标和参数发送到 Comet 进行跟踪。

要使用 CometLoggerCallback，您必须首先通过 pip install comet_ml 安装 Comet。

然后设置以下环境变量 export COMET_API_KEY=<Your API Key>

或者，您也可以将API密钥作为参数传递给CometLoggerCallback构造函数。

CometLoggerCallback(api_key=<你的 API 密钥>)

参数:

online – 是否使用在线或离线实验。默认为 True。
tags – 要添加到记录实验中的标签。默认为 None。
save_checkpoints – 如果 True ，模型检查点将被保存为 Comet ML 中的工件。默认为 False 。
**experiment_kwargs – 其他关键字参数将被传递给 comet_ml.Experiment 的构造函数（如果 online=False，则为 OfflineExperiment）。

有关 Experiment 和 OfflineExperiment 类的更多信息，请参阅 Comet ML 文档：https://comet.ml/site/

示例：

from ray.air.integrations.comet import CometLoggerCallback
tune.run(
    train,
    config=config
    callbacks=[CometLoggerCallback(
        True,
        ['tag1', 'tag2'],
        workspace='my_workspace',
        project_name='my_project_name'
        )]
)

方法

`get_state`	获取回调的状态。
`log_trial_restore`	处理试验恢复时的日志记录。
`log_trial_result`	在每次迭代时记录试验的当前结果。
`log_trial_start`	初始化一个实验（如果 self.online=False，则为 OfflineExperiment）并开始记录到 Comet。
`on_checkpoint`	在Tune保存检查点后调用。
`on_experiment_end`	在实验结束后且所有试验均已完成时调用。
`on_step_begin`	在每个调优循环步骤开始时调用。
`on_step_end`	在每个调优循环步骤结束时调用。
`on_trial_recover`	在一个试验实例失败（出错）后调用，但该试验已安排重试。
`set_state`	设置回调的状态。
`setup`	在训练开始时调用一次。