Files
Gymnasium/docs/api/utils.md
2024-03-27 11:18:44 +00:00

1.4 KiB

title
title
Utility functions

Utility functions

Seeding

.. autofunction:: gymnasium.utils.seeding.np_random

Environment Checking

.. autofunction:: gymnasium.utils.env_checker.check_env

Visualization

.. autofunction:: gymnasium.utils.play.play
.. autoclass:: gymnasium.utils.play.PlayPlot

    .. automethod:: callback

.. autoclass:: gymnasium.utils.play.PlayableGame

    .. automethod:: process_event

Environment pickling

.. autoclass:: gymnasium.utils.ezpickle.EzPickle

Save Rendering Videos

.. autofunction:: gymnasium.utils.save_video.save_video
.. autofunction:: gymnasium.utils.save_video.capped_cubic_video_schedule

Old to New Step API Compatibility

.. 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

Runtime Performance benchmark

Sometimes is neccary to measure your environment's runtime performance, and ensure no performance regressions take place. These tests require manual inspection of its outputs:

.. autofunction:: gymnasium.utils.performance.benchmark_step
.. autofunction:: gymnasium.utils.performance.benchmark_init
.. autofunction:: gymnasium.utils.performance.benchmark_render