Skip to content

lit_sb3.core.env_checker

source module lit_sb3.core.env_checker

Functions

  • check_env — Check that an environment follows Gym API.

source 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://gymnasium.farama.org/api/env/ 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)

Raises

  • TypeError