Skip to content

Latest commit

 

History

History
162 lines (118 loc) · 5.22 KB

README.md

File metadata and controls

162 lines (118 loc) · 5.22 KB
Raw

Pommerman C++ Environment

Note: This repository is officially discontinued. The new version pomcpp2 is being developed by Jannis Weil. His implementation adds new features and fixes several bugs.

This repository is an open-source re-implementation of the Pommerman multi-agent RL environment. Its aim is to provide a blazing fast alternative to the current python backend - ideally to make computationally expensive methods like tree search a feasible. The simulation has no heap allocations. This is how the C++ side currently looks like.

gif of the game

Contributors

Special thanks to Márton Görög (gorogm) for providing insights, bug fixes and crucial test cases.

Prerequisites

To compile and run this project from source you will require

  • Linux Distribution (Tested on Ubuntu 18.04)
  • GCC 7.3.0
  • MAKE 4.1

Setup

Download

To fully clone the repository use

# git version 2.13+
$ git clone --recurse-submodules https://github.com/m2q/nips2018-agent.git

# git version 2.12 or less
$ git clone --recursive https://github.com/m2q/nips2018-agent.git

Compilation

Instead of using the shell scripts you can obviously use make commands and call/debug the binaries yourself. Here is a list:

Command What it does
make or make all Compiles and links both test and main source files and creates a static library
make main Compiles the main source to ./bin/exec and creates a library in ./lib/pomlib.a
make test Compiles the test source to ./bin/test
make clean Removes ./bin and ./build
make mclean Removes ./bin/exec and ./build/src only

Tip: The makefile makes use of the MAKEFLAGS environment variable. Let's say you want to have -j n as the default job count, where n is the number of cores available on your system. Then just export an env variable like this

$ export MAKEFLAGS="-j $(grep -c ^processor /proc/cpuinfo)"

(or alternatively add it to your ${HOME}.profile)

Use PommermanC++ as a Static Library

Building the project with make compiles a static library in ./lib/pomlib.a. This contains the bboard and agents namespace. Include the headers in ./src/... and you're good to go.

Project Structure

All of the main source code is in src/* and all testing code is in unit_test/*. The source is divided into modules

src
 |
 |_ _ _ bboard
 |        |_ _ _ bboard.hpp
 |        |_ _ _ ..
 |
 |_ _ _ agents
 |        |_ _ _ agents.hpp
 |        |_ _ _ ..
 |
 |_ _ _ main.cpp

All environment specific functions (forward, board init, board masking etc) reside in bboard. Agents can be declared in the agents header and implemented in the same module.

All test cases will be in the module unit_test. The bboard should be tested thoroughly so it exactly matches the specified behaviour of Pommerman. The compiled test binary can be found in /bin

Testing

Want to test out how many steps can be simulated on your machine in 100ms?

# example of 4 threads on an Intel i5 (Skylake/4 cores)
$ ./performance.sh -t 4 

Activated Multi-Threading for performance tests. 
	Thread count:            4
	Max supported threads:   4

Test Results:
Iteration count (100ms):         586.332
Tested with:                     agents::HarmlessAgent

===============================================================================
All tests passed (1 assertion in 1 test case)

You can also directly run the test-binaries. For a list of command line arguments see the Catch2 CLI docs (or run ./test --help). Here are some typical examples I use a lot:

Command What it does
./test Runs all tests, including a performance report
./test "[step function]" Tests only the step function
./test ~"[performance]" Runs all test except the performance cases

Defining Agents

To create a new agent you can use the base struct defined in bboard.hpp. To add your own agent, declare it in agents/agents.hppand provide a source file in the same module. For example:

agents.hpp (excerpt)

/**
 * @brief Uses a hand-crafted FSM with stochastic noise
 */
struct MyNewAgent : bboard::Agent
{
    bboard::Move act(const bboard::State* state) override;
};

fsm_agent.cpp

#include "bboard.hpp"
#include "agents.hpp"

namespace agents
{

bboard::Move MyNewAgent::act(const bboard::State* state)
{
    // TODO: Implement your logic
    return bboard::Move::IDLE;
}

}

Citing This Repo

If you end up modifiying pomcpp in a significant way, e.g. by adding major functionality, you may change the order of authors and make yourself first author - as long as I'm included in the list of authors. An example of this is pomcpp2.

@misc{Alic2018,
  author = {Alic, Adrian},
  title = {Pommerman C++ Implementation},
  year = {2018},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/m2q/nips2018-agent}}
}