garage.envs.gym_env
¶
Wrapper class that converts gym.Env into GymEnv.
-
KNOWN_GYM_NOT_CLOSE_VIEWER
= ['gym.envs.atari', 'gym.envs.box2d', 'gym.envs.classic_control']¶
-
KNOWN_GYM_NOT_CLOSE_MJ_VIEWER
= ['gym.envs.mujoco', 'gym.envs.robotics']¶
-
class
GymEnv
(env, is_image=False, max_episode_length=None)¶ Bases:
garage.Environment
Returns an abstract Garage wrapper class for gym.Env.
In order to provide pickling (serialization) and parameterization for
gym.Env
instances, they must be wrapped withGymEnv
. This ensures compatibility with existing samplers and checkpointing when the envs are passed internally around garage.Furthermore, classes inheriting from
GymEnv
should silently convert :attribute:`action_space` and :attribute:`observation_space` fromgym.Space
toakro.Space
.GymEnv
handles all environments created bymake()
.It returns a different wrapper class instance if the input environment requires special handling. Current supported wrapper classes are:
garage.envs.bullet.BulletEnv for Bullet-based gym environments.
See __new__() for details.
-
property
action_space
(self)¶ akro.Space: The action space specification.
-
property
observation_space
(self)¶ akro.Space: The observation space specification.
-
property
spec
(self)¶ garage.envs.env_spec.EnvSpec: The envionrment specification.
-
property
render_modes
(self)¶ list: A list of string representing the supported render modes.
-
reset
(self)¶ Call reset on wrapped env.
- Returns
- The first observation conforming to
observation_space.
- dict: The episode-level information.
Note that this is not part of env_info provided in step(). It contains information of he entire episode, which could be needed to determine the first action (e.g. in the case of goal-conditioned or MTRL.)
- Return type
numpy.ndarray
-
step
(self, action)¶ Call step on wrapped env.
- Parameters
action (np.ndarray) – An action provided by the agent.
- Returns
The environment step resulting from the action.
- Return type
- Raises
RuntimeError – if step() is called after the environment has been constructed and reset() has not been called.
-
render
(self, mode)¶ Renders the environment.
-
visualize
(self)¶ Creates a visualization of the environment.
-
close
(self)¶ Close the wrapped env.
-
property