Farama-Foundation/Gymnasium

[Proposal] Add wrapper checker

Open

#6 opened on Sep 10, 2022

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (4,712 stars) (567 forks)batch import
enhancementgood first issue

Description

In v24 / 25, we added an environment checker for users to check that environment follow the API correctly. As some environments implement their own wrappers and to check our own, it would be helpful to add a wrapper checker.

Proposed checks

  • Check that all observations and actions spaces are valid (all observations are contained in space)
  • Check the input and output types for reset and step

Contributor guide

Tech stack
python
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonGymnasium environment APIunderstanding of wrappers
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the existing environment checker in the Gymnasium repository (likely in gymnasium/envs/registration.py or similar). Understand how it validates environments. Then, design a wrapper checker that verifies observation/action spaces are valid and input/output types for reset and step. Check the issue comments for any additional requirements or design discussions.