Commit a46c7d6d authored by Mayank Mittal's avatar Mayank Mittal

fixes the wrapper docstring to call Isaac Orbit environments

parent f17f253d
......@@ -50,9 +50,9 @@ Vectorized environment wrapper.
class RlGamesVecEnvWrapper(gym.Wrapper):
"""Wraps around IsaacSim environment for RL-Games.
"""Wraps around Isaac Orbit environment for RL-Games.
This class wraps around the IsaacSim environment. Since RL-Games works directly on
This class wraps around the Isaac Orbit environment. Since RL-Games works directly on
GPU buffers, the wrapper handles moving of buffers from the simulation environment
to the same device as the learning agent. Additionally, it performs clipping of
observations and actions.
......
......@@ -44,7 +44,7 @@ VecEnvStepReturn = Tuple[VecEnvObs, VecEnvObs, torch.Tensor, torch.Tensor, Dict]
class RslRlVecEnvWrapper(gym.Wrapper, VecEnv):
"""Wraps around IsaacSim environment for RSL-RL.
"""Wraps around Isaac Orbit environment for RSL-RL.
To use asymmetric actor-critic, the environment instance must have the attributes :attr:`num_states` (int)
and :attr:`state_space` (:obj:`gym.spaces.Box`). These are used by the learning agent to allocate buffers in
......
......@@ -35,7 +35,7 @@ Vectorized environment wrapper.
class Sb3VecEnvWrapper(gym.Wrapper, VecEnv):
"""Wraps around IsaacSim environment for Stable Baselines3.
"""Wraps around Isaac Orbit environment for Stable Baselines3.
Isaac Sim internally implements a vectorized environment. However, since it is
still considered a single environment instance, Stable Baselines tries to wrap
......@@ -51,8 +51,8 @@ class Sb3VecEnvWrapper(gym.Wrapper, VecEnv):
1. numpy datatype for MDP signals
2. a list of info dicts for each sub-environment (instead of a dict)
3. when environment has terminated, the observations from the environment should correspond
to the one after reset. The "real" final observation is passed using the info dicts
under the key `terminal_observation`.
to the one after reset. The "real" final observation is passed using the info dicts
under the key ``terminal_observation``.
Warning:
By the nature of physics stepping in Isaac Sim, it is not possible to forward the
......
......@@ -41,9 +41,9 @@ Vectorized environment wrapper.
def SkrlVecEnvWrapper(env: IsaacEnv):
"""Wraps around IsaacSim environment for skrl.
"""Wraps around Isaac Orbit environment for skrl.
This function wraps around the IsaacSim environment. Since the :class:`IsaacEnv` environment
This function wraps around the Isaac Orbit environment. Since the :class:`IsaacEnv` environment
wrapping functionality is defined within the skrl library itself, this implementation
is maintained for compatibility with the structure of the extension that contains it.
Internally it calls the :func:`wrap_env` from the skrl library API.
......
......@@ -3,7 +3,7 @@
#
# SPDX-License-Identifier: BSD-3-Clause
"""Script to collect demonstrations with IsaacSim environments."""
"""Script to collect demonstrations with Isaac Orbit environments."""
"""Launch Isaac Sim Simulator first."""
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment