gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-07-31 13:54:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update website external environments page (#1029)

Browse Source
This commit is contained in:
Mark Towers
2024-04-17 14:52:41 +01:00
committed by GitHub
parent 3d2a8957a5
commit d95899111d
5 changed files with 12 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/vector/async_vector_env.md
View File

@@ -12,9 +12,9 @@
.. automethod:: gymnasium.vector.AsyncVectorEnv.set_attr .. automethod:: gymnasium.vector.AsyncVectorEnv.set_attr
``` ```
### Additional Methods ## Additional Methods
```{eval-rst} ```{eval-rst}
.. autoproperty:: gymnasium.vector.VectorEnv.np_random .. autoproperty:: gymnasium.vector.AsyncVectorEnv.np_random
.. autoproperty:: gymnasium.vector.VectorEnv.np_random_seed .. autoproperty:: gymnasium.vector.AsyncVectorEnv.np_random_seed
``` ```

6
docs/api/vector/sync_vector_env.md
View File

@@ -12,9 +12,9 @@
.. automethod:: gymnasium.vector.SyncVectorEnv.set_attr .. automethod:: gymnasium.vector.SyncVectorEnv.set_attr
``` ```
### Additional Methods ## Additional Methods
```{eval-rst} ```{eval-rst}
.. autoproperty:: gymnasium.vector.VectorEnv.np_random .. autoproperty:: gymnasium.vector.SyncVectorEnv.np_random
.. autoproperty:: gymnasium.vector.VectorEnv.np_random_seed .. autoproperty:: gymnasium.vector.SyncVectorEnv.np_random_seed
``` ```

5
docs/environments/third_party_environments.md
View File

@@ -2,9 +2,10 @@
:tocdepth: 2 :tocdepth: 2
``` ```
# External Environments
## First-Party Environments ## First-Party Environments
The Farama Foundation maintains a number of other [projects](https://farama.org/projects), which use the Gymnasium API, environments include: 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/)), gridworlds ([Minigrid](https://minigrid.farama.org/)),
robotics ([Gymnasium-Robotics](https://robotics.farama.org/)), robotics ([Gymnasium-Robotics](https://robotics.farama.org/)),
3D navigation ([Miniworld](https://miniworld.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. Retro Games ([stable-retro](https://github.com/Farama-Foundation/stable-retro)), and many more.
The Farama Foundation also maintains alternate APIs for RL, including: The Farama Foundation also maintains alternate APIs for RL, including:
multi-agent RL ([PettingZoo](https://pettingzoo.farama.org/)), multi-agent RL ([PettingZoo](https://pettingzoo.farama.org/)),
offline-RL ([Minari](https://minari.farama.org/)), offline-RL ([Minari](https://minari.farama.org/)),
multi-objective RL ([MO-Gymnasium](https://mo-gymnasium.farama.org/)) multi-objective RL ([MO-Gymnasium](https://mo-gymnasium.farama.org/))
goal-RL ([Gymnasium-Robotics](https://robotics.farama.org/)), goal-RL ([Gymnasium-Robotics](https://robotics.farama.org/)),
## Third-party environments with Gymnasium ## 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.* *This page contains environments which are not maintained by Farama Foundation and, as such, cannot be guaranteed to function as intended.*

4
gymnasium/vector/async_vector_env.py
View File

@@ -199,12 +199,12 @@ class AsyncVectorEnv(VectorEnv):
@property @property
def np_random_seed(self) -> tuple[int, ...]: 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") return self.get_attr("np_random_seed")
@property @property
def np_random(self) -> tuple[np.random.Generator, ...]: 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") return self.get_attr("np_random")
def reset( def reset(

4
gymnasium/vector/sync_vector_env.py
View File

@@ -102,12 +102,12 @@ class SyncVectorEnv(VectorEnv):
@property @property
def np_random_seed(self) -> tuple[int, ...]: 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") return self.get_attr("np_random_seed")
@property @property
def np_random(self) -> tuple[np.random.Generator, ...]: 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") return self.get_attr("np_random")
def reset( def reset(