Upload README.md with huggingface_hub

README.md

@@ -22,73 +22,82 @@ A text classification model for content moderation with age-appropriate filterin
 - **PII Detection:** Emails, phones, addresses, credit cards, SSN
 - **Social Media Protection:** 
   - <13: Block all social media sharing
-  - 13+: Allow but detect grooming patterns
-- **Context-aware:** Distinguishes reaction swearing from targeted aggression
+  - 13+: Allow, block only if grooming detected
+- **Grooming Detection:** Keywords like "dm me", "don't tell parents", "our secret"
 
-## Usage
+## Quick Start
 
 ```python
-from inference import DualModeFilter
+from pii_extension import CombinedModerationFilter
 
-# Basic content moderation
-filter = DualModeFilter("darwinkernelpanic/moderat")
-result = filter.check("damn that's crazy", age=15)
-# -> ALLOWED (reaction swearing permitted for 13+)
+filter = CombinedModerationFilter("darwinkernelpanic/moderat")
 
-# With PII detection (use pii_extension.py)
-from pii_extension import CombinedModerationFilter
+# Content moderation
+result = filter.check("damn that's crazy", age=15)
+# -> ALLOWED (reaction swearing for 13+)
 
-filter = CombinedModerationFilter("./moderation_model.pkl")
+# PII blocking (all ages)
 result = filter.check("My email is test@gmail.com", age=15)
 # -> BLOCKED (PII detected)
 
+# Social media (13+ allowed)
 result = filter.check("Follow me on instagram @user", age=15)
-# -> ALLOWED (social media OK for 13+)
+# -> ALLOWED
 
+# Grooming detection
 result = filter.check("DM me privately, don't tell parents", age=14)
 # -> BLOCKED (grooming detected)
 ```
 
-## PII Detection
+## PII Detection Rules
 
-| PII Type | Blocked (All Ages) |
-|----------|-------------------|
-| Email | ✅ Yes |
-| Phone | ✅ Yes |
-| Address | ✅ Yes |
-| Credit Card | ✅ Yes |
-| SSN | ✅ Yes |
-| Social Media | Depends on age |
+| PII Type | All Ages | Example |
+|----------|----------|---------|
+| Email | ❌ Block | `john@example.com` |
+| Phone | ❌ Block | `555-123-4567` |
+| Address | ❌ Block | `123 Main Street` |
+| Credit Card | ❌ Block | `4111-1111-1111-1111` |
+| SSN | ❌ Block | `123-45-6789` |
+| Social Media | Depends | See below |
 
 ## Social Media Rules
 
-| Age | Social Media | Grooming Context |
-|-----|--------------|------------------|
-| <13 | ❌ Blocked | N/A |
+| Age | Plain Share | With Grooming Context |
+|-----|-------------|----------------------|
+| <13 | ❌ Blocked | ❌ Blocked |
 | 13+ | ✅ Allowed | ❌ Blocked |
 
+**Grooming keywords:** "dm me", "don't tell", "secret", "send pics", "meet up", etc.
+
 ## Content Labels
 
-| Label | <13 | 13+ |
-|-------|-----|-----|
+| Text | <13 | 13+ |
+|------|-----|-----|
 | "damn that's crazy" | ❌ Blocked | ✅ Allowed |
+| "shit that sucks" | ❌ Blocked | ✅ Allowed |
 | "you're trash" | ❌ Blocked | ❌ Blocked |
 | "kill yourself" | ❌ Blocked | ❌ Blocked |
 
 ## Model Details
 
-- **Algorithm:** Multinomial Naive Bayes with TF-IDF
-- **Test accuracy:** 77%
+- **Algorithm:** Multinomial Naive Bayes + TF-IDF + Regex PII
+- **Content accuracy:** 77%
+- **PII detection:** Regex-based (fast, no ML)
 - **Features:** 10,000 max, 1-3 ngrams
-- **Training samples:** 215
 
 ## Files
 
-- `moderation_model.pkl` - Trained model
-- `inference.py` - Basic inference
+- `moderation_model.pkl` - Content moderation model
 - `pii_extension.py` - PII + grooming detection
-- `enhanced_moderation.py` - Training script
+- `inference.py` - Basic inference
+- `moderat_speed_test.ipynb` - Colab notebook
+
+## Colab
+
+Test it: [Open in Colab](https://colab.research.google.com/github/darwinkernelpanic/moderat/blob/main/moderat_speed_test.ipynb)
 
-## Colab Notebook
+## Speed
 
-Try it: [moderat_speed_test.ipynb](./moderat_speed_test.ipynb)
+- Single inference: ~2-5ms
+- With PII check: ~3-7ms
+- Throughput: ~300-500 texts/sec