Gym Environment Checker

stable_baselines3.common.env_checker.check_env(env, warn=True, skip_render_check=True)[source]

Check that an environment follows Gym API. This is particularly useful when using a custom environment. Please take a look at for more information about the API.

It also optionally check that the environment is compatible with Stable-Baselines.

  • env (Env) – The Gym environment that will be checked

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

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

Return type: