Files
Gymnasium/docs/api/utils.md
Manuel Goulão 91769fc862 Add docs (#13)
2022-09-13 20:27:34 +01:00

1.5 KiB

title
title
Utils

Utils

Visualization

.. autoclass:: gymnasium.utils.play.PlayableGame
    
    .. automethod:: process_event

.. autoclass:: gymnasium.utils.play.PlayPlot
    
    .. automethod:: callback

.. autofunction:: gymnasium.utils.play.display_arr
.. autofunction:: gymnasium.utils.play.play

Save Rendering Videos

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

Old to New 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
.. autofunction:: gymnasium.utils.step_api_compatibility.step_api_compatibility

Seeding

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

Environment Checking

Invasive

.. autofunction:: gymnasium.utils.env_checker.check_env
.. autofunction:: gymnasium.utils.env_checker.data_equivalence
.. autofunction:: gymnasium.utils.env_checker.check_reset_seed
.. autofunction:: gymnasium.utils.env_checker.check_reset_options
.. autofunction:: gymnasium.utils.env_checker.check_reset_return_info_deprecation
.. autofunction:: gymnasium.utils.env_checker.check_seed_deprecation
.. autofunction:: gymnasium.utils.env_checker.check_reset_return_type
.. autofunction:: gymnasium.utils.env_checker.check_space_limit