diff --git a/docs/api/utils.md b/docs/api/utils.md index 124b7fc33..8d2b317c9 100644 --- a/docs/api/utils.md +++ b/docs/api/utils.md @@ -49,3 +49,13 @@ title: Utility functions .. 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: + +```{eval-rst} +.. autofunction:: gymnasium.utils.performance.benchmark_step +.. autofunction:: gymnasium.utils.performance.benchmark_init +.. autofunction:: gymnasium.utils.performance.benchmark_render +``` diff --git a/gymnasium/utils/performance.py b/gymnasium/utils/performance.py index e80e46401..54d4da7b8 100644 --- a/gymnasium/utils/performance.py +++ b/gymnasium/utils/performance.py @@ -1,4 +1,4 @@ -"""A collection of perofmance bencharks, useful for debugging performance related issues.""" +"""A collection of runtime performance bencharks, useful for debugging performance related issues.""" import time from typing import Callable