mirror of
https://github.com/saymrwulf/stable-baselines3.git
synced 2026-05-16 21:10:08 +00:00
4317c62598
* Fix various typos * Update changelog --------- Co-authored-by: Antonin Raffin <antonin.raffin@ensta.org>
100 lines
3.4 KiB
Python
100 lines
3.4 KiB
Python
import warnings
|
|
from inspect import signature
|
|
from typing import Union
|
|
|
|
import gymnasium
|
|
|
|
try:
|
|
import gym
|
|
|
|
gym_installed = True
|
|
except ImportError:
|
|
gym_installed = False
|
|
|
|
|
|
def _patch_env(env: Union["gym.Env", gymnasium.Env]) -> gymnasium.Env: # pragma: no cover
|
|
"""
|
|
Adapted from https://github.com/thu-ml/tianshou.
|
|
|
|
Takes an environment and patches it to return Gymnasium env.
|
|
This function takes the environment object and returns a patched
|
|
env, using shimmy wrapper to convert it to Gymnasium,
|
|
if necessary.
|
|
|
|
:param env: A gym/gymnasium env
|
|
:return: Patched env (gymnasium env)
|
|
"""
|
|
|
|
# Gymnasium env, no patching to be done
|
|
if isinstance(env, gymnasium.Env):
|
|
return env
|
|
|
|
if not gym_installed or not isinstance(env, gym.Env):
|
|
raise ValueError(
|
|
f"The environment is of type {type(env)}, not a Gymnasium "
|
|
f"environment. In this case, we expect OpenAI Gym to be "
|
|
f"installed and the environment to be an OpenAI Gym environment."
|
|
)
|
|
|
|
try:
|
|
import shimmy
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Missing shimmy installation. You provided an OpenAI Gym environment. "
|
|
"Stable-Baselines3 (SB3) has transitioned to using Gymnasium internally. "
|
|
"In order to use OpenAI Gym environments with SB3, you need to "
|
|
"install shimmy (`pip install 'shimmy>=0.2.1'`)."
|
|
) from e
|
|
|
|
warnings.warn(
|
|
"You provided an OpenAI Gym environment. "
|
|
"We strongly recommend transitioning to Gymnasium environments. "
|
|
"Stable-Baselines3 is automatically wrapping your environments in a compatibility "
|
|
"layer, which could potentially cause issues."
|
|
)
|
|
|
|
if "seed" in signature(env.unwrapped.reset).parameters:
|
|
# Gym 0.26+ env
|
|
return shimmy.GymV26CompatibilityV0(env=env)
|
|
# Gym 0.21 env
|
|
return shimmy.GymV21CompatibilityV0(env=env)
|
|
|
|
|
|
def _convert_space(space: Union["gym.Space", gymnasium.Space]) -> gymnasium.Space: # pragma: no cover
|
|
"""
|
|
Takes a space and patches it to return Gymnasium Space.
|
|
This function takes the space object and returns a patched
|
|
space, using shimmy wrapper to convert it to Gymnasium,
|
|
if necessary.
|
|
|
|
:param env: A gym/gymnasium Space
|
|
:return: Patched space (gymnasium Space)
|
|
"""
|
|
|
|
# Gymnasium space, no conversion to be done
|
|
if isinstance(space, gymnasium.Space):
|
|
return space
|
|
|
|
if not gym_installed or not isinstance(space, gym.Space):
|
|
raise ValueError(
|
|
f"The space is of type {type(space)}, not a Gymnasium "
|
|
f"space. In this case, we expect OpenAI Gym to be "
|
|
f"installed and the space to be an OpenAI Gym space."
|
|
)
|
|
|
|
try:
|
|
import shimmy
|
|
except ImportError as e:
|
|
raise ImportError(
|
|
"Missing shimmy installation. You provided an OpenAI Gym space. "
|
|
"Stable-Baselines3 (SB3) has transitioned to using Gymnasium internally. "
|
|
"In order to use OpenAI Gym space with SB3, you need to "
|
|
"install shimmy (`pip install 'shimmy>=0.2.1'`)."
|
|
) from e
|
|
|
|
warnings.warn(
|
|
"You loaded a model that was trained using OpenAI Gym. "
|
|
"We strongly recommend transitioning to Gymnasium by saving that model again."
|
|
)
|
|
|
|
return shimmy.openai_gym_compatibility._convert_space(space)
|