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.1.tar.gz (4.5 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.1-py3-none-any.whl (4.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: xai_text_classifier-0.1.3.2.1.tar.gz
  • Upload date:
  • Size: 4.5 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.1.tar.gz
Algorithm Hash digest
SHA256 0c3b1e1e23c78d3cefa2c90857ec4a1d0403d0c443ab316d5d528c7a8b90c998
MD5 d8d77b0c89b80e323102935cec35462a
BLAKE2b-256 149f31eb5c811917099f53bc26a1204e25d926893daf5440fe01ff4109442a5b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 10a47a85b191e9e518c1d01992e484bf36daa46e694df56446e1b068852a07b5
MD5 8107b136103af2bd0c893c47dc262499
BLAKE2b-256 58b6f114d9fe1bd9fc67fb73870ec8ad25a1fc5e3a7d35a0b71cfb71ba6fd265

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