Skip to content

Commit

Permalink
Update website external environments page
Browse files Browse the repository at this point in the history
  • Loading branch information
pseudo-rnd-thoughts committed Apr 17, 2024
1 parent 3d2a895 commit fb83760
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 13 deletions.
6 changes: 3 additions & 3 deletions docs/api/vector/async_vector_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
.. automethod:: gymnasium.vector.AsyncVectorEnv.set_attr
```

### Additional Methods
## Additional Methods

```{eval-rst}
.. autoproperty:: gymnasium.vector.VectorEnv.np_random
.. autoproperty:: gymnasium.vector.VectorEnv.np_random_seed
.. autoproperty:: gymnasium.vector.AsyncVectorEnv.np_random
.. autoproperty:: gymnasium.vector.AsyncVectorEnv.np_random_seed
```
6 changes: 3 additions & 3 deletions docs/api/vector/sync_vector_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
.. automethod:: gymnasium.vector.SyncVectorEnv.set_attr
```

### Additional Methods
## Additional Methods

```{eval-rst}
.. autoproperty:: gymnasium.vector.VectorEnv.np_random
.. autoproperty:: gymnasium.vector.VectorEnv.np_random_seed
.. autoproperty:: gymnasium.vector.SyncVectorEnv.np_random
.. autoproperty:: gymnasium.vector.SyncVectorEnv.np_random_seed
```
5 changes: 2 additions & 3 deletions docs/environments/third_party_environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
:tocdepth: 2
```

# External Environments

## First-Party Environments
The Farama Foundation maintains a number of other [projects](https://farama.org/projects), which use the Gymnasium API, environments include:

gridworlds ([Minigrid](https://minigrid.farama.org/)),
robotics ([Gymnasium-Robotics](https://robotics.farama.org/)),
3D navigation ([Miniworld](https://miniworld.farama.org/)),
Expand All @@ -16,13 +17,11 @@ autonomous driving ([HighwayEnv](https://highway-env.farama.org/))
Retro Games ([stable-retro](https://github.com/Farama-Foundation/stable-retro)), and many more.

The Farama Foundation also maintains alternate APIs for RL, including:

multi-agent RL ([PettingZoo](https://pettingzoo.farama.org/)),
offline-RL ([Minari](https://minari.farama.org/)),
multi-objective RL ([MO-Gymnasium](https://mo-gymnasium.farama.org/))
goal-RL ([Gymnasium-Robotics](https://robotics.farama.org/)),


## Third-party environments with Gymnasium

*This page contains environments which are not maintained by Farama Foundation and, as such, cannot be guaranteed to function as intended.*
Expand Down
4 changes: 2 additions & 2 deletions gymnasium/vector/async_vector_env.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,12 @@ def __init__(

@property
def np_random_seed(self) -> tuple[int, ...]:
"""Returns the seeds of the wrapped envs."""
"""Returns a tuple of np_random seeds for all the wrapped envs."""
return self.get_attr("np_random_seed")

@property
def np_random(self) -> tuple[np.random.Generator, ...]:
"""Returns the numpy random number generators of the wrapped envs."""
"""Returns the tuple of the numpy random number generators for the wrapped envs."""
return self.get_attr("np_random")

def reset(
Expand Down
4 changes: 2 additions & 2 deletions gymnasium/vector/sync_vector_env.py
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,12 @@ def __init__(

@property
def np_random_seed(self) -> tuple[int, ...]:
"""Returns the seeds of the wrapped envs."""
"""Returns a tuple of np random seeds for the wrapped envs."""
return self.get_attr("np_random_seed")

@property
def np_random(self) -> tuple[np.random.Generator, ...]:
"""Returns the numpy random number generators of the wrapped envs."""
"""Returns a tuple of the numpy random number generators for the wrapped envs."""
return self.get_attr("np_random")

def reset(
Expand Down

0 comments on commit fb83760

Please sign in to comment.