optuna.storages.journal.JournalRedisBackend

class optuna.storages.journal.JournalRedisBackend(url, use_cluster=False, prefix='')[源代码]

Redis 存储类,用于 Journal 日志后端。

参数:
  • url (str) – redis 存储的 URL,密码和 db 可选。(例如:redis://:6379

  • use_cluster (bool) – 是否使用 Redis 集群的标志。如果为 False,则假定您使用独立的 Redis 服务器,并确保写入操作是原子的。这保证了已保存日志的一致性。如果为 True,则假定您使用 Redis 集群,并且不保证写入操作是原子的。这意味着由于网络错误,已保存的日志可能不一致,并可能导致错误。

  • prefix (str) – 已保存日志的键的前缀。当多个用户在同一个 Redis 服务器上工作时,这很有用。

注意

在 v3.1.0 中作为实验性功能添加。接口可能在后续版本中在不事先通知的情况下发生更改。请参阅 https://github.com/optuna/optuna/releases/tag/v3.1.0

方法

append_logs(logs)

将日志追加到后端。

load_snapshot()

从后端加载快照。

read_logs(log_number_from)

读取日志编号大于或等于 log_number_from 的日志。

save_snapshot(snapshot)

将快照保存到后端。

append_logs(logs)[源代码]

将日志追加到后端。

参数:

logs (list[dict[str, Any]]) – 包含 JSON 可序列化日志的列表。

返回类型:

load_snapshot()[源代码]

从后端加载快照。

返回:

序列化后的快照(bytes),如果找到的话,否则为 None

返回类型:

bytes | None

read_logs(log_number_from)[源代码]

读取日志编号大于或等于 log_number_from 的日志。

如果 log_number_from 为 0,则读取所有日志。

参数:

log_number_from (int) – 一个非负整数,表示要读取的日志。

返回:

日志编号大于或等于 log_number_from 的日志。

返回类型:

Generator[dict[str, Any], None, None]

save_snapshot(snapshot)[源代码]

将快照保存到后端。

参数:

snapshot (bytes) – 序列化后的快照(bytes)

返回类型: