<p align="center">
<img src="https://raw.githubusercontent.com/Farama-Foundation/SuperSuit/master/supersuit-text.png" width="500px"/>
</p>
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}
}
```
Raw data
{
"_id": null,
"home_page": "",
"name": "SuperSuit",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.12,>=3.8",
"maintainer_email": "",
"keywords": "Reinforcement Learning,game,RL,AI,gymnasium",
"author": "",
"author_email": "Farama Foundation <contact@farama.org>",
"download_url": "https://files.pythonhosted.org/packages/29/8d/a083a76e6d2c0436acca4a8e519842924eba690c328646451b0683576320/SuperSuit-3.9.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://raw.githubusercontent.com/Farama-Foundation/SuperSuit/master/supersuit-text.png\" width=\"500px\"/>\n</p>\n\n\nSuperSuit introduces a collection of small functions which can wrap reinforcement learning environments to do preprocessing ('microwrappers').\nWe support Gymnasium for single agent environments and PettingZoo for multi-agent environments (both AECEnv and ParallelEnv environments).\n\n\nUsing it with Gymnasium to convert space invaders to have a grey scale observation space and stack the last 4 frames looks like:\n\n```\nimport gymnasium\nfrom supersuit import color_reduction_v0, frame_stack_v1\n\nenv = gymnasium.make('SpaceInvaders-v0')\n\nenv = frame_stack_v1(color_reduction_v0(env, 'full'), 4)\n```\n\nSimilarly, using SuperSuit with PettingZoo environments looks like\n\n```\nfrom pettingzoo.butterfly import pistonball_v0\nenv = pistonball_v0.env()\n\nenv = frame_stack_v1(color_reduction_v0(env, 'full'), 4)\n```\n\n\n**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.\n\n## Installing SuperSuit\nTo install SuperSuit from pypi:\n\n```\npython3 -m venv env\nsource env/bin/activate\npip install --upgrade pip\npip install supersuit\n```\n\nAlternatively, to install SuperSuit from source, clone this repo, `cd` to it, and then:\n\n```\npython3 -m venv env\nsource env/bin/activate\npip install --upgrade pip\npip install -e .\n```\n\n## Citation\n\nIf you use this in your research, please cite:\n\n```\n@article{SuperSuit,\n Title = {SuperSuit: Simple Microwrappers for Reinforcement Learning Environments},\n Author = {Terry, J. K and Black, Benjamin and Hari, Ananth},\n journal={arXiv preprint arXiv:2008.08932},\n year={2020}\n}\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Wrappers for Gymnasium and PettingZoo",
"version": "3.9.2",
"project_urls": {
"Bug Report": "https://github.com/Farama-Foundation/SuperSuit/issues",
"Homepage": "https://farama.org",
"Repository": "https://github.com/Farama-Foundation/SuperSuit"
},
"split_keywords": [
"reinforcement learning",
"game",
"rl",
"ai",
"gymnasium"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b0eafc12e259b81b3f49e43aa8e8722477ee32d5000d8bd45c62615f76d7faa",
"md5": "18d74d1e5ca62f020631efdc1cf23b57",
"sha256": "1dcecd419100eeed19c51444a341dd7ab14deaf3cd775ba475de4e63eba6159c"
},
"downloads": -1,
"filename": "SuperSuit-3.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18d74d1e5ca62f020631efdc1cf23b57",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.8",
"size": 50160,
"upload_time": "2024-01-18T19:16:55",
"upload_time_iso_8601": "2024-01-18T19:16:55.817493Z",
"url": "https://files.pythonhosted.org/packages/8b/0e/afc12e259b81b3f49e43aa8e8722477ee32d5000d8bd45c62615f76d7faa/SuperSuit-3.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "298da083a76e6d2c0436acca4a8e519842924eba690c328646451b0683576320",
"md5": "c463ab58ddc8d468e2f046f95e5f40e6",
"sha256": "60e384fe63ab6752acbfc34f991f48d6346592b1dd3475138e3599ab41eaaf24"
},
"downloads": -1,
"filename": "SuperSuit-3.9.2.tar.gz",
"has_sig": false,
"md5_digest": "c463ab58ddc8d468e2f046f95e5f40e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.8",
"size": 34242,
"upload_time": "2024-01-18T19:16:57",
"upload_time_iso_8601": "2024-01-18T19:16:57.936542Z",
"url": "https://files.pythonhosted.org/packages/29/8d/a083a76e6d2c0436acca4a8e519842924eba690c328646451b0683576320/SuperSuit-3.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 19:16:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Farama-Foundation",
"github_project": "SuperSuit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "supersuit"
}
JSON
