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

File metadata

  • Download URL: xai_text_classifier-0.1.3.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.1.tar.gz
Algorithm Hash digest
SHA256 d0f215bee4d11641cbb5b547021bd93c787611afdda65bd353c73d81853237fc
MD5 f55f1a56657030fc51c41f72cfd51cbe
BLAKE2b-256 3cbd9d6ea2cb1eb5446231a1d66870b98acee187ecf6c1db0d15d244ff73a395

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a5981c8c93817d841450650e1fa46ccf04b86b693ea58392af947fa46f12bb42
MD5 ea893eff5d925626a637e9b9a7f40724
BLAKE2b-256 704691c4304ff8d8bfeaa4b34109d450e8ee6408ef0cd09c6cd2efb6da5d8b84

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