Skip to main content

KAA is a framework allowing to apply several explainability methods and metricsfrom several dedicated libraries on AI model to verify them.

Project description

image Aie Confiance... https://www.youtube.com/watch?v=2gflQEF1WQU

KAA v25.12

KAA is a Python framework allowing to apply several methods and metrics from several dedicated XAI libraries on AI model to verify them. It is built around a kernel offering a TUI Text-based User Interface and hosting two sets of plugins:

  • the plugins of the explainability libraries called pluginsXAI
  • the plugins of the use cases called pluginsUCXAI

KAA must be considered as a comprehensibility tool. It is part of these mediation tools allowing to implement explainability methods in a guided way, to facilitate the adjustment of their parameters by adding knowledge of their influence. It then offers appropriate and relevant interfaces and visualizations of results to select the methods and metrics that are most suited to the user’s problem.

In this version of KAA, the AIX360 (v0.3.0), Alibi (v0.9.6), Captum (v0.7.0), PAIR saliency (v0.2.1), Shap (v0.44.1) and Xplique (v1.4.0) plugins are provided.

Full documentation can be found in ./documentation/Kaa_User_and_Integration_Manual.pdf

Quick Start

KAA requires a version of python equal to 3.8 and several libraries including Tensorflow and Numpy. Installation can be done:

  1. using Pypi:
pip install KAA-XAI
  1. via downlading the v25.12 tag on our github:

Option 1: Using Git

git clone https://github.com/IRT-Saint-Exupery/KAA.git
cd KAA
git checkout tags/v25.12

Option 2: Download the ZIP archive

wget https://github.com/IRT-Saint-Exupery/KAA/archive/refs/tags/v25.12.zip
unzip v25.12.zip
cd KAA-25.12

Install the requirements:

pip install -r requirements.txt

Then install the XAI libraries you want:

pip install -r requirementsXAIlibs.txt

Now that KAA is installed, you can launch the TUI KAA .

python3 kaa/kaa.py -u example/pluginsUCXAI/ -b example/UseCase/ -r ~/KAA_example

or execute a command file of the example:

python3 kaa/kaa.py -u example/pluginsUCXAI/ -b example/UseCase/ -r ~/KAA_example -c example/example.cmd

The results are available in the -r path:

~/KAA_example
+-- fullReports
|   +-- Resnet
|       +-- UCRenaultWeldingResnet_fullReport__expl-data.pdf
+-- Xplique
    +-- Occlusion__bz64_pz35_ps3_ov1
    |   +-- contactSheet.pdf
    +-- Rise__bz64_ns2000_gz7_pp0-5
        +-- contactSheet.pdf

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kaa_xai-25.12.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kaa_xai-25.12.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file kaa_xai-25.12.0.tar.gz.

File metadata

  • Download URL: kaa_xai-25.12.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for kaa_xai-25.12.0.tar.gz
Algorithm Hash digest
SHA256 183134f6d9c758d124441108d190e10ed624fb705e1c9de705b6dd2981914dfc
MD5 59335711f7e7be14c3f872baef486383
BLAKE2b-256 f4722e9286e44495707deaf041d3a7fe1242d305e3c9e78bef18b5e1b938c214

See more details on using hashes here.

File details

Details for the file kaa_xai-25.12.0-py3-none-any.whl.

File metadata

  • Download URL: kaa_xai-25.12.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for kaa_xai-25.12.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac8384e4d373f486fd1d07fee517492ed6370109527f1610815156d5c48d4ef2
MD5 d56d03be0674a3d5d8b909b50d395351
BLAKE2b-256 f0cc8cfb5d0639bc8c5f9c849eaf41e31f0858da5695178e7333bb4de9429e21

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page