Skip to content

Commit e6fe95b

Browse files
committed
Updated README
1 parent 70ad60e commit e6fe95b

1 file changed

Lines changed: 7 additions & 10 deletions

File tree

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ This project aims to build a **production-grade anomaly detection system** to:
1515

1616
A production-grade anomaly detection system for GitHub user behavior using:
1717

18+
![Architecture](assets/architecture.png)
19+
1820
- **Apache Airflow** for orchestration
1921
- **Pandas + Scikit-learn (Isolation Forest)** for modeling and anomaly detection
2022
- **Alerts: Email & Slack** alerting mechanisms for anomaly spikes and data drift
@@ -24,7 +26,7 @@ A production-grade anomaly detection system for GitHub user behavior using:
2426
- **Streamlit UI** for visualization
2527
- **Terraform** for infrastructure-as-code provisioning (MLflow)
2628

27-
#### You can find the complete pipeline architecture diagram [here](#architecture-diag).
29+
The full architecture of this GitHub anomaly detection pipeline is illustrated in the diagram below.
2830
---
2931

3032
## 🤖 Too lazy for copy-pasting commands?
@@ -381,12 +383,7 @@ terraform destroy
381383

382384
This removes the MLflow container provisioned by Terraform.
383385

384-
<span id="architecture-diag"></span>
385-
### 12. 🧭 Architecture
386-
387-
![Architecture](assets/architecture.png)
388-
389-
### 13. 🧹 Clean Code
386+
### 12. 🧹 Clean Code
390387

391388
All code follows:
392389

@@ -395,7 +392,7 @@ All code follows:
395392
- Pre-commit hook enforcement
396393

397394
<span id="makefile-usage"></span>
398-
### 14. 🛠️ Makefile Usage
395+
### 13. 🛠️ Makefile Usage
399396

400397
This project includes a Makefile that simplifies formatting, testing, building Docker containers, and running Airflow or the FastAPI inference app.
401398

@@ -460,9 +457,9 @@ make terraform-status # Show current infra state
460457
make help # Prints a summary of all available targets and their descriptions.
461458
```
462459

463-
### 15. 🙌 Credits
460+
### 14. 🙌 Credits
464461

465462
Built by Rajat Gupta as part of an MLOps portfolio.
466463
Inspired by real-time event pipelines and anomaly detection architectures used in production.
467464

468-
### 16. 📝 License
465+
### 14. 📝 License

0 commit comments

Comments
 (0)