gaspersic/Gymnasium
1
0
Fork 0
mirror of https://github.com/Farama-Foundation/Gymnasium.git synced 2025-07-31 05:44:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

add performance utilites to the documenation (#986)

Browse Source
This commit is contained in:
Kallinteris Andreas
2024-03-27 11:18:44 +00:00
committed by GitHub
parent 373ccf0e00
commit f0202ae350
2 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/utils.md
View File

@@ -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
```