Skip to main content

PyPI version Tests pre-commit Code style: black

Aug 11, 2025: This project is semi-depricated, and is unmaintained except for being kept operational with new versions of PettingZoo until the relevant functionality can be merged into pettingzoo.wrappers.

SuperSuit introduces a collection of small functions which can wrap reinforcement learning environments to do preprocessing ('microwrappers'). We support Gymnasium for single agent environments and PettingZoo for multi-agent environments (both AECEnv and ParallelEnv environments).

Using it with Gymnasium to convert space invaders to have a grey scale observation space and stack the last 4 frames looks like:

import gymnasium
from supersuit import color_reduction_v0, frame_stack_v1

env = gymnasium.make('SpaceInvaders-v0')

env = frame_stack_v1(color_reduction_v0(env, 'full'), 4)

Similarly, using SuperSuit with PettingZoo environments looks like

from pettingzoo.butterfly import pistonball_v0
env = pistonball_v0.env()

env = frame_stack_v1(color_reduction_v0(env, 'full'), 4)

Please note: Once the planned wrapper rewrite of Gymnasium is complete and the vector API is stabilized, this project will be deprecated and rewritten as part of a new wrappers package in PettingZoo and the vectorized API will be redone, taking inspiration from the functionality currently in Gymnasium.

Installing SuperSuit

To install SuperSuit from pypi:

python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install supersuit

Alternatively, to install SuperSuit from source, clone this repo, cd to it, and then:

python3 -m venv env
source env/bin/activate
pip install --upgrade pip
pip install -e .

Citation

If you use this in your research, please cite:

@article{SuperSuit,
  Title = {SuperSuit: Simple Microwrappers for Reinforcement Learning Environments},
  Author = {Terry, J. K and Black, Benjamin and Hari, Ananth},
  journal={arXiv preprint arXiv:2008.08932},
  year={2020}
}

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

supersuit-3.11.0.tar.gz (34.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

supersuit-3.11.0-py3-none-any.whl (50.6 kB view details)

Uploaded Python 3

File details

Details for the file supersuit-3.11.0.tar.gz.

File metadata

  • Download URL: supersuit-3.11.0.tar.gz
  • Upload date:
  • Size: 34.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for supersuit-3.11.0.tar.gz
Algorithm Hash digest
SHA256 fbf1aff42bd084945aa86205af750b6cf5e7bbd864ddcd61d90142267a96afae
MD5 89b41b4bebe2a959043872da9a588bf7
BLAKE2b-256 16a17b807a152e4d4ad2fb5ac1b34300adbfc64f3cd30e23a79a46412e0804d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for supersuit-3.11.0.tar.gz:

Publisher: build-publish.yml on Farama-Foundation/SuperSuit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file supersuit-3.11.0-py3-none-any.whl.

File metadata

  • Download URL: supersuit-3.11.0-py3-none-any.whl
  • Upload date:
  • Size: 50.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for supersuit-3.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8cbbe27d79c427eaa90102b866673cbb03812f652c36fc7985029bffdb0c587
MD5 34c82d46c12c6705d605a555e2c61374
BLAKE2b-256 6d46c8bfcd9b193fd7a452a10c5086b2c633dacfadd15524473615152e818267

See more details on using hashes here.

Provenance

The following attestation bundles were made for supersuit-3.11.0-py3-none-any.whl:

Publisher: build-publish.yml on Farama-Foundation/SuperSuit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

3.11.0 This release

2 files

3.10.0

2 files

3.9.3

2 files

3.9.2

2 files

3.9.1

2 files

3.9.0

2 files

3.8.1

2 files

3.8.0

2 files

3.7.2

2 files

3.7.1

2 files

3.7.0

2 files

3.6.0

2 files

3.5.0

2 files

3.4.0

2 files

3.3.5

1 file

3.3.4

1 file

3.3.3

1 file

3.3.2

1 file

3.3.1

1 file

3.3.0

1 file

3.2.0

1 file

3.1.0

1 file

3.0.1

1 file

3.0.0

1 file

2.6.6

1 file

2.6.5

1 file

2.6.4

1 file

2.6.3

1 file

2.6.2

1 file

2.6.1

1 file

2.6.0

1 file

2.5.1

1 file

2.5.0

1 file

2.4.0

1 file

2.3.1

1 file

2.3.0

1 file

2.2.0

1 file

2.1.1

1 file

2.1.0

1 file

2.0.2

1 file

2.0.1

1 file

2.0.0

1 file

1.2.0

1 file

1.1.2

1 file

1.1.1

1 file

1.1.0

1 file

1.0.0

1 file

0.2.3

1 file

0.2.2

1 file

0.2.1

1 file

0.1.13

1 file

0.1.12

1 file

0.1.11

1 file

0.1.10

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page