sinergym.utils.env_checker.check_env

sinergym.utils.env_checker.check_env(env: gym.Env, warn: bool = True, skip_render_check: bool = True) → None

Check that an environment follows Gym API. This is particularly useful when using a custom environment. Please take a look at https://github.com/openai/gym/blob/master/gym/core.py for more information about the API.

This env_checker has been adapted from Stable-Baselines: https://github.com/DLR-RM/stable-baselines3 It also optionally check that the environment is compatible with Stable-Baselines.

Parameters:

  • env – The Gym environment that will be checked

  • warn – Whether to output additional warnings mainly related to the interaction with Stable Baselines

  • skip_render_check – Whether to skip the checks for the render method. True by default (useful for the CI)