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

File metadata

  • Download URL: xai_text_classifier-0.1.3.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.tar.gz
Algorithm Hash digest
SHA256 32000e3ea3777ef1635ab1d41182affa8f96b8df9354524e27810b82dd5ec116
MD5 5562a2c9878f15db46bef3d68c464311
BLAKE2b-256 1e800231b9f65ecca5f1c9c9bb2280bce5f75c008af1a29c0d6d205d7d45c48d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for xai_text_classifier-0.1.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2a9aa55228a8ceaaef0bdd8eeaa3be02020a1f2158aa536391e39cfd331f41aa
MD5 795d8c58215571176bc7253647d33efa
BLAKE2b-256 c2dac767c717d6ccff2d8d187ce82c5a622f55c8120cafe81a0a4f5cb46e8ee8

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