VoltageVagabond commited on
Commit
3d044f3
Β·
verified Β·
1 Parent(s): 1097a46

Deduplicate educational disclaimer text

Browse files
Files changed (2) hide show
  1. MODEL_README.md +0 -3
  2. README.md +0 -3
MODEL_README.md CHANGED
@@ -22,9 +22,6 @@ This repository was created for a senior project in ENGT 375 Applied Machine Lea
22
  # Spam Email Classifier β€” sklearn Voting Ensemble with XAI (v2)
23
 
24
  **ENGT 375 β€” Applied Machine Learning | Spring 2026 | Old Dominion University**
25
-
26
- > **Disclaimer:** This model was created as a student project for Applied Machine Learning at ODU. It is intended for **educational and research purposes only** and should not be used as a sole spam/phishing filter in production. Classification accuracy may vary, and the model may produce incorrect or misleading results. Always use established email security tools for real-world spam filtering.
27
-
28
  A voting ensemble classifier (Random Forest + Logistic Regression + Linear SVM with calibration) for spam email detection, with LIME, SHAP, and ELI5 explainability support. This is the **v2** model β€” a beginner-friendly course-facing rewrite of the original `spam-xai-project`, retrained on the full 99,999-sample corpus. The Gradio workflow was previously merged in from the now-retired `spam-classifier-gradio` project.
29
 
30
  ## Model Details
 
22
  # Spam Email Classifier β€” sklearn Voting Ensemble with XAI (v2)
23
 
24
  **ENGT 375 β€” Applied Machine Learning | Spring 2026 | Old Dominion University**
 
 
 
25
  A voting ensemble classifier (Random Forest + Logistic Regression + Linear SVM with calibration) for spam email detection, with LIME, SHAP, and ELI5 explainability support. This is the **v2** model β€” a beginner-friendly course-facing rewrite of the original `spam-xai-project`, retrained on the full 99,999-sample corpus. The Gradio workflow was previously merged in from the now-retired `spam-classifier-gradio` project.
26
 
27
  ## Model Details
README.md CHANGED
@@ -33,9 +33,6 @@ This repository was created for a senior project in ENGT 375 Applied Machine Lea
33
  # Spam Email Classifier with XAI Explanations
34
 
35
  **ENGT 375 β€” Applied Machine Learning | Spring 2026 | Old Dominion University**
36
-
37
- > **Disclaimer:** This model was created as a student project for Applied Machine Learning at ODU. It is intended for **educational and research purposes only** and should not be used as a sole spam/phishing filter in production. Classification accuracy may vary, and the model may produce incorrect or misleading results. Always use established email security tools for real-world spam filtering.
38
-
39
  A Gradio web app that classifies emails as spam or ham and provides explainable AI (XAI) insights using three different methods (LIME, SHAP, and ELI5).
40
 
41
  **What's new in v2:** beginner-friendly notebook refactor (explicit for-loops over comprehensions, no decorators, no premature abstractions), lecture-style charts in the student teaching notebook, a separate `app_student.py` / `utils_student.py` / `retrain_student.py` track for course readers, and a fresh full-dataset retrain (99,999 samples β€” 69,999 train / 30,000 test) producing a re-tuned classification threshold of 0.3714. v2 is deployed as its own HuggingFace Space at `VoltageVagabond/spam-xai-classifier-v2`.
 
33
  # Spam Email Classifier with XAI Explanations
34
 
35
  **ENGT 375 β€” Applied Machine Learning | Spring 2026 | Old Dominion University**
 
 
 
36
  A Gradio web app that classifies emails as spam or ham and provides explainable AI (XAI) insights using three different methods (LIME, SHAP, and ELI5).
37
 
38
  **What's new in v2:** beginner-friendly notebook refactor (explicit for-loops over comprehensions, no decorators, no premature abstractions), lecture-style charts in the student teaching notebook, a separate `app_student.py` / `utils_student.py` / `retrain_student.py` track for course readers, and a fresh full-dataset retrain (99,999 samples β€” 69,999 train / 30,000 test) producing a re-tuned classification threshold of 0.3714. v2 is deployed as its own HuggingFace Space at `VoltageVagabond/spam-xai-classifier-v2`.