Skip to content

Commit 4a0f395

Browse files
committed
Updated Readme
1 parent 56c5eb8 commit 4a0f395

1 file changed

Lines changed: 25 additions & 1 deletion

File tree

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,31 @@ See full Makefile usage [here](#makefile-usage) — from setup to linting, testi
3939

4040
## 📦 Project Structure
4141

42-
# Coming Soon
42+
```java
43+
.
44+
├── dags/Airflow DAGs for data pipeline and retraining
45+
├── data/Input datasets (raw, features, processed)
46+
├── models/Trained ML models (e.g., Isolation Forest)
47+
├── mlruns/MLflow experiment tracking artifacts
48+
├── infra/Terraform IaC for provisioning MLflow container
49+
├── github_pipeline/Feature engineering, inference, monitoring scripts
50+
├── scripts/Utility or automation scripts (e.g., setup, cleanup)
51+
├── tests/Pytest-based unit/integration tests
52+
├── reports/Data drift reports (JSON/HTML) from Evidently
53+
├── alerts/Alert log dumps (e.g., triggered drift/anomaly alerts)
54+
├── notebooks/Jupyter notebooks for exploration & experimentation
55+
├── assets/Images and architecture diagrams for README
56+
├── .github/workflows/GitHub Actions CI/CD pipelines
57+
├── streamlit_app.py ← Realtime dashboard for monitoring
58+
├── serve_model.py ← FastAPI inference service
59+
├── Dockerfile.*Dockerfiles for API and Streamlit services
60+
├── docker-compose.yaml ← Compose file to run Airflow and supporting services
61+
├── MakefileTask automation: setup, test, Airflow, Terraform, etc.
62+
├── requirements.txt ← Python dependencies for Airflow containers
63+
├── Pipfile / Pipfile.lock ← Python project environment (via Pipenv)
64+
├── .env ← Environment variables (Slack, Email, Airflow UID)
65+
└── README.md ← 📘 You are here
66+
```
4367

4468
---
4569

0 commit comments

Comments
 (0)