Skip to content

Commit d14aa96

Browse files
committed
Update README and Observability: Add proper commands, contributors, and references
1 parent a6552ec commit d14aa96

File tree

2 files changed

+35
-21
lines changed

2 files changed

+35
-21
lines changed

Observability.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ This guide provides step-by-step instructions for implementing and using the com
2525

2626
### **Step 1: Start the Production Application**
2727
```bash
28-
cd /home/abhes/MlOps\ PipeLine
29-
python production_app.py
28+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python production_app.py
3029
```
3130

3231
### **Step 2: Start Observability Stack**
@@ -527,3 +526,7 @@ curl http://localhost:9090/api/v1/admin/tsdb/snapshot -XPOST
527526
---
528527

529528
This comprehensive observability stack provides complete visibility into your ML pipeline's performance, health, and business metrics. Use this guide to implement, maintain, and optimize your monitoring infrastructure.
529+
530+
## 👥 **Contributors**
531+
532+
- **[Abeshith](https://github.com/Abeshith)** - Project Creator & Lead Developer

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ pip install -r requirements.txt
7979
### Complete Pipeline
8080
```bash
8181
# Run all stages
82-
python main.py
82+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python main.py
8383

8484
# Or use DVC
8585
dvc repro
@@ -88,32 +88,32 @@ dvc repro
8888
### Individual Stages
8989
```bash
9090
# Stage 1: Data Ingestion
91-
python -m src.mlpipeline.pipeline.stage_01_data_ingestion
91+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python -m src.mlpipeline.pipeline.stage_01_data_ingestion
9292

9393
# Stage 2: Data Validation
94-
python -m src.mlpipeline.pipeline.stage_02_data_validation
94+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python -m src.mlpipeline.pipeline.stage_02_data_validation
9595

9696
# Stage 3: Feature Engineering
97-
python -m src.mlpipeline.pipeline.stage_03_feature_engineering
97+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python -m src.mlpipeline.pipeline.stage_03_feature_engineering
9898

9999
# Stage 4: Data Transformation
100-
python -m src.mlpipeline.pipeline.stage_04_data_transformation
100+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python -m src.mlpipeline.pipeline.stage_04_data_transformation
101101

102102
# Stage 5: Model Training
103-
python -m src.mlpipeline.pipeline.stage_05_model_trainer
103+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python -m src.mlpipeline.pipeline.stage_05_model_trainer
104104

105105
# Stage 6: Model Evaluation
106-
python -m src.mlpipeline.pipeline.stage_06_model_evaluation
106+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python -m src.mlpipeline.pipeline.stage_06_model_evaluation
107107
```
108108

109109
### Flask Application
110110
```bash
111111
# Start web interface
112-
python app.py
112+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python app.py
113113
# Access at: http://localhost:5000
114114

115115
# Production app with monitoring
116-
python production_app.py
116+
cd "/home/abhes/MlOps PipeLine" && source venv/bin/activate && PYTHONPATH="/home/abhes/MlOps PipeLine/src" python production_app.py
117117
# Metrics at: http://localhost:5000/metrics
118118
```
119119

@@ -137,6 +137,8 @@ docker compose up -d
137137
- **Prediction Analytics**: confidence scores, class distribution
138138
- **System Health**: error rates, response times, resource usage
139139

140+
📖 **For detailed observability setup and configuration, see [Observability.md](./Observability.md)**
141+
140142
---
141143

142144
## ☸️ **Kubernetes Deployment**
@@ -166,6 +168,9 @@ cp model_dag.py ~/airflow/dags/
166168
# Start Airflow
167169
airflow standalone
168170

171+
# Test DAG file
172+
python ~/airflow/dags/model_dag.py
173+
169174
# Access UI: http://localhost:8080
170175
# Trigger: ml_pipeline_dag
171176
```
@@ -187,16 +192,18 @@ airflow standalone
187192

188193
```
189194
MLOps_PipeLine/
190-
├── src/mlpipeline/ # Core ML pipeline source code
191-
├── config/ # Configuration files
192-
├── artifacts/ # Generated artifacts (DVC tracked)
193-
├── k8s/ # Kubernetes manifests
194-
├── observability/ # Monitoring stack
195-
├── .github/workflows/ # CI/CD automation
196-
├── dvc.yaml # DVC pipeline definition
197-
├── Dockerfile # Container definition
198-
├── model_dag.py # Airflow DAG definition
199-
└── app.py # Flask application
195+
├── src/mlpipeline/ # Core ML pipeline components and stages
196+
├── config/ # Configuration files for pipeline settings
197+
├── artifacts/ # Generated model artifacts and data (DVC tracked)
198+
├── k8s/ # Kubernetes deployment manifests
199+
├── observability/ # Complete monitoring stack with Prometheus, Grafana
200+
├── .github/workflows/ # CI/CD automation pipelines
201+
├── dvc.yaml # DVC pipeline definition and stages
202+
├── Dockerfile # Container definition for deployment
203+
├── model_dag.py # Apache Airflow DAG for pipeline orchestration
204+
├── app.py # Basic Flask web application
205+
├── production_app.py # Production Flask app with monitoring
206+
└── main.py # Main pipeline execution script
200207
```
201208

202209
---
@@ -216,4 +223,8 @@ MLOps_PipeLine/
216223

217224
**⭐ Star this repository if you found it helpful!**
218225

226+
## 👥 **Contributors**
227+
228+
- **[Abeshith](https://github.com/Abeshith)** - Project Creator & Lead Developer
229+
219230
</div>

0 commit comments

Comments
 (0)