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.4.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.4-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.4.tar.gz.

File metadata

  • Download URL: xai_text_classifier-0.1.3.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 32c0c53964160d1ecec1a3bf7001972fdd2e15f598759782f68351e883570b3e
MD5 157849fe4f21f9cef43e23c91c91b9d1
BLAKE2b-256 eb015271ec857e12d38ee4a45250de2246d8a1112a8de640f39b035a0cd627cf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 96e444fa4959c1e6431a7f3e2c1aaa4b521e9887c0d5d390c1c90f6f6c255108
MD5 f6180e06cc1f513ad8cef38fa8980aa6
BLAKE2b-256 2a621941e1f4705d4e58f3277a23c315316212eab7eb9a73503e109c69f3ec83

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