optuna.storages.journal.JournalRedisBackend

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

ジャーナルログバックエンド用のRedisストレージクラス。

Parameters:

  • url (str) – RedisストレージのURL。パスワードとデータベース番号はオプション。 （例: redis://localhost:6379）

  • use_cluster (bool) – Redisクラスタを使用するかどうかのフラグ。 False の場合、スタンドアロンのRedisサーバを使用し、書き込み操作がアトミックに行われることが保証されます。これにより保存ログの一貫性が保たれます。:obj:`True`の場合、Redisクラスタを使用しているとみなされ、書き込み操作のアトミック性は保証されません。ネットワークエラーにより保存ログに不整合が生じる可能性があり、エラーの原因となる場合があります。

  • prefix (str) – ログの保存キーのプレフィックス。複数のユーザが1つのRedisサーバを使用する場合に便利です。

Note

v3.1.0で実験的機能として追加されました。インターフェースは予告なく変更される可能性があります。 詳細は https://github.com/optuna/optuna/releases/tag/v3.1.0 を参照してください。

メソッド

append_logs(logs)

Append logs to the backend.

load_snapshot()

Load snapshot from the backend.

read_logs(log_number_from)

Read logs with a log number greater than or equal to log_number_from.

save_snapshot(snapshot)

Save snapshot to the backend.
append_logs(logs)[source]

バックエンドにログを追加します。

Parameters:

logs (list[dict[str, Any]]) – JSONシリアライズ可能なログのリスト。

Return type:

None

load_snapshot()[source]

バックエンドからスナップショットを読み込みます。

Returns:

スナップショットが見つかった場合はシリアライズされたスナップショット（bytes）、見つからなかった場合は None 。

Return type:

bytes | None

read_logs(log_number_from)[source]

log_number_from 以上のログ番号を持つログを読み込みます。

log_number_from が0の場合、すべてのログを読み込みます。

Parameters:

log_number_from (int) – 読み込むログのログ番号を示す非負の整数値。

Returns:

log_number_from 以上のログ番号を持つログ。

Return type:

list[dict[str, Any]]

save_snapshot(snapshot)[source]

スナップショットをバックエンドに保存します。

Parameters:

snapshot (bytes) – シリアライズされたスナップショット（bytes）

Return type:

None