optuna.storages.JournalFileStorage

class optuna.storages.JournalFileStorage(file_path, lock_obj=None)[source]

Warning

Deprecated in v4.0.0. This feature will be removed in the future. The removal of this feature is currently scheduled for v6.0.0, but this schedule is subject to change. See https://github.com/optuna/optuna/releases/tag/v4.0.0.

Use JournalFileBackend instead.

Methods

`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`.

Parameters:

file_path (str)
lock_obj (BaseJournalFileLock | None)

append_logs(logs)

Append logs to the backend.

Parameters:: logs (list[dict[str, Any]]) – A list that contains json-serializable logs.
Return type:: None

read_logs(log_number_from)

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

If log_number_from is 0, read all the logs.

Parameters:: log_number_from (int) – A non-negative integer value indicating which logs to read.
Returns:: Logs with log number greater than or equal to log_number_from.
Return type:: list[dict[str, Any]]