mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-05-17 21:20:11 +00:00
ddbe0e93f9
* add vectorized monitor * auto format of the code * add documentation and VecExtractDictObs * refactor and add test cases * add test cases and format * avoid circular import and fix doc * fix type * fix type * oops * Update stable_baselines3/common/monitor.py Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org> * Update stable_baselines3/common/monitor.py Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org> * add test cases * update changelog * fix mutable argument * quick fix * Apply suggestions from code review * fix terminal observation for gym3 envs * delete comment * Update doc and bump version * Add warning when already using `Monitor` wrapper * Update vecmonitor tests * Fixes Co-authored-by: Antonin RAFFIN <antonin.raffin@ensta.org>
71 lines
2.5 KiB
Python
71 lines
2.5 KiB
Python
# flake8: noqa F401
|
|
import typing
|
|
from copy import deepcopy
|
|
from typing import Optional, Type, Union
|
|
|
|
from stable_baselines3.common.vec_env.base_vec_env import CloudpickleWrapper, VecEnv, VecEnvWrapper
|
|
from stable_baselines3.common.vec_env.dummy_vec_env import DummyVecEnv
|
|
from stable_baselines3.common.vec_env.subproc_vec_env import SubprocVecEnv
|
|
from stable_baselines3.common.vec_env.vec_check_nan import VecCheckNan
|
|
from stable_baselines3.common.vec_env.vec_extract_dict_obs import VecExtractDictObs
|
|
from stable_baselines3.common.vec_env.vec_frame_stack import VecFrameStack
|
|
from stable_baselines3.common.vec_env.vec_monitor import VecMonitor
|
|
from stable_baselines3.common.vec_env.vec_normalize import VecNormalize
|
|
from stable_baselines3.common.vec_env.vec_transpose import VecTransposeImage
|
|
from stable_baselines3.common.vec_env.vec_video_recorder import VecVideoRecorder
|
|
|
|
# Avoid circular import
|
|
if typing.TYPE_CHECKING:
|
|
from stable_baselines3.common.type_aliases import GymEnv
|
|
|
|
|
|
def unwrap_vec_wrapper(env: Union["GymEnv", VecEnv], vec_wrapper_class: Type[VecEnvWrapper]) -> Optional[VecEnvWrapper]:
|
|
"""
|
|
Retrieve a ``VecEnvWrapper`` object by recursively searching.
|
|
|
|
:param env:
|
|
:param vec_wrapper_class:
|
|
:return:
|
|
"""
|
|
env_tmp = env
|
|
while isinstance(env_tmp, VecEnvWrapper):
|
|
if isinstance(env_tmp, vec_wrapper_class):
|
|
return env_tmp
|
|
env_tmp = env_tmp.venv
|
|
return None
|
|
|
|
|
|
def unwrap_vec_normalize(env: Union["GymEnv", VecEnv]) -> Optional[VecNormalize]:
|
|
"""
|
|
:param env:
|
|
:return:
|
|
"""
|
|
return unwrap_vec_wrapper(env, VecNormalize) # pytype:disable=bad-return-type
|
|
|
|
|
|
def is_vecenv_wrapped(env: Union["GymEnv", VecEnv], vec_wrapper_class: Type[VecEnvWrapper]) -> bool:
|
|
"""
|
|
Check if an environment is already wrapped by a given ``VecEnvWrapper``.
|
|
|
|
:param env:
|
|
:param vec_wrapper_class:
|
|
:return:
|
|
"""
|
|
return unwrap_vec_wrapper(env, vec_wrapper_class) is not None
|
|
|
|
|
|
# Define here to avoid circular import
|
|
def sync_envs_normalization(env: "GymEnv", eval_env: "GymEnv") -> None:
|
|
"""
|
|
Sync eval env and train env when using VecNormalize
|
|
|
|
:param env:
|
|
:param eval_env:
|
|
"""
|
|
env_tmp, eval_env_tmp = env, eval_env
|
|
while isinstance(env_tmp, VecEnvWrapper):
|
|
if isinstance(env_tmp, VecNormalize):
|
|
eval_env_tmp.obs_rms = deepcopy(env_tmp.obs_rms)
|
|
eval_env_tmp.ret_rms = deepcopy(env_tmp.ret_rms)
|
|
env_tmp = env_tmp.venv
|
|
eval_env_tmp = eval_env_tmp.venv
|