Skip to content

XAI-Demonstrator/xai-demonstrator

Repository files navigation

XAI Demonstrator

License Language grade: JavaScript Language grade: Python

The XAI Demonstrator is a modular platform that lets users interact with production-grade Explainable AI (XAI) systems.

Getting Started

If you just want to try the XAI Demonstrator, have a look at the list of publicly accessible deployments below.

Running the XAI Demonstrator locally requires Docker (but nothing else). If you're new to Docker, see the Docker Desktop installation instructions.

The fastest way to start a local version of the most recent development version of the XAI Demonstrator is to use the test-local deployment configuration:

cd deployment/test-local
docker-compose up

Then, you can reach the app at localhost:8000.

To start a local instance of the XAI Demonstrator built from source, run docker-compose up in the top-level directory, wait for all builds to complete, and access the app at localhost:8000.

Documentation

Documentation

A documentation with user guides is taking shape at xai-demonstrator.github.io/xai-demonstrator/.

Use Cases

Each use case illustrates a particular application of user-centric XAI methods.

Code Description Build Test
review-sentiment Explain the sentiment analysis of customer reviews by a multi-lingual BERT model using gradient-based feature importance explanation methods Review Sentiment BE: Coverage Status
FE: Coverage Status
visual-inspection Visually explain the classification of images using model-agnostic local explanation methods Visual Inspection BE: Coverage Status
FE: Coverage Status
guess-the-country (work in progress) Visual Inspection BE: Coverage Status
FE: Coverage Status

You can try out a standalone version each use case locally by running docker-compose up in the respective directory. Then, the use case is available at localhost:8000.

Experiment Tracking

It is possible to record user requests and additional data when the XAI Demonstrator is used in academic research or for user testing. To learn more, have a look at the experiment-tracker.

Package Description Build Test
experiment-proxy A proxy that records requests and responses to use cases for later analysis Experiment Tracker Coverage Status
experiment-proxy The service that collects and permanently stores the recorded data Experiment Tracker Coverage Status

Further Packages and Components

Package Description Build Test
common/backend-utils Python package providing common functionality for FastAPI backend services Backend Utils Coverage Status
common/vue-components NPM package providing common VueJS components for frontends Vue Components Coverage Status
landing-page Frontend that serves as a common entry point to all use cases. Landing Page

Deployments

Monitor Deployment(s)

Configuration Location Description Status
test-deployment https://test.xaidemo.de Latest version of the landing page and all use cases Test Deployment
prod-deployment https://www.xaidemo.de Current release Prod Deployment

License

The XAI Demonstrator is licensed under the terms of the Apache 2.0 license.