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

File metadata

  • Download URL: xai_text_classifier-0.1.3.2.2.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.2.tar.gz
Algorithm Hash digest
SHA256 03c171ac58933162037e2718d1ba14c30e19fc92f1974e85a44cef199a0b27bf
MD5 fbd52b417721c5c36ccc8f855507c010
BLAKE2b-256 ec35e4ad0e54fefcdb32ec4a37985840ab6bf133a36c416aa848254b6275f6d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5149bdd9d77d9c0e67a43b936669d0c99995266fa22238e453414d571dd7344e
MD5 c5e2b2e329a928da9d37fe9712caa900
BLAKE2b-256 4b88ff9c5490ed5a76ddb923515835432823df77d12da4539a4d0bef793fe5ee

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