Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/Farama-Foundation/Shimmy

An API conversion tool for popular external reinforcement learning environments
https://github.com/Farama-Foundation/Shimmy

deepmind-control-suite deepmind-lab gym-environment gymnasium reinforcement-learning

Last synced: 2 months ago
JSON representation

An API conversion tool for popular external reinforcement learning environments

Host: GitHub
URL: https://github.com/Farama-Foundation/Shimmy
Owner: Farama-Foundation
License: mit
Created: 2022-10-06T21:24:05.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-03-20T11:48:19.000Z (4 months ago)
Last Synced: 2024-04-27T18:04:17.647Z (3 months ago)
Topics: deepmind-control-suite, deepmind-lab, gym-environment, gymnasium, reinforcement-learning
Language: Python
Homepage: https://shimmy.farama.org
Size: 27.5 MB
Stars: 115
Watchers: 7
Forks: 18
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.rst
- Citation: CITATION.cff

Lists

awesome-python-data-science - Shimmy - An API conversion tool for popular external reinforcement learning environments. (Reinforcement Learning / Others)

README

        [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8140744.svg)](https://doi.org/10.5281/zenodo.8140744)



    



Shimmy is an API conversion tool providing [Gymnasium](https://github.com/farama-Foundation/gymnasium) and [PettingZoo](https://github.com/farama-Foundation/pettingZoo/) bindings for popular external reinforcement learning environments.

The documentation website is at [shimmy.farama.org](https://shimmy.farama.org/) and we have a public discord server (which we also use to coordinate development work) that you can join here: https://discord.gg/nhvKkYa6qX

## Supported APIs

### [OpenAI Gym](http://shimmy.farama.org/contents/gym/)

- Bindings to convert [OpenAI Gym](https://github.com/openai/gym) environments to [Gymnasium](https://gymnasium.farama.org/).

### [Atari Environments for OpenAI Gym](http://shimmy.farama.org/contents/atari/)

- Bindings to convert [ALE-py](https://github.com/mgbellemare/Arcade-Learning-Environment) Atari environments to [Gymnasium](https://gymnasium.farama.org/).

### [DeepMind Control](http://shimmy.farama.org/contents/dm_control/)

- Bindings to convert [DM Control](https://github.com/deepmind/dm_control/) environments to [Gymnasium](https://gymnasium.farama.org/).

### [DeepMind Control: Multi-Agent](http://shimmy.farama.org/contents/dm_multi/)

- Bindings to convert [DM Control Soccer](https://github.com/deepmind/dm_control/blob/main/dm_control/locomotion/soccer/README.md) environments to [PettingZoo](https://pettingzoo.farama.org/).

### [DMLab](http://shimmy.farama.org/contents/dm_lab/)

- Bindings to convert [DM Lab](https://github.com/deepmind/lab) environments to [PettingZoo](https://pettingzoo.farama.org/).

### [OpenSpiel](shimmy.farama.org/contents/open_spiel/)

- Bindings to convert [OpenSpiel](https://github.com/deepmind/open_spiel) environments to [PettingZoo](https://pettingzoo.farama.org/).

### [Behavior Suite](http://shimmy.farama.org/contents/bsuite/)

- Bindings to convert [Behavior Suite](https://github.com/deepmind/bsuite) environments to [Gymnasium](https://gymnasium.farama.org/).

### [Melting Pot](http://shimmy.farama.org/contents/meltingpot/)

- Bindings to convert [Melting Pot](https://github.com/deepmind/meltingpot) environments to [PettingZoo](https://pettingzoo.farama.org/).

## Installation and Usage

To install Shimmy from [PyPI](https://pypi.org/):

```

pip install shimmy

```

To install required dependencies for environments, specify them as follows:

```

pip install shimmy[bsuite, atari]

```

Choices: `gym-v21`, `gym-v26`, `atari`, `bsuite`, `dm-control`, `dm-control-multi-agent`, `openspiel`, `meltingpot`

For development and testing:

```

pip install shimmy[all, testing]

```

## At a glance

This is an example of using Shimmy to convert DM Control environments into a Gymnasium compatible environment:

```python

import gymnasium as gym

from shimmy.registration import DM_CONTROL_SUITE_ENVS

env_ids = [f"dm_control/{'-'.join(item)}-v0" for item in DM_CONTROL_SUITE_ENVS]

print(env_ids)

env = gym.make(env_ids[0])

env_flatten = gym.wrappers.FlattenObservation(env)

print(env_ids[0])

print("===🌎", env.observation_space)

print("===🕹️", env.action_space)

print("---flattened 🌎", env_flatten.observation_space)

print("---flattened 🕹️", env_flatten.action_space)

```

```bash

['dm_control/acrobot-swingup-v0', 'dm_control/acrobot-swingup_sparse-v0', 'dm_control/ball_in_cup-catch-v0', 'dm_control/cartpole-balance-v0', 'dm_control/cartpole-balance_sparse-v0', 'dm_control/cartpole-swingup-v0', 'dm_control/cartpole-swingup_sparse-v0', 'dm_control/cartpole-two_poles-v0', 'dm_control/cartpole-three_poles-v0', 'dm_control/cheetah-run-v0', 'dm_control/dog-stand-v0', 'dm_control/dog-walk-v0', 'dm_control/dog-trot-v0', 'dm_control/dog-run-v0', 'dm_control/dog-fetch-v0', 'dm_control/finger-spin-v0', 'dm_control/finger-turn_easy-v0', 'dm_control/finger-turn_hard-v0', 'dm_control/fish-upright-v0', 'dm_control/fish-swim-v0', 'dm_control/hopper-stand-v0', 'dm_control/hopper-hop-v0', 'dm_control/humanoid-stand-v0', 'dm_control/humanoid-walk-v0', 'dm_control/humanoid-run-v0', 'dm_control/humanoid-run_pure_state-v0', 'dm_control/humanoid_CMU-stand-v0', 'dm_control/humanoid_CMU-run-v0', 'dm_control/lqr-lqr_2_1-v0', 'dm_control/lqr-lqr_6_2-v0', 'dm_control/manipulator-bring_ball-v0', 'dm_control/manipulator-bring_peg-v0', 'dm_control/manipulator-insert_ball-v0', 'dm_control/manipulator-insert_peg-v0', 'dm_control/pendulum-swingup-v0', 'dm_control/point_mass-easy-v0', 'dm_control/point_mass-hard-v0', 'dm_control/quadruped-walk-v0', 'dm_control/quadruped-run-v0', 'dm_control/quadruped-escape-v0', 'dm_control/quadruped-fetch-v0', 'dm_control/reacher-easy-v0', 'dm_control/reacher-hard-v0', 'dm_control/stacker-stack_2-v0', 'dm_control/stacker-stack_4-v0', 'dm_control/swimmer-swimmer6-v0', 'dm_control/swimmer-swimmer15-v0', 'dm_control/walker-stand-v0', 'dm_control/walker-walk-v0', 'dm_control/walker-run-v0']

dm_control/acrobot-swingup-v0

===🌎 Dict('orientations': Box(-inf, inf, (4,), float64), 'velocity': Box(-inf, inf, (2,), float64))

===🕹️ Box(-1.0, 1.0, (1,), float64)

---flattened 🌎 Box(-inf, inf, (6,), float64)

---flattened 🕹️ Box(-1.0, 1.0, (1,), float64)

```

See [Basic Usage](https://shimmy.farama.org/content/basic_usage/) for more information.

## Project Maintainers

Project Manager: [Elliot Tower](https://github.com/elliottower/)

Core Contributors: [Jet Tai](https://github.com/jjshoots/), [Mark Towers](https://github.com/pseudo-rnd-thoughts/)

Maintenance for this project is also contributed by the broader Farama team: [farama.org/team](https://farama.org/team).

## Citation

If you use Shimmy in your research, please cite:

```

@software{jun_jet_tai_2023_8140744,

  author       = {Jun Jet Tai and

                  Mark Towers and

                  Elliot Tower},

  title        = {{Shimmy: Gymnasium and PettingZoo Wrappers for

                   Commonly Used Environments}},

  month        = jun,

  year         = 2023,

  publisher    = {Zenodo},

  version      = {v1.1.0},

  doi          = {10.5281/zenodo.8140744},

  url          = {https://doi.org/10.5281/zenodo.8140744}

}

```