{"id":13689199,"url":"https://github.com/Farama-Foundation/SuperSuit","last_synced_at":"2025-05-01T23:32:51.118Z","repository":{"id":37716205,"uuid":"252030937","full_name":"Farama-Foundation/SuperSuit","owner":"Farama-Foundation","description":"A collection of wrappers for Gymnasium and PettingZoo environments (being merged into gymnasium.wrappers and pettingzoo.wrappers","archived":false,"fork":false,"pushed_at":"2024-09-03T21:34:00.000Z","size":1118,"stargazers_count":447,"open_issues_count":3,"forks_count":56,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-09-14T07:53:19.754Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Farama-Foundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"Farama-Foundation"}},"created_at":"2020-04-01T00:27:34.000Z","updated_at":"2024-09-11T12:18:51.000Z","dependencies_parsed_at":"2024-03-13T19:30:19.576Z","dependency_job_id":"19ef8c56-6422-4760-b458-452c3addd5ae","html_url":"https://github.com/Farama-Foundation/SuperSuit","commit_stats":{"total_commits":618,"total_committers":25,"mean_commits":24.72,"dds":0.4579288025889967,"last_synced_commit":"d47a9f6a3d3c1d4632b260b850f5cfe5319c8cfe"},"previous_names":[],"tags_count":32,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Farama-Foundation%2FSuperSuit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Farama-Foundation%2FSuperSuit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Farama-Foundation%2FSuperSuit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Farama-Foundation%2FSuperSuit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Farama-Foundation","download_url":"https://codeload.github.com/Farama-Foundation/SuperSuit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224282179,"owners_count":17285783,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T15:01:37.819Z","updated_at":"2024-11-12T13:31:02.520Z","avatar_url":"https://github.com/Farama-Foundation.png","language":"Python","funding_links":["https://github.com/sponsors/Farama-Foundation"],"categories":["Industry Strength RL","Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/Farama-Foundation/SuperSuit/master/supersuit-text.png\" width=\"500px\"/\u003e\n\u003c/p\u003e\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFarama-Foundation%2FSuperSuit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFarama-Foundation%2FSuperSuit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFarama-Foundation%2FSuperSuit/lists"}