ethical-gardeners 0.0.1

A RL environment for learning ethically-aligned behaviours

EthicalGardeners

EthicalGardeners is a PettingZoo multi-agent environment for simulating gardeners tending to a grid-world garden, including ethical considerations.

The goal is to make agents learn an ethically-aligned behaviour that includes and respects these considerations.

How to

Run

To launch the simulation with default settings, use the following command in a shell, with the current working directory being the project root:

python ethicalgardeners/main.py --config-name config

Run tests

Tests must be placed in the tests/ folder; files must follow the test_*.py naming convention to be detected by unittest.

To run the tests, use the following command in a shell, with the current working directory being the project root:

python -m unittest tests/test_*.py

Build the docs

Documentation can be found in the docs/ folder, and is built using Sphinx. A quick command to build the documentation in the HTML format is:

cd docs/
make html

Then, open the build/html/index.html file in your favorite browser to read the rendered docs.

Documentation has its own requirements, which can be installed with

pip install -r docs/requirements.txt

See the documentation for more details.