Welcome to ZPI’s documentation!

Our project is framework which allows to play various games using various models

Please see the links below to check how our project works

• Translator Documentation
  • Description
  • Functionality
  • Structure of the Translator
    • Methods
• API Documentation
  • Description
  • Main file (main.py)
  • Runner class (runner.py)
  • Actions
    • get_response
    • make_move
• Reinforcement Learning Framework Documentation
  • Description
  • Functionality
  • Structure of the Reinforcement Learning Framework
    • Algorithms Module Structure
      • Algorithm
        • Methods
      • modules
        • SimpleNet - example of neural network
      • AlgorithmManager
        • Methods
      • Config
        • Methods
      • States
      • ParameterType
      • Parameter
    • API Module Structure
      • main
      • Endpoints
      • Runner
        • Methods
      • GameResults
        • Methods
      • GameState
    • Logger Module Structure
      • Logger
        • Methods
      • LogLevel
      • LogType
• Visualization Model Documentation
  • Description
  • Endpoints
    • 1. Send data to visualization
    • 2. Visualization
• How to setup the framework
  • Prerequisites
  • Setup
    • Setup (manual)
      • API setup
      • RL setup
      • Frontend setup
      • Visualisation setup
    • Setup (Docker Compose)