Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Gym to Gymnasium #6166

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

Zach-Attach
Copy link

@Zach-Attach Zach-Attach commented Oct 30, 2024

Proposed change(s)

  • Updated requirement from gym 0.21 to the latest version of gymnasium
    • version currently not specified but can be for safety
  • Updated pettingzoo requirement to be compatible with latest version
    • set to 1.22.0 or greater (versions that use gymnasium)
  • Replaced all gym imports to gymnasium
  • Updated step and reset functions in UnityToGymWrapper and UnityParallelEnv to align with Gymnasium expectations (see https://github.com/Farama-Foundation/Gymnasium/blob/main/docs/introduction/migration_guide.md for details)
    • UnityAECEnv stays the same
  • Updated tests to use gymnasium and expect new step and reset functions
  • Updated documentation to no longer refer to OpenAI Gym and now refer to Farama Foundation's Gymnasium

Useful links (Github issues, JIRA tickets, ML-Agents forum threads etc.)

There is 1 open PR and 4 issues related to this addition:

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

  • I do not use pettingzoo or the premade environments much myself, so there may be additional fixes that are needed.
  • I was unsure if I was expected to add to the changelog or migration guide since this is not an actual release, but am happy to contribute.
  • This change may result in the possibility of upgrading the maximum version other dependencies (grpcio, protobuf, numpy) as well, potentially adding support for python 3.11 or newer.

@CLAassistant
Copy link

CLAassistant commented Oct 30, 2024

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants