Tuathe commited on
Commit
35cccae
·
verified ·
1 Parent(s): da94a60

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +44 -17
README.md CHANGED
@@ -1,20 +1,47 @@
1
- ---
2
- title: Watchtowerai Log Analyzer
3
- emoji: 🚀
4
- colorFrom: red
5
- colorTo: red
6
- sdk: docker
7
- app_port: 8501
8
- tags:
9
- - streamlit
10
- pinned: false
11
- short_description: Streamlit template space
12
- license: apache-2.0
13
- ---
 
 
 
 
 
 
 
 
 
14
 
15
- # Welcome to Streamlit!
16
 
17
- Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
18
 
19
- If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
20
- forums](https://discuss.streamlit.io).
 
1
+ # WatchTowerAI – Log Classification & Automated Runbook Generator
2
+
3
+ A production-grade AI tool to analyze logs in real-time, classify them using a fine-tuned Flan-T5 model, generate markdown runbooks, and automatically alert your team via Slack — all deployed on Hugging Face Spaces.
4
+
5
+ ## Features
6
+
7
+ - **LLM-powered log classification** (INFO, WARNING, ERROR, CRITICAL, SECURITY)
8
+ - **Runbook generation** using Flan-T5
9
+ - **Upload runbooks to AWS S3**
10
+ - **Send real-time Slack alerts**
11
+ - Hybrid fallback using rule-based logic if model is uncertain
12
+ - Streamlit Web UI + `.log` file upload support
13
+
14
+ ## Tech Stack
15
+
16
+ - LLM: Fine-tuned [Flan-T5](https://huggingface.co/google/flan-t5)
17
+ - Frontend: Streamlit
18
+ - Cloud: AWS S3
19
+ - Alerts: Slack Webhook
20
+ - Deployment: Hugging Face Spaces
21
+
22
+ ## Screenshot
23
 
24
+ ![screenshot](https://your-screenshot-link)
25
 
26
+ ## How to Use
27
+
28
+ 1. Paste or upload a `.log` file
29
+ 2. Click “Classify + Generate Runbook”
30
+ 3. Download the markdown or view it in S3
31
+ 4. Slack alerts will be sent automatically
32
+
33
+ ## Directory
34
+
35
+ - `streamlit_app.py` – UI + logic
36
+ - `upload_to_s3.py` – S3 upload function
37
+ - `notify_slack.py` – Slack integration
38
+ - `runbooks/` – Markdown output folder
39
+ - `codementor-flan/` – Your fine-tuned model folder
40
+
41
+ ## AI Model
42
+
43
+ Fine-tuned on domain-specific QA + system logs using Flan-T5 for robust multi-class log categorization and response generation.
44
+
45
+ ---
46
 
47
+ Made by [Chetan](https://github.com/chetan10510)