Metadata-Version: 2.1
Name: ma-gym
Version: 0.0.7
Summary: A collection of multi agent environments based on OpenAI gym.
Home-page: https://github.com/koulanurag/ma-gym
Author: Anurag Koul
Author-email: koulanurag@gmail.com
License: MIT License
Description: # ma-gym
        It's a collection of multi agent environments based on OpenAI gym. Also, you can use [**minimal-marl**](https://github.com/koulanurag/minimal-marl) to warm-start training of agents.
        
        ![Python package](https://github.com/koulanurag/ma-gym/workflows/Python%20package/badge.svg) 
        ![Upload Python Package](https://github.com/koulanurag/ma-gym/workflows/Upload%20Python%20Package/badge.svg)
        [![Wiki Docs](https://img.shields.io/badge/-Wiki%20Docs-informational?style=flat)](https://github.com/koulanurag/ma-gym/wiki)
        
        
        ## Installation
        Using PyPI:
        ```bash
        pip install ma-gym
        ```
        
        Directly from source:
        ```bash
        git clone https://github.com/koulanurag/ma-gym.git
        cd ma-gym
        pip install -e .
        ```
        ## Reference:
        Please use this bibtex if you would like to cite it:
        ```
        @misc{magym,
              author = {Koul, Anurag},
              title = {ma-gym: Collection of multi-agent environments based on OpenAI gym.},
              year = {2019},
              publisher = {GitHub},
              journal = {GitHub repository},
              howpublished = {\url{https://github.com/koulanurag/ma-gym}},
            }
        ```
        
        ## Usage:
        ```python
        import gym
        
        env = gym.make('ma_gym:Switch2-v0')
        done_n = [False for _ in range(env.n_agents)]
        ep_reward = 0
        
        obs_n = env.reset()
        while not all(done_n):
            env.render()
            obs_n, reward_n, done_n, info = env.step(env.action_space.sample())
            ep_reward += sum(reward_n)
        env.close()
        ```
        
        Please refer to [**Wiki**](https://github.com/koulanurag/ma-gym/wiki/Usage) for complete usage details
        
        ## Environments:
        - [x] Checkers
        - [x] Combat
        - [x] PredatorPrey
        - [x] Pong Duel  ```(two player pong game)```
        - [x] Switch
        - [x] Lumberjacks
        - [x] TrafficJunction
        
        ```
        Note : openai's environment can be accessed in multi agent form by prefix "ma_".Eg: ma_CartPole-v0
        This returns an instance of CartPole-v0 in "multi agent wrapper" having a single agent. 
        These environments are helpful during debugging.
        ```
        
        Please refer to [Wiki](https://github.com/koulanurag/ma-gym/wiki/Environments) for more details.
        
        ## Zoo!
        
        | __Checkers-v0__ | __Combat-v0__ | __Lumberjacks-v0__ |
        |:---:|:---:|:---:|
        |![Checkers-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/Checkers-v0.gif)|![Combat-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/Combat-v0.gif)|![Lumberjacks-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/Lumberjacks-v0.gif)|
        | __PongDuel-v0__ | __PredatorPrey5x5-v0__ | __PredatorPrey7x7-v0__ |
        | ![PongDuel-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/PongDuel-v0.gif) | ![PredatorPrey5x5-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/PredatorPrey5x5-v0.gif) | ![PredatorPrey7x7-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/PredatorPrey7x7-v0.gif) |
        |                 __Switch2-v0__                 |                        __Switch4-v0__                         | __TrafficJunction4-v0__ |                                                             |
        |  ![Switch2-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/Switch2-v0.gif)  |         ![Switch4-v0.gif](https://raw.githubusercontent.com/koulanurag/ma-gym/master/static/gif/Switch4-v0.gif)|![TrafficJunction4-v0.gif](static/gif/TrafficJunction4-v0.gif)|
        | __TrafficJunction10-v0__ |
        |![TrafficJunction10-v0.gif](static/gif/TrafficJunction10-v0.gif)|         |                                                              |
        
        ## Testing:
        
        - Install: ```pip install -e ".[test]" ```
        - Run: ```pytest```
        
        
        ## Acknowledgement:
        - This project was initially developed to complement my research internship @ [SAS](https://www.sas.com/en_us/home.html) (Summer - 2019).
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: develop
Provides-Extra: all
