Metadata-Version: 2.4
Name: xailens
Version: 0.1.2
Summary: xailens dashboard and utilities
Author-email: Alex Little <alex@alexlittle.net>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas==3.0.2
Requires-Dist: scikit-learn==1.8.0
Requires-Dist: numpy==2.4.4
Requires-Dist: seaborn==0.13.2
Requires-Dist: shap==0.51.0
Requires-Dist: matplotlib==3.10.9
Requires-Dist: joblib==1.5.3
Requires-Dist: pyarrow==24.0.0
Requires-Dist: streamlit==1.57.0
Requires-Dist: setuptools==81.0.0
Requires-Dist: streamlit_option_menu==0.4.0
Requires-Dist: sentence-transformers==5.5.0
Requires-Dist: torchvision==0.27.0
Requires-Dist: spacy==3.8.14
Requires-Dist: plotly==6.7.0
Provides-Extra: dev
Requires-Dist: pytest==9.0.3; extra == "dev"
Requires-Dist: twine==6.2.0; extra == "dev"
Requires-Dist: build==1.4.0; extra == "dev"
Requires-Dist: wheel==0.46.3; extra == "dev"
Requires-Dist: pytest-cov==7.1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: Sphinx==9.1.0; extra == "docs"
Requires-Dist: sphinx_rtd_theme==3.1.0; extra == "docs"
Provides-Extra: examples
Requires-Dist: ollama==0.6.1; extra == "examples"
Requires-Dist: xgboost==3.2.0; extra == "examples"
Requires-Dist: jinja2==3.1.6; extra == "examples"
Requires-Dist: tqdm==4.67.3; extra == "examples"
Dynamic: license-file

# xaicompare

Under development as part of my MSc project, XAI Compare allows model developers to compare Explainable AI methods and 
explanations between models, including scikit-learn models and LLMs.

## Setup & Install

* This repo uses Git LFS for large files. Before cloning, install Git LFS:
    ```bash
    sudo apt install git-lfs  # Ubuntu
    brew install git-lfs      # macOS
    git lfs install
    ```
* Install with 


As this is a proof of concept framework, not all model, XAI method or visualisation type has been developed. However,
the architecture (adapter pattern) allows new model types, XAI methods and visualisations to be added without large 
changes to the codebase.



## 🚀 CI & Code Quality

### 🧪 Continuous Integration
[![CI](https://github.com/alexlittle/xaicompare/actions/workflows/ci.yml/badge.svg)](https://github.com/alexlittle-github/xaicompare/actions)

### 🔎 SonarCloud — Quality Overview
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=coverage)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)

### 📈 Detailed Metrics
[![Maintainability](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)
[![Reliability](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)
[![Security](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)

### 🐛 Issues Breakdown
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=bugs)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=alexlittle-github_xaicompare&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=alexlittle-github_xaicompare)
