File size: 3,489 Bytes
3a4a5df
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
╔══════════════════════════════════════════════════════════════╗
β•‘    πŸ’¬ CleanSpeak: AI Toxic Comment Detector                 β•‘
β•‘              LAUNCH INSTRUCTIONS                             β•‘
β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•

πŸš€ QUICK LAUNCH (3 COMMANDS):

1️⃣  ./setup.sh

2️⃣  source venv/bin/activate

3️⃣  streamlit run app.py

═══════════════════════════════════════════════════════════════

πŸ“‹ WHAT YOU NEED:

βœ“ Python 3.8 or higher
βœ“ Internet connection (for model download)
βœ“ 5 minutes for setup
βœ“ 500MB disk space

═══════════════════════════════════════════════════════════════

🎯 FIRST TIME SETUP:

Step 1: Run setup script
   ./setup.sh

Step 2: Activate virtual environment
   source venv/bin/activate
   (On Windows: venv\Scripts\activate)

Step 3: Launch the app
   streamlit run app.py

═══════════════════════════════════════════════════════════════

⏱️ EXPECTED TIMELINE:

β”œβ”€ Setup script:         ~30 seconds
β”œβ”€ Model download:       ~2-3 minutes (first run only)
β”œβ”€ App startup:          ~10 seconds
└─ Ready to use!         βœ…

═══════════════════════════════════════════════════════════════

🎨 WHAT YOU'LL SEE:

1. Beautiful gradient UI loads
2. Text input box appears
3. "Detect Toxicity" button ready
4. Type a comment and click!
5. Get instant Yes/No result

═══════════════════════════════════════════════════════════════

πŸ“– DOCUMENTATION FILES:

β€’ README.md          - Full documentation
β€’ QUICK_START.md     - Quick reference
β€’ DEMO.md            - Example scenarios
β€’ PROJECT_SUMMARY.md - Project overview

═══════════════════════════════════════════════════════════════

πŸ› TROUBLESHOOTING:

Problem: "command not found: streamlit"
Fix: Activate venv first: source venv/bin/activate

Problem: Model download fails
Fix: Check internet connection, retry

Problem: Port 8501 in use
Fix: streamlit run app.py --server.port 8502

═══════════════════════════════════════════════════════════════

✨ READY TO PRESENT!

Your app will open at: http://localhost:8501

═══════════════════════════════════════════════════════════════

Made with ❀️  for promoting healthy digital communication