gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-08-01 14:10:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge v1.0.0 (#682)

Browse Source 
Co-authored-by: Kallinteris Andreas <30759571+Kallinteris-Andreas@users.noreply.github.com>
Co-authored-by: Jet <38184875+jjshoots@users.noreply.github.com>
Co-authored-by: Omar Younis <42100908+younik@users.noreply.github.com>
This commit is contained in:
Mark Towers
2023-11-07 13:27:25 +00:00
committed by GitHub
parent cf5f588433
commit 27f8e85051
256 changed files with 7051 additions and 13421 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api/vector/async_vector_env.md Normal file
View File

@@ -0,0 +1,13 @@
# AsyncVectorEnv
```{eval-rst}
.. autoclass:: gymnasium.vector.AsyncVectorEnv
.. automethod:: gymnasium.vector.AsyncVectorEnv.reset
.. automethod:: gymnasium.vector.AsyncVectorEnv.step
.. automethod:: gymnasium.vector.AsyncVectorEnv.close
.. automethod:: gymnasium.vector.AsyncVectorEnv.call
.. automethod:: gymnasium.vector.AsyncVectorEnv.get_attr
.. automethod:: gymnasium.vector.AsyncVectorEnv.set_attr
```

13
docs/api/vector/sync_vector_env.md Normal file
View File

@@ -0,0 +1,13 @@
# SyncVectorEnv
```{eval-rst}
.. autoclass:: gymnasium.vector.SyncVectorEnv
.. automethod:: gymnasium.vector.SyncVectorEnv.reset
.. automethod:: gymnasium.vector.SyncVectorEnv.step
.. automethod:: gymnasium.vector.SyncVectorEnv.close
.. automethod:: gymnasium.vector.SyncVectorEnv.call
.. automethod:: gymnasium.vector.SyncVectorEnv.get_attr
.. automethod:: gymnasium.vector.SyncVectorEnv.set_attr
```

25
docs/api/vector/utils.md Normal file
View File

@@ -0,0 +1,25 @@
# Utility functions
## Vectorizing Spaces
```{eval-rst}
.. autofunction:: gymnasium.vector.utils.batch_space
.. autofunction:: gymnasium.vector.utils.concatenate
.. autofunction:: gymnasium.vector.utils.iterate
.. autofunction:: gymnasium.vector.utils.create_empty_array
```
## Shared Memory for a Space
```{eval-rst}
.. autofunction:: gymnasium.vector.utils.create_shared_memory
.. autofunction:: gymnasium.vector.utils.read_from_shared_memory
.. autofunction:: gymnasium.vector.utils.write_to_shared_memory
```
## Miscellaneous
```{eval-rst}
.. autofunction:: gymnasium.vector.utils.CloudpickleWrapper
.. autofunction:: gymnasium.vector.utils.clear_mpi_env_vars
```

26
docs/api/vector/wrappers.md Normal file
View File

@@ -0,0 +1,26 @@
---
title: Vector Wrappers
---
# Vector Wrappers
```{eval-rst}
.. autoclass:: gymnasium.vector.VectorWrapper
.. automethod:: gymnasium.vector.VectorWrapper.step
.. automethod:: gymnasium.vector.VectorWrapper.reset
.. automethod:: gymnasium.vector.VectorWrapper.close
.. autoclass:: gymnasium.vector.VectorObservationWrapper
.. automethod:: gymnasium.vector.VectorObservationWrapper.vector_observation
.. automethod:: gymnasium.vector.VectorObservationWrapper.single_observation
.. autoclass:: gymnasium.vector.VectorActionWrapper
.. automethod:: gymnasium.vector.VectorActionWrapper.actions
.. autoclass:: gymnasium.vector.VectorRewardWrapper
.. automethod:: gymnasium.vector.VectorRewardWrapper.rewards
```