Metadata-Version: 2.4
Name: xai4mri
Version: 0.0.2
Summary: xai4mri is designed for advanced MRI analysis using deep learning combined with explainable A.I. (XAI).
Author-email: "Simon M. Hofmann" <simon.hofmann@pm.me>
Maintainer-email: "Simon M. Hofmann" <simon.hofmann@pm.me>
License-Expression: MIT
Project-URL: homepage, https://shescher.github.io/xai4mri/
Project-URL: documentation, https://shescher.github.io/xai4mri/
Project-URL: repository, https://github.com/SHEscher/xai4mri
Project-URL: changelog, https://github.com/SHEscher/xai4mri/blob/main/CHANGELOG.md
Keywords: transfer-learning,xai,explainable-ai,explanation,interpretation,prediction,MRI,sMRI,3D-conv,deep-learning,structure,brain,t1w,flair,swi,dwi
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: <3.12,>=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: antspyx<0.5.0,>=0.4.2
Requires-Dist: innvestigate<3.0.0,>=2.1.1
Requires-Dist: nilearn<1.0,>=0.10
Requires-Dist: tensorflow<2.15,>=2.6
Requires-Dist: tqdm<5.0,>=4.66.5
Provides-Extra: develop
Requires-Dist: bumpver==2023.1129; extra == "develop"
Requires-Dist: ruff<1.0.0,>=0.17.0; extra == "develop"
Requires-Dist: tox<5.0.0,>=4.23.2; extra == "develop"
Requires-Dist: pre-commit<5.0.0,>=4.7.0; extra == "develop"
Requires-Dist: pytest<10.0.0,>=8.4.2; extra == "develop"
Requires-Dist: pytest-cov<8.0.0,>=7.1.0; extra == "develop"
Requires-Dist: build<2.0.0,>=1.4.4; extra == "develop"
Requires-Dist: twine<8.0.0,>=6.2.0; extra == "develop"
Provides-Extra: docs
Requires-Dist: blacken-docs<2.0,>=1.16; extra == "docs"
Requires-Dist: docutils<1.0.0,>=0.21.1; extra == "docs"
Requires-Dist: markdown-callouts<1.0.0,>=0.3.0; extra == "docs"
Requires-Dist: markdown-exec[ansi]<2.0.0,>=1.7.0; extra == "docs"
Requires-Dist: mkdocs<2.0,>=1.5; extra == "docs"
Requires-Dist: mkdocs-autorefs<1.0.0,>=0.5.0; extra == "docs"
Requires-Dist: mkdocs-bibtex<3.0.0,>=2.11.0; extra == "docs"
Requires-Dist: mkdocs-coverage<2.0.0,>=1.0.0; extra == "docs"
Requires-Dist: mkdocs-gen-files<1.0,>=0.5.0; extra == "docs"
Requires-Dist: mkdocs-jupyter<1.0.0,>=0.24.6; extra == "docs"
Requires-Dist: mkdocs-literate-nav<1.0,>=0.6.1; extra == "docs"
Requires-Dist: mkdocs-material<10.0.0,>=9.4.8; extra == "docs"
Requires-Dist: mkdocs-material-extensions<2.0,>=1.3; extra == "docs"
Requires-Dist: mkdocs-minify-plugin<1.0.0,>=0.7.1; extra == "docs"
Requires-Dist: mkdocs-redirects<2.0.0,>=1.2.1; extra == "docs"
Requires-Dist: mkdocstrings[python]; extra == "docs"
Requires-Dist: pypandoc<2.0,>=1.13; extra == "docs"
Dynamic: license-file

# xai4mri

*Explainable A.I. for MRI research using deep learning.*

![xai4mri logo](xai4mri.svg)

![Last update](https://img.shields.io/badge/last_update-Oct_14,_2026-green)
![Last update](https://img.shields.io/badge/version-v.0.0.2-blue)

## What is `xai4mri`

`xai4mri` is designed for advanced MRI analysis combining deep learning with explainable A.I. (XAI).
It offers the following key functionalities:

- **Data Integration**: Effortlessly import new MRI datasets and apply the models to generate accurate predictions.
- **Model Loading**: Load (pretrained) 3D-convolutional neural network models tailored for MRI predictions.
- **Interpretation Tools**: Utilize analyzer tools,
such as [Layer-wise Relevance Propagation (LRP)](https://doi.org/10.1038/s41467-019-08987-4),
to interpret model predictions through intuitive heatmaps.

With `xai4mri`, you can complement your MRI analysis pipeline, ensuring precise predictions and
insightful interpretations.

## Quick-start

```shell
pip install -U xai4mri
```

Get started with `xai4mri` in Python:

```python
import xai4mri as xai
```

Visit the [**documentation**](https://shescher.github.io/xai4mri/overview), for detailed information.

## Citation

When using `xai4mri`, please cite the following papers:
[`toolbox paper in prep`] and [Hofmann et al. (2022, *NeuroImage*)](https://doi.org/10.1016/j.neuroimage.2022.119504).
