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

Update the documentation for v0.28 (#405)

Browse Source
This commit is contained in:
Mark Towers
2023-03-25 11:32:36 +00:00
committed by GitHub
parent 3d5c218a5f
commit cab0fbb13d
27 changed files with 115 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api/experimental.md
View File

@@ -155,11 +155,3 @@ We aimed to replace the wrappers in gymnasium v0.30.0 with these experimental wr
* :class:`experimental.wrappers.JaxToTorchV0`
* :class:`experimental.wrappers.NumpyToTorchV0`
```
## Vector Environment
These changes will be made in v0.28
## Wrappers for Vector Environments
These changes will be made in v0.28

8
docs/api/experimental/functional.md
View File

@@ -29,9 +29,9 @@ title: Functional
## gymnasium.experimental.func2env.FunctionalJaxCompatibilityEnv
```{eval-rst}
.. autoclass:: gymnasium.experimental.func_jax_env.FunctionalJaxEnv
.. autoclass:: gymnasium.experimental.functional_jax_env.FunctionalJaxEnv
.. autofunction:: gymnasium.experimental.func_jax_env.FunctionalJaxEnv.reset
.. autofunction:: gymnasium.experimental.func_jax_env.FunctionalJaxEnv.step
.. autofunction:: gymnasium.experimental.func_jax_env.FunctionalJaxEnv.render
.. autofunction:: gymnasium.experimental.functional_jax_env.FunctionalJaxEnv.reset
.. autofunction:: gymnasium.experimental.functional_jax_env.FunctionalJaxEnv.step
.. autofunction:: gymnasium.experimental.functional_jax_env.FunctionalJaxEnv.render
```

30
docs/api/experimental/vector.md
View File

@@ -6,10 +6,34 @@ title: Vector
## gymnasium.experimental.VectorEnv
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.VectorEnv
.. autofunction:: gymnasium.experimental.vector.VectorEnv.reset
.. autofunction:: gymnasium.experimental.vector.VectorEnv.step
.. autofunction:: gymnasium.experimental.vector.VectorEnv.close
.. autofunction:: gymnasium.experimental.vector.VectorEnv.reset
```
## gymnasium.experimental.vector.AsyncVectorEnv
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.AsyncVectorEnv
.. autofunction:: gymnasium.experimental.vector.AsyncVectorEnv.reset
.. autofunction:: gymnasium.experimental.vector.AsyncVectorEnv.step
.. autofunction:: gymnasium.experimental.vector.AsyncVectorEnv.close
.. autofunction:: gymnasium.experimental.vector.AsyncVectorEnv.call
.. autofunction:: gymnasium.experimental.vector.AsyncVectorEnv.get_attr
.. autofunction:: gymnasium.experimental.vector.AsyncVectorEnv.set_attr
```
## gymnasium.experimental.vector.SyncVectorEnv
## Custom Vector environments
## EnvPool
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.SyncVectorEnv
.. autofunction:: gymnasium.experimental.vector.SyncVectorEnv.reset
.. autofunction:: gymnasium.experimental.vector.SyncVectorEnv.step
.. autofunction:: gymnasium.experimental.vector.SyncVectorEnv.close
.. autofunction:: gymnasium.experimental.vector.SyncVectorEnv.call
.. autofunction:: gymnasium.experimental.vector.SyncVectorEnv.get_attr
.. autofunction:: gymnasium.experimental.vector.SyncVectorEnv.set_attr
```

19
docs/api/experimental/vector_utils.md
View File

@@ -1,12 +1,29 @@
---
title: Vector Utility functions
title: Vector Utility
---
# Utility functions for vectorisation
## Spaces utility functions
```{eval-rst}
.. autofunction:: gymnasium.experimental.vector.utils.batch_space
.. autofunction:: gymnasium.experimental.vector.utils.concatenate
.. autofunction:: gymnasium.experimental.vector.utils.iterate
.. autofunction:: gymnasium.experimental.vector.utils.create_empty_array
```
## Shared memory functions
```{eval-rst}
.. autofunction:: gymnasium.experimental.vector.utils.create_shared_memory
.. autofunction:: gymnasium.experimental.vector.utils.read_from_shared_memory
.. autofunction:: gymnasium.experimental.vector.utils.write_to_shared_memory
```
## Miscellaneous
```{eval-rst}
.. autofunction:: gymnasium.experimental.vector.utils.CloudpickleWrapper
.. autofunction:: gymnasium.experimental.vector.utils.clear_mpi_env_vars
```

24
docs/api/experimental/vector_wrappers.md
View File

@@ -4,12 +4,36 @@ title: Vector Wrappers
# Vector Environment Wrappers
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.VectorWrapper
```
## Vector Lambda Observation Wrappers
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.VectorObservationWrapper
```
## Vector Lambda Action Wrappers
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.VectorActionWrapper
```
## Vector Lambda Reward Wrappers
```{eval-rst}
.. autoclass:: gymnasium.experimental.vector.VectorRewardWrapper
```
## Vector Common Wrappers
```{eval-rst}
.. autoclass:: gymnasium.experimental.wrappers.vector.VectorRecordEpisodeStatistics
```
## Vector Only Wrappers
```{eval-rst}
.. autoclass:: gymnasium.experimental.wrappers.vector.VectorListInfo
```

4
docs/api/experimental/wrappers.md
View File

@@ -1,3 +1,7 @@
---
title: Wrappers
---
# Wrappers
## Observation Wrappers

2
docs/api/registry.md
View File

@@ -35,6 +35,6 @@ Gymnasium allows users to automatically load environments, pre-wrapped with seve
.. autofunction:: gymnasium.envs.registration.parse_env_id
.. autofunction:: gymnasium.envs.registration.find_highest_version
.. autofunction:: gymnasium.envs.registration.namespace
.. autofunction:: gymnasium.envs.registration.load_env
.. autofunction:: gymnasium.envs.registration.load_env_creator
.. autofunction:: gymnasium.envs.registration.load_plugin_envs
```