v0.29.0 Release notes

We finally have a software citation for Gymnasium with the plan to release an associated paper after v1.0, thank you to all the contributors over the last 3 years who have made helped Gym and Gymnasium (#590)

@misc{towers_gymnasium_2023,
        title = {Gymnasium},
        url = {https://zenodo.org/record/8127025},
        abstract = {An API standard for single-agent reinforcement learning environments, with popular reference environments and related utilities (formerly Gym)},
        urldate = {2023-07-08},
        publisher = {Zenodo},
        author = {Towers, Mark and Terry, Jordan K. and Kwiatkowski, Ariel and Balis, John U. and Cola, Gianluca de and Deleu, Tristan and Goulão, Manuel and Kallinteris, Andreas and KG, Arjun and Krimmel, Markus and Perez-Vicente, Rodrigo and Pierré, Andrea and Schulhoff, Sander and Tai, Jun Jet and Shen, Andrew Tan Jin and Younis, Omar G.},
        month = mar,
        year = {2023},
        doi = {10.5281/zenodo.8127026},
}

Gymnasium has a conda package, conda install gymnasium. Thanks to @ChristofKaufmann for completing this

Breaking Changes

• Python 3.7 has reached its end of life support, therefore, we have dropped support for it (#573)
• Update MuJoCo Hopper & Walker2D models to work with MuJoCo >= 2.3.3 (#589)
• Add deprecation warnings to several features which will be removed in v1.0: Wrapper.__get_attr__, gymnasium.make(..., autoreset=True), gymnasium.make(..., apply_api_compatibility=True), Env.reward_range and gymnasium.vector.make. For their proposed replacement, see #535
• Raise error for Box bounds of low > high, low == inf and high == -inf (#495)
• Add dtype testing for NumPy Arrays in data_equivalence() (#515)
• Remove Jumpy from gymnasium wrappers as it was partially implemented with limited testing and usage (#548)
• Update project require for jax>=0.4 (#373)

New Features

• Remove the restrictions on pygame version, pygame>=2.1.3 (#558)
• Adding start parameter to MultiDiscrete space, similar to the Discrete(..., start) parameter (#557)
• Adds testing to check_env that closing a closed environment doesn't raise an error (#564)
• On initialisation wrapper.RecordVideo throws an error if the environment has an invalid render mode (None, "human", "ansi") (#580)
• Add MaxAndSkipObservation wrapper (#561)
• Add check_environments_match function for checking if two environments are identical (#576)
• Add performance debugging utilities, utils/performance.py (#583)
• Added Jax based cliff walking environment (#407)
• MuJoCo
  • Add support for relative paths with xml_file arguments (#536)
  • Add support for environments to specify info in reset (#540)
  • Remove requirement of environments defining metadata["render_fps"], the value is determined on __init__ using dt (#525)
• Experimental
  • Add deprecated wrapper error in gymnasium.experimental.wrappers (#341)
  • Add fps argument to RecordVideoV0 for custom fps value that overrides an environment's internal render_fps value (#503)
  • Add experimental vector wrappers for lambda observation, action and reward wrappers (#444)

Bug Fixes

• Fix spaces.Dict.keys() as key in keys was False (#608)
• Updates the action space of wrappers.RescaleAction based on the bounds (#569)
• Remove warnings in the passive environment checker for infinite Box bounds (#435)
• Revert Lunar Lander Observation space change (#512)
• Fix URL links in check_env (#554)
• Update shimmy[gym] to shimmy[gym-v21] or shimmy[gym-v26] (#433)
• Fix several issues within the experimental vector environment and wrappers (#516)
• Video recorder wrapper
  • Fix VideoRecorder on reset to empty recorded_frames rather than frames (#518)
  • Remove Env.close in VideoRecorder.close (#533)
  • Fix VideoRecorder and RecordVideoV0 to move import moviepy such that __del__ doesn't raise AttributeErrors (#553)
• Mujoco
  • Remove Hopper-v4's old render API func (#588)
  • Fix TypeError when closing rendering (#440)
  • Fix the wrong nstep in _step_mujoco_simulation function of MujocoEnv (#424)
  • Allow a different number of actuator control from the action space (#604)

Documentation Updates

• Allow users to view source code of referenced objects on the website (#497)
• Update website homepage (#482)
• Make atari documentation consistent (#418) and add missing descriptions (#510)
• Add third party envs: safety gymnasium, pyflyt, Gym-Trading-Env, stable-retro, DACBench, gym-cellular-automata
• Update MuJoCo documentation for all environments and base mujoco environment
• Update CartPole reward documentation to clarify different maximum rewards for v0 and v1 (#429)
• Clarify Frozen lake time limit for FrozenLake4x4 and FrozenLake8x8 environments (#459)
• Typo in the documentation for single_observation_space (#491)
• Fix the rendering of warnings on the website (#520)

Full Changelog: v0.28.1...v0.29.0