deepcave.runs.converters.optuna

# OptunaRun

This module provides utilities to create an Optuna run.

## Classes

• OptunaRun: Define an Optuna run object.

Classes

OptunaRun(name[, configspace, objectives, ...])

Define an Optuna run object.

class deepcave.runs.converters.optuna.OptunaRun(name, configspace=None, objectives=None, meta=None, path=None)

Bases: Run

Define an Optuna run object.

Properties

pathPath

The path to the run.

classmethod from_path(path)

Based on working_dir/run_name/*, return a new trials object.

Parameters:

path (Union[Path, str]) – The path to base the trial object on.

Return type:

The Optuna run.

Raises:

RuntimeError – Instances are not supported.

property hash: str

Hash of the current run.

If the hash changes, the cache has to be cleared. This ensures that the cache always holds the latest results of the run.

Returns:

The hash of the run.

Return type:

str

classmethod is_valid_run(path_name)

Check whether the path name belongs to a valid optuna run.

Parameters:

path_name (str) – The path to check.

Returns:

True if path is valid run. False otherwise.

Return type:

bool

property latest_change: float | int

Get the timestamp of the latest change.

Returns:

The latest change.

Return type:

Union[float, int]

previous

deepcave.runs.converters.deepcave

next

deepcave.runs.converters.smac3v1