Skip to content

Commit da32400

Browse files
committed
Updated Readme
1 parent fb253e4 commit da32400

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Just use the **Makefile** to do all the boring stuff for you:
3535
make help
3636
```
3737

38-
See full Makefile usage [here](#makefile-usage) — from setup to linting, testing, API, Airflow, and Terraform infra!
38+
See full Makefile usage [here](#14-makefile-usage) — from setup to linting, testing, API, Airflow, and Terraform infra!
3939

4040
## 📦 Project Structure
4141

@@ -148,7 +148,7 @@ volumes:
148148
```
149149
You can explore experiment runs and models in the MLflow UI.
150150

151-
### 🧠 Model Training
151+
### 3. 🧠 Model Training
152152

153153
The model (Isolation Forest) is trained on actor-wise event features:
154154

@@ -157,7 +157,7 @@ python scripts/train_model.py
157157
```
158158
The latest parquet file is used automatically. Model and scaler are saved to models/.
159159

160-
### 🚀 3. FastAPI Inference
160+
### 4. 🚀 FastAPI Inference
161161

162162
#### Build & Run
163163

@@ -215,7 +215,7 @@ alerts/alerting.py
215215

216216
These generate alert messages and send them through email and Slack if thresholds are breached.
217217

218-
### 4. ✅ CI/CD with GitHub Actions
218+
### 6. ✅ CI/CD with GitHub Actions
219219

220220
The .github/workflows/ci.yml file runs on push:
221221

@@ -224,7 +224,7 @@ The .github/workflows/ci.yml file runs on push:
224224
- ✅ pytest
225225
- ✅ (optional) Docker build
226226

227-
### 🔍 Code Quality
227+
### 7. 🔍 Code Quality
228228

229229
Pre-commit hooks ensure style and linting:
230230

@@ -238,7 +238,7 @@ Configured via:
238238
- .pre-commit-config.yaml
239239
- .flake8 (ignore = E501)
240240

241-
### 4. 🧪 Testing
241+
### 8. 🧪 Testing
242242

243243
Run all tests:
244244

@@ -252,7 +252,7 @@ Tests are in tests/ and cover:
252252
- Feature engineering
253253
- Model training logic
254254

255-
### 6. 📊 Streamlit Dashboard
255+
### 9. 📊 Streamlit Dashboard
256256

257257
The project includes an optional interactive Streamlit dashboard to visualize:
258258

@@ -303,7 +303,7 @@ docker run -p 8501:8501 \
303303

304304
Then open your browser at http://localhost:8501.
305305

306-
### ☁️ Infrastructure as Code (IaC): MLflow Server with Terraform
306+
### 11. ☁️ Infrastructure as Code (IaC): MLflow Server with Terraform
307307

308308
This Terraform module provisions a **Docker-based MLflow tracking server**, matching the setup used in `docker-compose.yaml`, but on a **different port (5050)** to avoid conflicts.
309309

@@ -357,19 +357,19 @@ terraform destroy
357357

358358
This removes the MLflow container provisioned by Terraform.
359359

360-
### 7. 🧭 Architecture
360+
### 12. 🧭 Architecture
361361

362362
![Architecture](assets/architecture.png)
363363

364-
### 8. 🧹 Clean Code
364+
### 13. 🧹 Clean Code
365365

366366
All code follows:
367367

368368
- PEP8 formatting via Black
369369
- Linting with Flake8 + Bugbear
370370
- Pre-commit hook enforcement
371371

372-
### 🛠️ Makefile Usage
372+
### 14. 🛠️ Makefile Usage
373373

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

@@ -434,9 +434,9 @@ make terraform-status # Show current infra state
434434
make help # Prints a summary of all available targets and their descriptions.
435435
```
436436

437-
### 10. 🙌 Credits
437+
### 15. 🙌 Credits
438438

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

442-
### 10. 📝 License
442+
### 16. 📝 License

0 commit comments

Comments
 (0)