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 https://github.com/openai/gym/blob/master/gym/core.py for more information about the API.
It also optionally check that the environment is compatible with Stable-Baselines.
Env) – The Gym environment that will be checked
bool) – Whether to output additional warnings mainly related to the interaction with Stable Baselines
bool) – Whether to skip the checks for the render method. True by default (useful for the CI)
- Return type: