Skip to content

Folder structure

Claudio Bonesana edited this page Apr 14, 2021 · 2 revisions

The project has two main folders: a code folder and a docs folder.

In the root folder there are the files used to build the Docker images.

All documentation files, like this document, and the source files needed to generate the LaTeX -based documents (same content of this wiki, probable not updated) are stored in the docs folder.

The folder code contains all the source code of the software. This folder is structured as a Python package. In the file requirements.txt it is possible to find a list of all the libraries and packages required to use this software. The code is structured as following:

  • agents package contains everything related to the agents;
  • config is a folder that contains the configuration files used by the latest version of the game;
  • core package contains all the scripts required to run the basic game;
  • models is a folder where are stored all the models used by ML-based agents;
  • notebooks is a folder containing all the Jupyter Notebooks used for the analysis and development of the ML-based gents;
  • tests is a package with all the unit tests;
  • utils package contains some utility scripts and libraries; and
  • web contains all the code needed to run the Web User Interface (Web-UI).

Clone this wiki locally