https://github.com/xai-demonstrator/xai-demonstrator
The XAI Demonstrator is a modular platform that lets users interact with production-grade Explainable AI (XAI) systems.
https://github.com/xai-demonstrator/xai-demonstrator
ai docker explainable-ai fastapi huggingface-transformers keras machine-learning mobile-first pytorch tensorflow vuejs xai
Last synced: 3 months ago
JSON representation
The XAI Demonstrator is a modular platform that lets users interact with production-grade Explainable AI (XAI) systems.
- Host: GitHub
- URL: https://github.com/xai-demonstrator/xai-demonstrator
- Owner: XAI-Demonstrator
- License: apache-2.0
- Created: 2020-09-25T13:39:04.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-20T21:00:25.000Z (over 1 year ago)
- Last Synced: 2025-03-24T09:28:04.053Z (4 months ago)
- Topics: ai, docker, explainable-ai, fastapi, huggingface-transformers, keras, machine-learning, mobile-first, pytorch, tensorflow, vuejs, xai
- Language: Python
- Homepage: https://www.erklaerbare-ki.de/xai-demonstrator/
- Size: 15.3 MB
- Stars: 19
- Watchers: 2
- Forks: 7
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# XAI Demonstrator
[](https://opensource.org/licenses/Apache-2.0)
[](https://lgtm.com/projects/g/XAI-Demonstrator/xai-demonstrator/context:javascript)
[](https://lgtm.com/projects/g/XAI-Demonstrator/xai-demonstrator/context: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](#deployments) below.
Running the XAI Demonstrator locally requires [Docker](https://www.docker.com/) (but nothing else).
If you're new to Docker, see [the Docker Desktop installation instructions](https://www.docker.com/products/docker-desktop).
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/test-local) deployment configuration:
```bash
cd deployment/test-local
docker-compose up
```
Then, you can reach the app at [localhost:8000](http://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](http://localhost:8000/).
## Documentation
A documentation with user guides is taking shape at [xai-demonstrator.github.io/xai-demonstrator/](https://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](/review-sentiment) | Explain the sentiment analysis of customer reviews by a multi-lingual BERT model using gradient-based feature importance explanation methods |  | BE: [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-sentiment-backend)
FE: [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-sentiment-frontend) |
| [visual-inspection](/visual-inspection) | Visually explain the classification of images using model-agnostic local explanation methods |  | BE: [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-inspection-backend)
FE: [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-inspection-frontend) |
| [guess-the-country](/guess-the-country) | (work in progress) |  | BE: [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-country-backend)
FE: [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-country-frontend) |
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](http://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](/experiment-tracker).
| Package | Description | Build | Test |
|----------------------------------------------------------|-----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [experiment-proxy](/experiment-tracker/experiment-proxy) | A proxy that records requests and responses to use cases for later analysis |  | [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-experiment-proxy) |
| [experiment-proxy](/experiment-tracker/data-collector) | The service that collects and permanently stores the recorded data |  | [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-data-collector) |
## Further Packages and Components
| Package | Description | Build | Test |
|-------------------------------------------------|----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [common/backend-utils](/common/backend-utils) | Python package providing common functionality for FastAPI backend services |  | [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-backend-utils) |
| [common/vue-components](/common/vue-components) | NPM package providing common VueJS components for frontends |  | [](https://coveralls.io/github/XAI-Demonstrator/xai-demonstrator?branch=x-cov-vue-components) |
| [landing-page](/landing-page) | Frontend that serves as a common entry point to all use cases. |  | |
## Deployments
/badge.svg)
| Configuration | Location | Description | Status |
|------------------------------------------------|----------------------------------------------------|------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| [test-deployment](/deployment/test-deployment) | [https://test.xaidemo.de](https://test.xaidemo.de) | Latest version of the landing page and all use cases |  |
| [prod-deployment](/deployment/prod-deployment) | [https://www.xaidemo.de](https://www.xaidemo.de) | Current release |  |
## License
The XAI Demonstrator is licensed under the terms of the [Apache 2.0 license](LICENSE).