xinyingking / marllib Goto Github PK

Multi-Agent RLlib (MARLlib) is a MARL benchmark based on Ray and one of its toolkits RLlib. It provides MARL research community a unified platform for developing and evaluating the new ideas in various multi-agent environments. There are four core features of MARLlib.

• it collects most of the existing MARL algorithms that are widely acknowledged by the community and unifies them under one framework.
• it gives a solution that enables different multi-agent environments using the same interface to interact with the agents.
• it guarantees great efficiency in both the training and sampling process.
• it provides trained results including learning curves and pretrained models specific to each task and each algorithm's combination, with finetuned hyper-parameters to guarantee credibility.

Project Website: https://sites.google.com/view/marllib/home

The README is organized as follows:

• I. Overview
• II. Environment
• III. Algorithm
• IV. Getting started & Examples
• V. Contribute New Environment
• VI. Bug Shooting

We collected most of the existing multi-agent environment and multi-agent reinforcement learning algorithms and unify them under one framework based on Ray 's RLlib to boost the MARL research.

The common MARL baselines include independence learning (IQL, A2C, DDPG, TRPO, PPO), centralized critic learning (COMA, MADDPG, MAPPO, HATRPO), and value decomposition (QMIX, VDN, FACMAC, VDA2C) are all implemented.

The popular MARL environments like SMAC, MaMujoco, Google Research Football are all provided with a unified interface.

The algorithm code and environment code are fully separated. Changing the environment needs no modification on the algorithm side and vice versa.

Here we provide a table for comparison of MARLlib and before benchmarks.

Benchmark	Github Stars	Learning Mode	Available Env	Algorithm Type	Algorithm Number	Continues Control	Asynchronous Interact	Distributed Training	Framework	Last Update
PyMARL		CP	1	VD	5				*
PyMARL2		CP	1	VD	12				PyMARL
MARL-Algorithms		CP	1	VD+Comm	9				*
EPyMARL		CP	4	IL+VD+CC	10				PyMARL
Marlbenchmark		CP+CL	4	VD+CC	5	✔️			pytorch-a2c-ppo-acktr-gail
MARLlib		CP+CL+CM+MI	10	IL+VD+CC	18	✔️	✔️	✔️	Ray/RLlib

CP, CL, CM, and MI represent for cooperative, collaborative, competitive, and mixed task learning mode respectively. IL, VD, and CC represent for independent learning, value decomposition, and centralized critic categorization. Comm represents communication-based learning. Asterisk denotes that the benchmark uses its framework.

The tutorial of RLlib can be found at this link. Fast examples can be found at this link. These will help you easily dive into RLlib.

We hope everyone interested in MARL can be benefited from MARLlib.

Most of the popular environment in MARL research has been incorporated in this benchmark:

Each environment has a readme file, standing as the instruction for this task, talking about env settings, installation, and some important notes.

We provide three types of MARL algorithms as our baselines including:

Independent Learning: IQL DDPG PG A2C TRPO PPO

Centralized Critic: COMA MADDPG MAAC MAPPO MATRPO HATRPO HAPPO

Value Decomposition: VDN QMIX FACMAC VDAC VDPPO

Here is a chart describing the characteristics of each algorithm:

Current Task & Available algorithm mapping: Y for available, N for not suitable, P for partially available on some scenarios. (Note: in our code, independent algorithms may not have I as prefix. For instance, PPO = IPPO)

Install Ray

pip install ray==1.8.0 # version sensitive

Add patch of MARLlib

cd patch
python add_patch.py

Y to replace source-packages code

Attention: Above is the common installation. Each environment needs extra dependency. Please read the installation instruction in envs/base_env/install.

Examples

python marl/main.py --algo_config=MAPPO [--finetuned] --env-config=smac with env_args.map_name=3m

--finetuned is optional, force using the finetuned hyperparameter

We provide an introduction to the code directory to help you get familiar with the codebase:

• top level directory structure

This picture is in image/code-MARLlib.png

• MARL directory structure

This picture is in image/code-MARL.png.png

• ENVS directory structure

This picture is in image/code-ENVS.png.png

MARLlib is designed to be friendly to incorporate new environment. Besides the ten we already implemented, we support nearly all kinds of MARL environments. Before the contribution, you need to know:

Things you have to do:

• provide a new environment interface python file, follow the style of MARLlib/envs/base_env
• provide a corresponding config yaml file, follow the style of MARLlib/envs/base_env/config
• provide a corresponding instruction readme file, follow the style of MARLlib/envs/base_env/install

Things you do not have to do:

• modify the MARLlib data processing pipeline
• provide a unique runner or controller
• worry about the data logging

As the ten environments we already included have covered such a great diversity in action space, observation space, agent-env interact style, task mode, additional information like action mask, etc. The best practice to incorporate your own environment is find an existing similar one and provide a same interface.

Most RLlib related error on MARL are fixed by our patch file.

Here we only list the common bugs not RLlib related. (Mostly is your mistake)

• observation/action out of space bug:

  • make sure the observation/action space defined in env init function
    • has same data type with env returned data (e.g., float32/64)
    • env returned data range is in the space scope (e.g., box(-2,2))
  • the returned env observation contained the required key (e.g., action_mask/state)

• Action NaN is invaild bug

  • this is common bug espectially in continues control problem, carefully finetune the algorithm's hyperparameter
    • smaller learning rate
    • set some action value bound

The MIT License