Skip to main content

Agent Based Simulation and MultiAgent Reinforcement Learning

Project description

Abmarl

Abmarl is a package for developing Agent-Based Simulations and training them with MultiAgent Reinforcement Learning (MARL). We provide an intuitive command line interface for engaging with the full workflow of MARL experimentation: training, visualizing, and analyzing agent behavior. We define an Agent-Based Simulation Interface and Simulation Manager, which control which agents interact with the simulation at each step. We support integration with popular reinforcement learning simulation interfaces, including gym.Env and MultiAgentEnv. We define our own GridWorld Simulation Framework for creating custom grid-based Agent Based Simulations.

Abmarl leverages RLlib’s framework for reinforcement learning and extends it to more easily support custom simulations, algorithms, and policies. We enable researchers to rapidly prototype MARL experiments and simulation design and lower the barrier for pre-existing projects to prototype RL as a potential solution.

Build and Test Badge Sphinx docs Badge Lint Badge

Quickstart

To use Abmarl, install via pip: pip install abmarl

To develop Abmarl, clone the repository and install via pip's development mode. Note: Abmarl requires python3.7 or python3.8.

git clone git@github.com:LLNL/Abmarl.git
cd abmarl
pip install -r requirements.txt
pip install -e . --no-deps

Train agents in a multicorridor simulation:

abmarl train examples/multi_corridor_example.py

Visualize trained behavior:

abmarl visualize ~/abmarl_results/MultiCorridor-2020-08-25_09-30/ -n 5 --record

Note: If you install with conda, then you must also include ffmpeg in your virtual environment.

Documentation

You can find the latest Abmarl documentation on our ReadTheDocs page.

Documentation Status

Community

Citation

DOI

Abmarl has been published to the Journal of Open Source Software (JOSS). It can be cited using the following bibtex entry:

@article{Rusu2021,
  doi = {10.21105/joss.03424},
  url = {https://doi.org/10.21105/joss.03424},
  year = {2021},
  publisher = {The Open Journal},
  volume = {6},
  number = {64},
  pages = {3424},
  author = {Edward Rusu and Ruben Glatt},
  title = {Abmarl: Connecting Agent-Based Simulations with Multi-Agent Reinforcement Learning},
  journal = {Journal of Open Source Software}
}

Reporting Issues

Please use our issue tracker to report any bugs or submit feature requests. Great bug reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce, sample code is best.
  • What you expected would happen
  • What actually happens

Contributing

Please submit contributions via pull requests from a forked repository. Find out more about this process here. All contributions are under the BSD 3 License that covers the project.

Release

LLNL-CODE-815883

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

abmarl-0.2.3.tar.gz (65.8 kB view details)

Uploaded Source

Built Distribution

abmarl-0.2.3-py3-none-any.whl (100.0 kB view details)

Uploaded Python 3

File details

Details for the file abmarl-0.2.3.tar.gz.

File metadata

  • Download URL: abmarl-0.2.3.tar.gz
  • Upload date:
  • Size: 65.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.7.9

File hashes

Hashes for abmarl-0.2.3.tar.gz
Algorithm Hash digest
SHA256 0d5e40ea2834a18852f41756e89e165632f90a5e69b1fbf0325e55ecf4a3d67d
MD5 e735bdf32763004a7a8fcead7635b6f8
BLAKE2b-256 c6c60d90e9366e354ae774e44f26ea30f473c048f04da0f70c98c541c7b901cd

See more details on using hashes here.

File details

Details for the file abmarl-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: abmarl-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 100.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.7.9

File hashes

Hashes for abmarl-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a8aa1f51c1b63d36ea8c70ca8d61a420dcdff06732248271d103d0bdc1f16829
MD5 544c5430e3784985b173983b4ef24953
BLAKE2b-256 5fba39a3c2727696121dbbb94773a67b6e638a4b930898c0034274a5ce300880

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page