eta_ctrl.config.config_setup module

class eta_ctrl.config.config_setup.ConfigSetup(*, agent_import: str, agent_class: type[BaseAlgorithm], environment_import: str, environment_class: type[BaseEnv], vectorizer_import: str = 'stable_baselines3.common.vec_env.dummy_vec_env.DummyVecEnv', vectorizer_class: type[DummyVecEnv | SubprocVecEnv], policy_import: str = 'eta_ctrl.common.NoPolicy', policy_class: type[BasePolicy], monitor_wrapper: bool = False, norm_wrapper_obs: bool = False, norm_wrapper_reward: bool = False, tensorboard_log: bool = False)

Bases: BaseModel

Helper class, which is part of Config, for import and setup parameters.

model_config = {'extra': 'forbid', 'frozen': True, 'use_attribute_docstrings': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

agent_import: str

Import description string for the agent class.

agent_class: type[BaseAlgorithm]

Agent class (automatically determined from agent_import).

environment_import: str

Import description string for the environment class.

environment_class: type[BaseEnv]

Imported Environment class (automatically determined from environment_import).

vectorizer_import: str

Import description string for the environment vectorizer (default: stable_baselines3.common.vec_env.dummy_vec_env.DummyVecEnv).

vectorizer_class: type[DummyVecEnv | SubprocVecEnv]

Environment vectorizer class (automatically determined from vectorizer_import).

policy_import: str

Import description string for the policy class (default: eta_ctrl.agents.common.NoPolicy).

policy_class: type[BasePolicy]

Policy class (automatically determined from policy_import).

monitor_wrapper: bool

Flag which is true if the environment should be wrapped for monitoring (default: False).

norm_wrapper_obs: bool

Flag which is true if the observations should be normalized (default: False).

norm_wrapper_reward: bool

Flag which is true if the rewards should be normalized (default: False).

tensorboard_log: bool

Flag to enable tensorboard logging (default: False).