Skip to content

Commit

Permalink
Organize table in wrap_env docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Toni-SM committed Aug 27, 2024
1 parent 967e85e commit 48459c4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions skrl/envs/wrappers/jax/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ def wrap_env(env: Any, wrapper: str = "auto", verbose: bool = True) -> Union[Wra
- ``"gymnasium"``
* - Brax
- ``"brax"``
* - Isaac Lab
- ``"isaaclab"``
* - Isaac Lab (multi-agent as single-agent)
- ``"isaaclab-single-agent"``
* - Isaac Gym preview 2
- ``"isaacgym-preview2"``
* - Isaac Gym preview 3
Expand All @@ -52,10 +56,6 @@ def wrap_env(env: Any, wrapper: str = "auto", verbose: bool = True) -> Union[Wra
- ``"isaacgym-preview4"``
* - Omniverse Isaac Gym
- ``"omniverse-isaacgym"``
* - Isaac Lab
- ``"isaaclab"``
* - Isaac Lab (multi-agent as single-agent)
- ``"isaaclab-single-agent"``
.. list-table:: Multi-agent environments |br|
:header-rows: 1
Expand All @@ -64,10 +64,10 @@ def wrap_env(env: Any, wrapper: str = "auto", verbose: bool = True) -> Union[Wra
- Wrapper tag
* - Petting Zoo
- ``"pettingzoo"``
* - Bi-DexHands
- ``"bidexhands"``
* - Isaac Lab
- ``"isaaclab-multi-agent"``
* - Bi-DexHands
- ``"bidexhands"``
:type wrapper: str, optional
:param verbose: Whether to print the wrapper type (default: ``True``)
:type verbose: bool, optional
Expand Down
16 changes: 8 additions & 8 deletions skrl/envs/wrappers/torch/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,12 @@ def wrap_env(env: Any, wrapper: str = "auto", verbose: bool = True) -> Union[Wra
- ``"gymnasium"``
* - DeepMind
- ``"dm"``
* - Robosuite
- ``"robosuite"``
* - Brax
- ``"brax"``
* - Isaac Lab
- ``"isaaclab"``
* - Isaac Lab (multi-agent as single-agent)
- ``"isaaclab-single-agent"``
* - Isaac Gym preview 2
- ``"isaacgym-preview2"``
* - Isaac Gym preview 3
Expand All @@ -62,10 +64,8 @@ def wrap_env(env: Any, wrapper: str = "auto", verbose: bool = True) -> Union[Wra
- ``"isaacgym-preview4"``
* - Omniverse Isaac Gym
- ``"omniverse-isaacgym"``
* - Isaac Lab
- ``"isaaclab"``
* - Isaac Lab (multi-agent as single-agent)
- ``"isaaclab-single-agent"``
* - Robosuite
- ``"robosuite"``
.. list-table:: Multi-agent environments |br|
:header-rows: 1
Expand All @@ -74,10 +74,10 @@ def wrap_env(env: Any, wrapper: str = "auto", verbose: bool = True) -> Union[Wra
- Wrapper tag
* - Petting Zoo
- ``"pettingzoo"``
* - Bi-DexHands
- ``"bidexhands"``
* - Isaac Lab
- ``"isaaclab-multi-agent"``
* - Bi-DexHands
- ``"bidexhands"``
:type wrapper: str, optional
:param verbose: Whether to print the wrapper type (default: ``True``)
:type verbose: bool, optional
Expand Down

0 comments on commit 48459c4

Please sign in to comment.