Farama-Foundation/Gymnasium

[Proposal] Add wrapper checker

Open

#6 opened on Sep 10, 2022

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

Repository metrics

Stars
 (4,712 stars)
PR merge metrics
 (Avg merge 1d 9h) (10 merged PRs in 30d)

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

Research direction
Review the existing environment checker implementation in the Gymnasium codebase, understand how it validates spaces and types, then design a similar checker for wrappers that verifies observation/action spaces and reset/step signatures.
Tech stack
python
Domain
apitesting
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.
1-2 days
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.
Clear
Prerequisites
PythonGymnasium basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65