Installation from PyPI
The Python Package Index (PyPI) is the easiest way of installing PyXAI.
Python 3 (version 3.6 or later) must be installed first. You can install it from python.org.
Installing PyXAI
sudo apt update
Check whether ‘python3-pip’ is installed. If it is not the case, execute:
sudo apt install python3-pip
Or check whether you have the latest version:
python3 -m pip install --upgrade pip
Then, install PyXAI using the command:
python3 -m pip install pyxai
PyXAI’s GUI
Since V1.0.10, PyXAI’s Graphical Interface is independent and no longer mandatory, to resolve compatibility issues with PyQt6. You can still use pictorial explanations without the graphical interface — more information is available on the Visualization page.
python3 -m pip install pyxai[gui]
To use PyXAI’s graphical interface, you may need to install:
sudo apt install ffmpeg libsm6 libxext6 qt6-base-dev libxcb-cursor0 -y
Updating PyXAI
To update to the latest version of PyXAI, run:
python3 -m pip install -U pyxai
Verifying the installation
python3 -c "import pyxai; print(pyxai.__version__)"
Architecture Compatibility for PyXAI 2.0.1 with the PyPI installation
CPython 3.8 → 3.14 (including 3.14t, free-threaded) is covered on every platform below.
| OS | Min. version | Wheel tag | x86_64 (Intel / AMD 64-bit) | arm64 / aarch64 |
|---|---|---|---|---|
| macOS 12 (Monterey) | 12.0 | macosx_12_0 | ✅ Intel Mac | ✅ Apple Silicon (M1–M4) |
| macOS 13 (Ventura) | 12.0 | macosx_12_0 | ✅ Intel Mac | ✅ Apple Silicon |
| macOS 14 (Sonoma) | 12.0 | macosx_12_0 | ✅ Intel Mac | ✅ Apple Silicon |
| macOS 15 (Sequoia) | 12.0 | macosx_12_0 | ✅ Intel Mac | ✅ Apple Silicon |
| macOS 11 and earlier | — | — | ❌ | ❌ |
| Ubuntu 18.04 LTS and later | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| Ubuntu 16.04 LTS and earlier | — | — | ❌ (glibc 2.23) | ❌ |
| Debian 9 (Stretch) and later | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| RHEL / AlmaLinux / Rocky 8 and later | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| RHEL / CentOS 7 and earlier | — | — | ❌ (glibc 2.17) | ❌ |
| Fedora 30 and later | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| openSUSE Leap 15 / SLES 15 | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| Amazon Linux 2 / 2023 | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| Arch Linux / Manjaro | glibc 2.24 | manylinux_2_24 / manylinux_2_28 | ✅ | ✅ |
| Alpine 3.13 and later | musl 1.2 | musllinux_1_2 | ✅ | ✅ |
| Alpine 3.12 and earlier | — | — | ❌ (musl 1.1) | ❌ |
| Windows | — | — | ❌ (no wheel built) | ❌ (no wheel built) |