eta_ctrl.config.config_run module

class eta_ctrl.config.config_run.ConfigRun(*, series: str, name: str, description, root_path, results_path, scenarios_path)

Bases: object

Configuration for an optimization run, including the series and run names descriptions and paths for the run.

series: str

Name of the series of optimization runs.

name: str

Name of an optimization run.

description: str

Description of an optimization run.

root_path: Path

Root path of the framework run.

results_path: Path

Path to results of the optimization run.

scenarios_path: Path

Path to scenarios used for the optimization run.

series_results_path: Path

Path for the results of the series of optimization runs.

run_model_path: Path

Path to the model of the optimization run.

run_info_path: Path

Path to information about the optimization run.

run_monitor_path: Path

Path to the monitoring information about the optimization run.

vec_normalize_path: Path

Path to the normalization wrapper information.

net_arch_path: Path

Path to the neural network architecture file.

log_output_path: Path

Path to the log output file.

env_version: str | None

Version of the main environment.

env_description: str | None

Description of the main environment.

interaction_env_version: str | None

Version of the secondary environment (interaction_env).

interaction_env_description: str | None

Description of the secondary environment (interaction_env).

create_results_folders() → None

Create the results folders for an optimization run (or check if they already exist).

set_env_info(env: type[BaseEnv]) → None

Set the environment information of the optimization run to represent the given environment. The information will default to None if this is never called.

Parameters:

env – The environment whose description should be used.

set_interaction_env_info(env: type[BaseEnv]) → None

Set the interaction environment information of the optimization run to represent the given environment. The information will default to None if this is never called.

Parameters:

env – The environment whose description should be used.

property paths: dict[str, Path]

Dictionary of all paths for the optimization run. This is for easier access and contains all paths as mentioned above.