This project contains code and a test environment to train neural networks against Super Mario Bros for NES. The project contains a forked version of the excellent open source OpenAI Gym for Super Mario Bros written by Philip Paquette.
The testbed works via the creation and launch of a Docker container which brings up several sub-systems:
- A VNC server which lets you access a desktop environment for the container (accessed on port 5900)
- A Wooey server which lets you launch headless training jobs within the container (accessed on port 8000)
Once launched you will be able to commence training your AI on Super Mario Bros!
To use the testbed you will need to have a unix based system (tested on ubuntu & macOS) and Docker installed. Once these requirements are met you will need to run the following command from the root of this repository:
$ make up
This will build and launch the container ready for use.
To close the container:
$ make down
To reset the running container simply run up again - this will automatically close any existing container before re-launching:
$ make up
To rebuild the container:
$ make clear && make up
NOTE: On creating the container the local train directory is shared within the container but any edits to the scripts contained within will not be propogated to Wooey until a relaunch of the container.
Please see the wiki for information on how to use the Training and Utility scripts.
Copyright (c) 2018 Joshua Beemster, Jasim Schluter, Loic Nyssen
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.