whitemech/temprl

Reinforcement Learning framework for Temporal Goals

temprl

Framework for Reinforcement Learning with Temporal Goals defined by LTLf/LDLf formulas.

Status: development.

Install

Install the package:

• from PyPI:

    pip3 install temprl
  

• with pip from GitHub:

    pip3 install git+https://github.com/whitemech/temprl.git
  

• or, clone the repository and install:

    git clone htts://github.com/whitemech/temprl.git
    cd temprl
    pip install .
  

Tests

To run tests: tox

To run only the code tests: tox -e py3.7

To run only the linters:

• tox -e flake8
• tox -e mypy
• tox -e black-check
• tox -e isort-check

Please look at the tox.ini file for the full list of supported commands.

Docs

To build the docs: mkdocs build

To view documentation in a browser: mkdocs serve and then go to http://localhost:8000

License

temprl is released under the GNU Lesser General Public License v3.0 or later (LGPLv3+).

Copyright 2020-2022 Marco Favorito

Authors

• Marco Favorito