From d95899111dc1dfed0d3239fd0448338608e66c90 Mon Sep 17 00:00:00 2001 From: Mark Towers Date: Wed, 17 Apr 2024 14:52:41 +0100 Subject: [PATCH] Update website external environments page (#1029) --- docs/api/vector/async_vector_env.md | 6 +++--- docs/api/vector/sync_vector_env.md | 6 +++--- docs/environments/third_party_environments.md | 5 ++--- gymnasium/vector/async_vector_env.py | 4 ++-- gymnasium/vector/sync_vector_env.py | 4 ++-- 5 files changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/api/vector/async_vector_env.md b/docs/api/vector/async_vector_env.md index 14fdf5c50..0c9aa8d98 100644 --- a/docs/api/vector/async_vector_env.md +++ b/docs/api/vector/async_vector_env.md @@ -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 ``` diff --git a/docs/api/vector/sync_vector_env.md b/docs/api/vector/sync_vector_env.md index 1295f59f9..83ea6d80b 100644 --- a/docs/api/vector/sync_vector_env.md +++ b/docs/api/vector/sync_vector_env.md @@ -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 ``` diff --git a/docs/environments/third_party_environments.md b/docs/environments/third_party_environments.md index f3d4fcaee..f2f16aaf9 100644 --- a/docs/environments/third_party_environments.md +++ b/docs/environments/third_party_environments.md @@ -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/)), @@ -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.* diff --git a/gymnasium/vector/async_vector_env.py b/gymnasium/vector/async_vector_env.py index 4fda67bbf..58e1c4a94 100644 --- a/gymnasium/vector/async_vector_env.py +++ b/gymnasium/vector/async_vector_env.py @@ -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( diff --git a/gymnasium/vector/sync_vector_env.py b/gymnasium/vector/sync_vector_env.py index fd3e5586a..e59b2083c 100644 --- a/gymnasium/vector/sync_vector_env.py +++ b/gymnasium/vector/sync_vector_env.py @@ -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(