2022-09-13 20:27:34 +01:00
|
|
|
---
|
2022-10-12 15:58:01 +01:00
|
|
|
title: Wrapper
|
2022-09-13 20:27:34 +01:00
|
|
|
---
|
|
|
|
|
|
|
|
# Wrappers
|
|
|
|
|
2022-10-12 15:58:01 +01:00
|
|
|
```{toctree}
|
|
|
|
:hidden:
|
2023-11-07 13:27:25 +00:00
|
|
|
|
|
|
|
wrappers/table
|
2022-10-12 15:58:01 +01:00
|
|
|
wrappers/misc_wrappers
|
|
|
|
wrappers/action_wrappers
|
|
|
|
wrappers/observation_wrappers
|
|
|
|
wrappers/reward_wrappers
|
2022-09-13 20:27:34 +01:00
|
|
|
```
|
|
|
|
|
2022-12-03 13:46:11 +01:00
|
|
|
```{eval-rst}
|
|
|
|
.. automodule:: gymnasium.wrappers
|
|
|
|
```
|
|
|
|
|
2022-09-13 20:27:34 +01:00
|
|
|
|
2022-10-12 15:58:01 +01:00
|
|
|
```{eval-rst}
|
|
|
|
.. autoclass:: gymnasium.Wrapper
|
2022-09-13 20:27:34 +01:00
|
|
|
```
|
|
|
|
|
2023-11-07 13:27:25 +00:00
|
|
|
## Methods
|
2022-10-12 15:58:01 +01:00
|
|
|
```{eval-rst}
|
2023-11-07 13:27:25 +00:00
|
|
|
.. automethod:: gymnasium.Wrapper.step
|
|
|
|
.. automethod:: gymnasium.Wrapper.reset
|
|
|
|
.. automethod:: gymnasium.Wrapper.render
|
|
|
|
.. automethod:: gymnasium.Wrapper.close
|
|
|
|
.. automethod:: gymnasium.Wrapper.wrapper_spec
|
|
|
|
.. automethod:: gymnasium.Wrapper.get_wrapper_attr
|
|
|
|
.. automethod:: gymnasium.Wrapper.set_wrapper_attr
|
2022-09-13 20:27:34 +01:00
|
|
|
```
|
|
|
|
|
2023-11-07 13:27:25 +00:00
|
|
|
## Attributes
|
2022-10-12 15:58:01 +01:00
|
|
|
```{eval-rst}
|
2023-11-07 13:27:25 +00:00
|
|
|
.. autoattribute:: gymnasium.Wrapper.env
|
|
|
|
|
|
|
|
The environment (one level underneath) this wrapper.
|
|
|
|
|
|
|
|
This may itself be a wrapped environment. To obtain the environment underneath all layers of wrappers, use :attr:`gymnasium.Wrapper.unwrapped`.
|
|
|
|
|
2022-10-12 15:58:01 +01:00
|
|
|
.. autoproperty:: gymnasium.Wrapper.action_space
|
|
|
|
.. autoproperty:: gymnasium.Wrapper.observation_space
|
|
|
|
.. autoproperty:: gymnasium.Wrapper.spec
|
|
|
|
.. autoproperty:: gymnasium.Wrapper.metadata
|
|
|
|
.. autoproperty:: gymnasium.Wrapper.np_random
|
2024-02-26 13:00:18 +01:00
|
|
|
.. autoproperty:: gymnasium.Wrapper.np_random_seed
|
2022-10-12 15:58:01 +01:00
|
|
|
.. autoproperty:: gymnasium.Wrapper.unwrapped
|
2022-09-13 20:27:34 +01:00
|
|
|
```
|