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

File metadata

  • Download URL: xai_text_classifier-0.1.3.2.5.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.5.tar.gz
Algorithm Hash digest
SHA256 77992ef478cd683efe6ec33b542ad2899b2ef00018748dc1f3b9b0a1b660d6a6
MD5 4873e4604b8c8734e3281796ab9f75dc
BLAKE2b-256 647ed9325f96e04de112d43c029d35a41f3ead0bbdc4d36b81e328c8391b3b50

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 a9b8f1b478182e5d035aa32819f7b7b77b93e0cf9d308d23ae887d03262e86c4
MD5 c759ddb6184223441e58f8f45c689581
BLAKE2b-256 3e576d5db6e46a21820181e332f077cac47415055b1031c297367bc7166f6b03

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