optuna.storages.journal.JournalRedisBackend

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

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

参数
  • url (str) – Redis 存储的 URL,密码和 db 是可选的。(例如:redis://localhost: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 序列化的日志的列表。

返回类型

None

load_snapshot()[源代码]

从后端加载快照。

返回

如果找到,则返回序列化的快照(字节),否则返回 None

返回类型

bytes | None

read_logs(log_number_from)[源代码]

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

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

参数

log_number_from (int) – 表示要读取哪些日志的非负整数值。

返回

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

返回类型

list[dict[str, Any]]

save_snapshot(snapshot)[源代码]

将快照保存到后端。

参数

snapshot (bytes) – 序列化的快照(字节)

返回类型

None