PettingZoo 1.25.0 release note
In this release of PettingZoo, we have introduced support for python 3.12, gymnasium>=1.0.0, and agilerl>=2.0.0. We have deprecated python 3.8, and added warnings to prepare the future transfer of the MPE environments to the package MPE2 in a future release.
We have worked on implementing bug fixes since the last release in January 2024.
PettingZoo 1.25.0 coincides with a new release of Supersuit.
Breaking changes
- Class
agent_selectorwas renamedAgentSelector(#1194). - Python 3.8 is no longer supported (#1246).
- Update gymnasium to >=1.0.0 (#1272).
- AgileRL tutorials updated for version 2.0.0 (#1258).
New features and improvements
- Unused ansi rendering code was removed from tictactoe (#1171).
- Compatibility with pytest version 8 was added (#1177).
- Unneeded warning in Maze Craze was removed (#1164).
- Comments about necessary linux packages were added in README (#1191).
- Update to third_party_envs.md (#1201).
- Update the TicTacToe environment (#1192).
- Added radius rescaling to MPE simple env (#1213).
- Add an easy-to-install gfootball environment, SMAC and SMACv2 with pettingzoo apis in
third_party_envs(#1217). - Box Jump added to third party environments (#1276).
- Support for python 3.12 enabled (#1226).
- Duplicate code in RLCard environments removed (#1282).
- Deprecation warnings added to MPE imports (#1280).
Bug fixes
- 30,000-ish warnings from pytest fixed (#1157).
- Pyright upgrade fixed (#1166).
- Typo fix in parallel API link in
custom_environment.index.md(#1183). - MacOS pygame
no hardware accelerated deviceerror fixed (#1190). - Test to handle nested observation dicts fixed (#1172).
- Images that weren't rendering correctly with inline LaTeX fixed (#1198).
- Bug in SB3 tutorial ActionMask fixed (#1203).
- TerminateIllegalWrapper bug fix (#1206).
- Order enforcing wrapper bug fix (#1205).
- Fixed error in render function for CustomActionMaskedEnvironment Class (#1239).
- Broken tests for connect_four fixed (#1243).
- Github Workflow for Building Documentations fixed (#1268).
- Pyright type error fixed (#1270).
- AgileRL tutorial CI/CD workflow fixed (#1275).
- AECEnv/ParallelEnv rps examples made deterministic by fixing the setting of the RNG seed (#1277).
- Items used in the library were not explicitly exported and now are (#1283).
- build-publish workflow fixed (#1293).
Documentation updates
- Observation type in parallel_rps doc example was corrected (#1170).
- Observation space documentation in simple_adversary.py was corrected (#1189).
- Documentation of the observation format in Simple World Comm was updated (#1212).
- Dead link fixed in Tianshou tutorial (#1214).
- Swapped colors in waterworld description fixed (#1210).
- Removing an erroneous paragraph in "About AEC" (#1247).
- Update PistonBall documentation (#1245).
- Fix Documentation to properly match/display the correct environment for Pong (#1257).
- AgileRL tutorials documentation updated for version 2.0.0 (#1258).
- Deprecation warnings added to MPE documentation (#1280).
New Contributors
- @dm-ackerman made their first contribution in #1157
- @mikepratt1 made their first contribution in #1196
- @JorasOliveira made their first contribution in #1201
- @pandyah5 made their first contribution in #1212
- @ajmeek made their first contribution in #1214
- @Zoraiyo made their first contribution in #1210
- @xihuai18 made their first contribution in #1217
- @florin-pop made their first contribution in #1218
- @mariojerez made their first contribution in #1239
- @MatthewSbar made their first contribution in #1234
- @Tanmay692004 made their first contribution in #1256
- @ema-pe made their first contribution in #1247
- @yjhan96 made their first contribution in #1263
- @anordin95 made their first contribution in #1245
- @kuds made their first contribution in #1257
- @zzbuzzard made their first contribution in #1276
Full Changelog: 1.24.3...1.25.0
Contributors
MatthewSbar, kuds, and 14 other contributors