Skip to main content

A library to explain whether text is AI-generated or human-written using SHAP

Project description

XAI Text Classifier

A library to explain whether text is AI-generated or human-written using SHAP (SHapley Additive exPlanations).

Features

  • AI vs Human Text Classification: Distinguish between AI-generated and human-written text
  • Explainability: Uses SHAP to provide detailed feature importance explanations
  • Multiple Models: Includes XGBoost and Random Forest models for robust predictions
  • Comprehensive Feature Analysis: Analyzes 40+ linguistic features including:
    • Readability metrics
    • Sentiment analysis
    • Syntactic complexity
    • Stylistic patterns
    • And more

Installation

pip install xai-text-classifier

Or install from source:

git clone <repository-url>
cd xai-text-classifier
pip install -e .

Usage

from xai import shap_explainer

# Analyze text
text = "Your text here..."
result = shap_explainer(text)

# Returns:
# {
#     "prediction": 0 or 1,  # 0 = Human, 1 = AI
#     "features": {
#         "feature_name": {
#             "value": feature_value,
#             "shap_value": shap_contribution,
#             "importance": relative_importance
#         },
#         ...
#     }
# }

Requirements

  • Python >= 3.8
  • joblib
  • shap
  • xgboost
  • spacy
  • language-tool-python
  • textblob
  • pandas
  • numpy
  • scikit-learn
  • nltk
  • textstat
  • matplotlib
  • scipy

Development

Install development dependencies:

pip install -e ".[dev]"

Run tests:

pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Citation

If you use this library in your research, please cite:

@software{xai_text_classifier,
  title={XAI Text Classifier},
  year={2025},
  url={<repository-url>}
}

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

xai_text_classifier-0.1.3.2.3.tar.gz (5.0 MB view details)

Uploaded Source

Built Distribution

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

xai_text_classifier-0.1.3.2.3-py3-none-any.whl (5.2 MB view details)

Uploaded Python 3

File details

Details for the file xai_text_classifier-0.1.3.2.3.tar.gz.

File metadata

  • Download URL: xai_text_classifier-0.1.3.2.3.tar.gz
  • Upload date:
  • Size: 5.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for xai_text_classifier-0.1.3.2.3.tar.gz
Algorithm Hash digest
SHA256 45d6210a4e50bce0f394bf4f753783107270de9aa9c4ed69d16dd3b878f1ec52
MD5 c77d7b10fda4a75de6fde63f6293ae78
BLAKE2b-256 d8ce8025b061d70a9d2376c16a85627808fda4d838ce5cac617045c3992c73a2

See more details on using hashes here.

File details

Details for the file xai_text_classifier-0.1.3.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 de474e1e0f4ea101e1d5b49db011108cee0a4bdb3943dde19a3883c2306f6232
MD5 c26bb280f2387adee281f865b8a82617
BLAKE2b-256 a181ecd46258aee86cb1cc420d0716b4363858b4888c1138790b999d230f0f20

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