Explainability Techniques

A simple (and work-in-progress) Django app for interacting with a database of XAI techniques.

Quickstart

Clone repository

git clone https://github.com/chrisdburr/tea-XAI-demo.git && cd tea-XAI-demo

Populate `.env` file

Create a .env file in the root directory and ensure the following environment variables are set

# PostgreSQL settings
DB_USER=username
DB_PASSWORD=password
DB_HOST=localhost
DB_NAME=xai-techniques
DB_PORT=5432 # change if necessary in case of port conflicts

Install Python dependancies and activate the virtual environment

Warning

This repository contains a pyproject.toml file, created using Poetry to manage virtual environments and packages. Instructions for poetry are below, but will need to be modified if using alternatives, such as conda or pyvenv.

poetry install
poetry shell

Setup postgres container

Ensure environment variables are set (see above)
Create docker container using docker compose up -d
Test to ensure the container is running correctly using docker ps

Populate database

Once the virtual environment, packages, and container are created/running, you can populate the database.

python manage.py makemigrations
python manage.py migrate
python run load_and_import.py

Run Django App

Assuming no errors were reported in the previous steps, you can now create a superuser and run the webserver.

python manage.py createsuperuser
# Fill in details as required
python manage.py runserver

You can then navigate to one of the following urls:

Admin Page: http://127.0.0.1:8000/admin/
Home Page: http://127.0.0.1:8000/
List of Techniques: http://127.0.0.1:8000/
Main API Endpoint: http://127.0.0.1:8000/api/

[!INFO]
You can also run python manage.py show_urls in the terminal to see a list of all available urls.

To Do

This project is a work-in-progress. Eventually, a proper project page with issues will be developed for the following tasks:

asabuncuoglu13/tea-XAI-demo