Skip to content

Releases: Farama-Foundation/SuperSuit

Supersuit 3.9.3

12 Aug 16:00
758f1c3
Compare
Choose a tag to compare

Adds support for Python 3.12

Full Changelog: 3.9.2...3.9.3

SuperSuit 3.9.2

18 Jan 19:15
07f4d3a
Compare
Choose a tag to compare

SuperSuit 3.9.2 Release Notes

This is a minor hotfix release addressing a small rendering bug in the SB3 wrapper, and a bug with the agent indicator wrapper causing NaN values in observations.

Bug Fixes

  • Fix render_mode attribute not being set by sb3 wrapper (#243)
  • Fix agent indicator inf bounded spaces (#240)

Contributors

This release includes contributions from: @KaleabTessera and @elliottower

Many thanks to our contributors, as well as many past contributors who have made this possible. We would also like to thank everyone who has helped out with bug reports or feature suggestions, which are critical to our development. We are always welcoming new contributors, if you are interested please join our Discord server at https://discord.gg/nhvKkYa6qX

Full Changelog: 3.9.1...3.9.2

SuperSuit 3.9.1

28 Nov 17:10
035cf0f
Compare
Choose a tag to compare

SuperSuit 3.9.1 Release Notes

This is a minor hotfix release addressing some small bugs in rendering, info returns, and an issue with the frame skip wrapper not inheriting the correct np random attribute from the underlying environment.

Bug Fixes

  • Fix frame skip wrapper np random attribute (#235)
  • Fix render_mode for ProcConcatVec envs (#236, #234)
  • fix: have access to terminal_observation in infos for pettingzoo_env_to_vec_env_v1 and MarkovVectorEnv (#233)

Full Changelog: 3.9.0...3.9.1

SuperSuit 3.9.0

21 Jul 00:44
dc4dc8a
Compare
Choose a tag to compare

SuperSuit 3.9.0 Release Notes:

This release fixes a number of issues related to SB3 vector environments, ensuring full compatibility with PettingZoo and Gymnasium. It also adds support for action masked environments, using gymnasium wrappers (e.g., NormalizeObservation) on vector environments, and adds Python 3.11 support. Support for Python 3.7 has been removed as it has reached end-of-life (link). This release also ensures compatibility with the most recent Gymnasium 0.29.0 and PettingZoo 1.24.0, which is being released alongside this release.

Breaking Changes

  • Remove python 3.7 support in favor of 3.11 (#225)

New Features and Improvements:

  • Add full action masking support, expand and refactor testing (#227)
  • Add test to check that Gymnasium wrappers work on vector envs (#230)

Note: Gymnasium wrappers must be applied before SB3 wrappers, as the return values on reset() are different.

The following code will raise an error:

env = ss.concat_vec_envs_v1(env, 10, base_class="stable_baselines3")
env = normalize.NormalizeObservation(env)

To fix this, normalize before concatenating:

env = normalize.NormalizeObservation(env)
env = ss.concat_vec_envs_v1(env, 10, base_class="stable_baselines3")

Bug Fixes:

  • Fix SB3 wrapper and ProcConcatVec not returning info (#224)
  • Fix SB3 wrapper to match DummyVecEnv reset() method (#226)
  • Fix SB3 wrapper render() method signature mismatched with SB3 superclass VecEnvWrapper (#228)

Full Changelog: 3.8.1...3.9.0

SuperSuit 3.8.1

07 Jul 23:49
9b26d8c
Compare
Choose a tag to compare

SuperSuit 3.8.0 Release Notes:

This is a minor release fixing issues related to vector environments, for use with PettingZoo and Stable-Baselines3.

Bug Fixes:

  • Fix SB3VecEnvWrapper and ProcConcatVec to work with SB3 v2.0.0 (#218)
  • Fix ProcConcatVec not terminating all threads/processes when calling close() (#219)

Full Changelog: 3.8.0...3.8.1

SuperSuit 3.8.0

15 May 21:02
3d59c9e
Compare
Choose a tag to compare

SuperSuit 3.8.0 Release Notes:

This release makes SuperSuit compatible with PettingZoo 1.23.0 and Gymnasium 0.28.1, fully removing the return_info argument of the reset() function, in order to make the API fully consistent with Gymnasium.

Breaking changes:

  • Fully remove return_info option on reset(), update code to work with PettingZoo 1.23.0 (#214)
    • Older versions of PettingZoo must be updated to 1.23.0 or higher
    • Older versions of Gymnasium must be updated to 0.28.1 or higher

Bug Fixes:

  • Add tinyscaler requirement (#211)

Full Changelog: 3.7.2...3.8.0

3.7.2

20 Mar 14:49
8ea718f
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: 3.7.1...3.7.2

3.7.1

02 Jan 15:33
116d739
Compare
Choose a tag to compare

What's Changed

[experimental] Python 3.11 support

Full Changelog: 3.7.0...3.7.1

3.7.0

07 Oct 22:26
ac2a251
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: 3.6.0...3.7.0

3.6.0

24 Sep 15:45
9b66138
Compare
Choose a tag to compare

What's Changed

  1. As part of the Gym update to 0.26, the following change has been made:
    • done -> termination and truncation: The singular done signal has been changed to a termination and truncation signal, where termination dictates that the environment has ended due to meeting certain conditions, and truncation dictates that the environment has ended due to exceeding the time/frame limit.
  2. Deprecated ConcatVecEnv and ProcConcatVecEnv because they were buggy.
  3. General bug fixes.

List of Changes

New Contributors

Full Changelog: 3.5.0...3.6.0