Gym

This is a bug fix release for version 0.24.0

Bugs fixed:
* Replaced the environment checker introduced in V24, such that the environment checker will not call `step` and `reset` during make. This new version is a wrapper that will observe the data that `step` and `reset` returns on their first call and check the data against the environment checker. pseudo-rnd-thoughts
* Fixed MuJoCo v4 arguments key callback, closing the environment in renderer and the mujoco_rendering close method. rodrigodelazcano
* Removed redundant warning in registration RedTachyon
* Removed maths operations from MuJoCo xml files quagla
* Added support for unpickling legacy `spaces.Box` pseudo-rnd-thoughts
* Fixed mujoco environment action and observation space docstring tables pseudo-rnd-thoughts
* Disable wrappers from accessing `_np_random` property and `np_random` is now forwarded to environments pseudo-rnd-thoughts
* Rewrite setup.py to add a "testing" meta dependency group pseudo-rnd-thoughts
* Fixed docstring in `rescale_action` wrapper gianlucadecola

Major changes
* Added v4 mujoco environments that use the new [deepmind mujoco](https://github.com/deepmind/mujoco) 2.2.0 module.
This can be installed through `pip install gym[mujoco]` with the old bindings still being
available using the `v3` environments and `pip install gym[mujoco-py]`.
These new `v4` environment should have the same training curves as `v3`. For the Ant, we found that there was a
contact parameter that was not applied in `v3` that can enabled in `v4` however was found to produce significantly
worse performance [see comment](https://github.com/openai/gym/pull/2762#issuecomment-1135362092) for more details. Rodrigodelazcano
* The vector environment step `info` API has been changes to allow hardware acceleration in the future.
See [this PR](https://github.com/openai/gym/pull/2773) for the modified `info` style that now uses dictionaries instead of a list of environment info.
If you still wish to use the list info style, then use the `VectorListInfo` wrapper. gianlucadecola
* On `gym.make`, the gym `env_checker` is run that includes calling the environment `reset` and `step` to check if the
environment is compliant to the gym API. To disable this feature, run `gym.make(..., disable_env_checker=True)`. RedTachyon
* Re-added `gym.make("MODULE:ENV")` import style that was accidentally removed in v0.22 arjun-kg
* `Env.render` is now order enforced such that `Env.reset` is required before `Env.render` is called. If this a required
feature then set the `OrderEnforcer` wrapper `disable_render_order_enforcing=True`. pseudo-rnd-thoughts
* Added wind and turbulence to the Lunar Lander environment, this is by default turned off,
use the `wind_power` and `turbulence` parameter. virgilt
* Improved the `play` function to allows multiple keyboard letter to pass instead of ascii value Markus28
* Added google style pydoc strings for most of the repositories pseudo-rnd-thoughts Markus28
* Added discrete car racing environment version through `gym.make("CarRacing-v1", continuous=False)`
* Pygame is now an optional module for box2d and classic control environments that is only necessary for rendering.
Therefore, install pygame using `pip install gym[box2d]` or `pip install gym[classic_control]` gianlucadecola RedTachyon
* Fixed bug in batch spaces (used in VectorEnv) such that the original space's seed was ignored pseudo-rnd-thoughts
* Added `AutoResetWrapper` that automatically calls `Env.reset` when `Env.step` done is True balisujohn

Minor changes
* BipedalWalker and LunarLander's observation spaces have non-infinite upper and lower bounds. jjshoots
* Bumped the ALE-py version to `0.7.5`
* Improved the performance of car racing through not rendering polygons off screen andrewtanJS
* Fixed turn indicators that were black not red/white in Car racing jjshoots
* Bug fixes for `VecEnvWrapper` to forward method calls to the environment arjun-kg
* Removed unnecessary try except on Box2d such that if `Box2d` is not installed correctly then a more helpful error is show pseudo-rnd-thoughts
* Simplified the `gym.registry` backend RedTachyon
* Re-added python 3.6 support through backports of python 3.7+ modules. This is not tested or compatible with the mujoco environments. pseudo-rnd-thoughts

This release contains a few small bug fixes and no breaking changes.

* Make `VideoRecorder` backward-compatible to `gym<0.23` by vwxyzjn in https://github.com/openai/gym/pull/2678
* Fix issues with pygame event handling (which should fix support on windows and in jupyter notebooks) by andrewtanJS in https://github.com/openai/gym/pull/2684
* Add py.typed to package_data by micimize in https://github.com/openai/gym/p
* Fixes around 1500 warnings in CI pseudo-rnd-thoughts
* Deprecation warnings correctly display now vwxyzjn
* Fix removing striker and thrower RushivArora
* Fix small dependency warning errorr ZhiqingXiao

This release contains many bug fixes and a few small changes.

Breaking changes:
- Standardized render metadata variables ahead of render breaking change trigaten
- Removed deprecated monitor wrapper and associated dead code gianlucadecola
- Unused striker and thrower MuJoCo envs moved to https://github.com/RushivArora/Gym-Mujoco-Archive RushivArora

Many minor bug fixes (vwxyzjn , RedTachyon , rusu24edward , Markus28 , dsctt , andrewtanJS , tristandeleu , duburcqa)

This release represents the largest set of changes ever to Gym, and represents a huge step towards the plans for 1.0 outlined here: https://github.com/openai/gym/issues/2524

Gym now has a new comprehensive documentation site: https://www.gymlibrary.ml/ !

API changes:

-`env.reset` now accepts three new arguments:

`options`- Usable for things like controlling curriculum learning without reinitializing the environment, which can be expensive (RedTachyon)
`seed`- Environment seeds can be passed to this reset argument in the future. The old `.seed()` method is being deprecated in favor of this, though it will continue to function as before until the 1.0 release for backwards compatibility purposes (RedTachyon)
`infos`- when set to `True`, reset will return obs, info. This currently defaults to `False`, but will become the default behavior in Gym 1.0 (RedTachyon)

-Environment names no longer require a version during registration and will suggest intelligent similar names (kir0ul, JesseFarebro)

-Vector environments now support terminal_observation in `info` and support batch action spaces (vwxyzjn, tristandeleu)

Environment changes:
-The blackjack and frozen lake toy_text environments now have nice graphical rendering using PyGame (1b15)
-Moved robotics environments to gym-robotics package (seungjaeryanlee, Rohan138, vwxyzjn) (per discussion in https://github.com/openai/gym/issues/2456#issue-1032765998)
-The bipedal walker and lunar lander environments were consolidated into one class (andrewtanJS)
-Atari environments now use standard seeding API (JesseFarebro)
-Fixed large bug fixes in car_racing box2d environment, bumped version (carlosluis, araffin)
-Refactored all box2d and classic_control environments to use PyGame instead of Pyglet as issues with pyglet has been one of the most frequent sources of GitHub issues over the life of the gym project (andrewtanJS)

Other changes:
-Removed DiscreteEnv class, built in environments no longer use it (carlosluis)
-Large numbers of type hints added (ikamensh, RedTachyon)
-Python 3.10 support
-Tons of additional code refactoring, cleanup, error message improvements and small bug fixes (vwxyzjn, Markus28, RushivArora, jjshoots, XuehaiPan, Rohan138, JesseFarebro, Ericonaldo, AdilZouitine, RedTachyon)
-All environment files now have dramatically improved readmes at the top (that the documentation website automatically pulls from)
-As part of the seeding changes, Gym's RNG has been modified to use the np.random.Generator as the RandomState API has been deprecated. The methods randint, rand, randn are replaced by integers, random and standard_normal respectively. As a consequence, the random number generator has changed from MT19937 to PCG64.

-The old Atari entry point that was broken with the last release and the upgrade to ALE-Py is fixed (JesseFarebro)
-Atari environments now give much clearer error messages and warnings (JesseFarebro)
-A new plugin system to enable an easier inclusion of third party environments has been added (JesseFarebro)
-Atari environments now use the new plugin system to prevent clobbered names and other issues (JesseFarebro)
-`pip install gym[atari]` no longer distributes Atari ROMs that the ALE (the Atari emulator used) needs to run the various games. The easiest way to install ROMs into the ALE has been to use [AutoROM](https://github.com/PettingZoo-Team/AutoROM). Gym now has a hook to AutoROM for easier CI automation so that using `pip install gym[accept-rom-license]` calls AutoROM to add ROMs to the ALE. You can install the entire suite with the shorthand `gym[atari, accept-rom-license]`. Note that as described in the name name, by installing `gym[accept-rom-license]` you are confirming that you have the relevant license to install the ROMs. (JesseFarebro)
-An accidental breaking change when loading saved policies trained on old versions of Gym with environments using the box action space have been fixed. (RedTachyon)
-Pendulum has had a minor fix to it's physics logic made and the version has been bumped to v1 (RedTachyon)
-Tests have been refactored into an orderly manner (RedTachyon)
-Dict spaces now have standard dict helper methods (Rohan138)
-Environment properties are now forwarded to the wrapper (tristandeleu)
-Gym now _properly_ enforces calling reset before stepping for the first time (ahmedo42)
-Proper piping of error messages to stderr (XuehaiPan)
-Fix video saving issues (zlig)

Also, Gym is compiling a list of third party environments to into the new documentation website we're working on. Please submit PRs for ones that are missing: https://github.com/openai/gym/blob/master/docs/third_party_environments.md