Columbus/README.md
2022-07-01 12:05:41 +02:00

26 lines
912 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Project Columbus
<p align='center'>
<img src='./icon.svg'>
</p>
Project Columbus is a framework for trivial 2D OpenAI Gym environments that are supposed to test a agents ability to solve tasks that require different forms of exploration effectively and efficiently.
## Installation
´´´
pip install -e .
´´´
### env.py
![Screenshot](./img_README.png)
Contains the ColumbusEnv. New envs are implemented by subclassing ColumbusEnv and expanding _init_ and overriding _setup_.
### entities.py
Contains all implemented entities (e.g. the Agent, Rewards and Enemies)
### observables.py
Contains all 'oberservables'. These are attached to envs to define what kind of output is given to the agent. This way environments can be designed independently from the observation machanism that is used by the agent to play it.
### humanPlayer.py
Allows environments to be played by a human using mouse input.