Skip to content

Commit bb2ef0d

Browse files
authored
Enhance README with architecture diagram and model rationale
Added architecture diagram and rationale for using Isolation Forest.
1 parent bbcae8a commit bb2ef0d

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,21 @@ A comprehensive, **GSOC-level security monitoring solution** that leverages Arti
1313

1414
This platform is designed to bridge the gap between traditional log monitoring and modern AI-driven threat intelligence. By ingesting system and network logs in real-time, parsing them through an advanced **Isolation Forest** machine learning model, and visualizing the results on a dynamic **Next.js Dashboard**, it empowers security teams to identify zero-day attacks and subtle anomalies that rule-based systems miss.
1515

16+
## 🧩 Architecture Diagram
17+
18+
```mermaid
19+
flowchart LR
20+
Logs[System & Network Logs] --> Ingest[FastAPI Log Ingestion API]
21+
Ingest --> DB[(SQLite via SQLAlchemy)]
22+
Ingest --> Model[Isolation Forest Anomaly Model]
23+
Model --> Scored[Scored Events - Normal / Suspicious / Critical]
24+
Scored --> API[REST API]
25+
API --> Dashboard[Next.js Dashboard]
26+
Dashboard --> Visuals[3D Globe & Network Graph]
27+
```
28+
29+
The platform ingests raw system and network logs, stores them in a relational database, scores them with an Isolation Forest model, and serves the results to a Next.js dashboard that renders traditional charts and immersive 3D visualizations.
30+
1631
## 🚀 Key Features
1732

1833
* **🕵️ Real-time Anomaly Detection**: Utilizes Unsupervised Learning (Isolation Forest) to detect outliers in network traffic and user behavior.
@@ -35,6 +50,17 @@ This platform is designed to bridge the gap between traditional log monitoring a
3550
* **Pandas & NumPy**: Data manipulation and feature extraction.
3651
* **SQLAlchemy & SQLite**: ORM and Database (Easily scalable to PostgreSQL).
3752

53+
* ### 🤖 Why Isolation Forest?
54+
55+
This project focuses on unsupervised anomaly detection, where labeled attack data is rare and patterns evolve quickly. Isolation Forest is well-suited because:
56+
57+
- It works **without labeled data**, matching real-world security logs where we don't have ground-truth labels for every event.
58+
- It handles **high-dimensional, noisy features** (IPs, ports, sizes, timings) with robust performance.
59+
- Compared to density-based methods (like LOF), it **scales better** to large log volumes and is faster to train and infer with.
60+
- Compared to supervised classifiers, it doesn't overfit to known attack signatures and can surface **previously unseen, zero-day style anomalies**.
61+
62+
These properties make Isolation Forest a practical baseline model for an AI-powered security monitoring platform, while leaving room for future extensions (autoencoders, ensembles, or hybrid rules-plus-ML systems).
63+
3864
### Frontend
3965
* **Next.js 14**: React framework for production.
4066
* **TailwindCSS**: Utility-first styling.

0 commit comments

Comments
 (0)