optuna.storages.BaseJournalLogStorage

class optuna.storages.BaseJournalLogStorage(*args, **kwargs)[source]

ジャーナルストレージの基底クラス。

この基底クラスを実装するストレージクラスは、プロセス間の安全性を保証する必要があります。つまり、複数のプロセスが同時に read_logs と append_logs を呼び出すことが想定されます。バックエンドストレージがロックなどの排他制御機構を内部でサポートしていない場合、 JournalFileSymlinkLock や JournalFileOpenLock を使用してクリティカルセクションを作成することを検討してください。

Warning

v4.0.0で非推奨となりました。この機能は将来的に削除される予定です。現在の削除予定は v6.0.0 ですが、変更される可能性があります。 https://github.com/optuna/optuna/releases/tag/v4.0.0 を参照してください。

BaseJournalBackend を使用してください。

メソッド

`append_logs`(logs)	Append logs to the backend.
`read_logs`(log_number_from)	Read logs with a log number greater than or equal to `log_number_from`.

abstractmethod append_logs(logs)

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

Parameters:: logs (list[dict[str, Any]]) – jsonシリアライズ可能なログのリスト。
Return type:: None

abstractmethod read_logs(log_number_from)

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

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

Parameters:: log_number_from (int) – 読み込むログのログ番号を示す非負の整数値。
Returns:: log_number_from 以上のログ番号を持つログ。
Return type:: list[dict[str, Any]]