Files
Gymnasium/docs/api/utils.md
Mark Towers 27f8e85051 Merge v1.0.0 (#682)
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>
2023-11-07 13:27:25 +00:00

52 lines
1.0 KiB
Markdown

---
title: Utility functions
---
# Utility functions
## Seeding
```{eval-rst}
.. autofunction:: gymnasium.utils.seeding.np_random
```
## Environment Checking
```{eval-rst}
.. autofunction:: gymnasium.utils.env_checker.check_env
```
## Visualization
```{eval-rst}
.. autofunction:: gymnasium.utils.play.play
.. autoclass:: gymnasium.utils.play.PlayPlot
.. automethod:: callback
.. autoclass:: gymnasium.utils.play.PlayableGame
.. automethod:: process_event
```
## Environment pickling
```{eval-rst}
.. autoclass:: gymnasium.utils.ezpickle.EzPickle
```
## Save Rendering Videos
```{eval-rst}
.. autofunction:: gymnasium.utils.save_video.save_video
.. autofunction:: gymnasium.utils.save_video.capped_cubic_video_schedule
```
## Old to New Step API Compatibility
```{eval-rst}
.. autofunction:: gymnasium.utils.step_api_compatibility.step_api_compatibility
.. autofunction:: gymnasium.utils.step_api_compatibility.convert_to_terminated_truncated_step_api
.. autofunction:: gymnasium.utils.step_api_compatibility.convert_to_done_step_api
```