Warning

This package is in maintenance mode, please use Stable-Baselines3 (SB3) for an up-to-date version. You can find a migration guide in SB3 documentation.

Gym Environment Checker

stable_baselines.common.env_checker.check_env(env: gym.core.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.

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

Parameters:

• env – (gym.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)