joshzwiebel/Shapley-Routing

An implementation of efficient Shapley value calculation of routing problems

Shapley-Routing

Documentation can be found here.

Try it out using our Streamlit webapp here!

Installation

1️⃣ Install Poetry:

pip install poetry

If you encounter an error, try:

export PATH="/home/<user>/.local/bin:$PATH"

2️⃣ Install dependencies:

poetry install

Testing

Run style check

poetry run flake8 .
poetry run black .

Running unit tests

poetry run pytest -v .

Running unit tests with coverage

poetry run coverage run -m pytest -v .
poetry run coverage report -m

Docs

Docs can be built using the following commands:

cd docs/
poetry run make html