Farama-Foundation/Gymnasium

[New feature] Add reset options support for functional jax envs

Open

#1138 opened on Aug 8, 2024

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (4,712 stars) (567 forks)batch import
enhancementhelp wanted

Description

The current implementations of FunctionalJaxVectorEnv and FunctionalJaxEnv do not use any options in reset.

This should be fairly easy to add with FuncEnv.get_default_params, which will instantly support customizing any environment params on reset.

I can do this at some point in the future, or if any volunteers want to contribute this feature, that would be great.

Contributor guide

Tech stack
python
Domain
machine learning
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonJAXGymnasium functional API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Implement reset options support in `FunctionalJaxEnv` and `FunctionalJaxVectorEnv` by using `FuncEnv.get default params` as suggested. The main files to modify are `gymnasium/envs/functional jax env.py` and potentially `gymnasium/functional.py`. The issue provides clear pointers to the relevant lines. The maintainer expressed willingness to do it later, so contributions are welcome.