File size: 6,515 Bytes
fc00054 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 | # File Upload Guide: Where Each File Goes
This guide shows exactly which files are uploaded to which location (Hugging Face or GitHub) and when.
---
## Overview: Three Upload Destinations
1. **Hugging Face Dataset Repo** (`ananttripathiak/engine-maintenance-dataset`)
2. **Hugging Face Model Repo** (`ananttripathiak/engine-maintenance-model`)
3. **Hugging Face Space** (`ananttripathiak/engine-maintenance-space`)
4. **GitHub Repository** (`ananttripathi/engine-predictive-maintenance`)
---
## 1. Hugging Face Dataset Repo
**Repo ID**: `ananttripathiak/engine-maintenance-dataset`
**Created by**: `src/data_register.py` and `src/data_prep.py`
### Files Uploaded:
#### A. Raw Data (via `src/data_register.py`)
- **File**: `data/engine_data.csv`
- **Uploaded to**: `data/engine_data.csv` in the dataset repo
- **When**: Run `python src/data_register.py`
#### B. Processed Data (via `src/data_prep.py`)
- **File**: `data/processed/train.csv`
- **Uploaded to**: `data/train.csv` in the dataset repo
- **When**: Run `python src/data_prep.py`
- **File**: `data/processed/test.csv`
- **Uploaded to**: `data/test.csv` in the dataset repo
- **When**: Run `python src/data_prep.py`
**Scripts that upload here:**
- `src/data_register.py` β uploads raw data
- `src/data_prep.py` β uploads train/test splits
---
## 2. Hugging Face Model Repo
**Repo ID**: `ananttripathiak/engine-maintenance-model`
**Created by**: `src/train.py`
### Files Uploaded:
- **File**: `models/best_model.joblib`
- **Uploaded to**: `model.joblib` in the model repo
- **When**: Run `python src/train.py` (after training completes)
**Scripts that upload here:**
- `src/train.py` β uploads the trained model
---
## 3. Hugging Face Space (Streamlit App)
**Repo ID**: `ananttripathiak/engine-maintenance-space`
**Created by**: `src/deploy_to_hf.py`
### Files Uploaded:
The `src/deploy_to_hf.py` script uploads the entire project folder **except**:
- `data/` (ignored - too large)
- `mlruns/` (ignored - MLflow tracking data)
- `models/` (ignored - model is in model repo)
- `.github/` (ignored - GitHub-specific)
**Files that ARE uploaded to Space:**
- `src/app.py` β **Main Streamlit app**
- `src/inference.py` β Inference utilities
- `src/config.py` β Configuration
- `Dockerfile` β Container definition
- `requirements.txt` β Python dependencies
- `README.md` β Documentation
- Other `src/*.py` files (if needed by app)
**Scripts that upload here:**
- `src/deploy_to_hf.py` β uploads deployment files
---
## 4. GitHub Repository
**Repo URL**: `https://github.com/ananttripathi/engine-predictive-maintenance`
**Created by**: You (manually via `git push`)
### Files Uploaded:
**Everything in the `mlops/` folder**, including:
- β
`data/` (including `engine_data.csv`, `processed/train.csv`, `processed/test.csv`)
- β
`src/` (all Python scripts)
- β
`notebooks/` (EDA notebooks, etc.)
- β
`.github/workflows/pipeline.yml` β **GitHub Actions workflow**
- β
`requirements.txt`
- β
`Dockerfile`
- β
`README.md`
- β
`models/` (if you want to track model versions in git)
- β
`mlruns/` (MLflow tracking data - optional)
- β
All other project files
**How to upload:**
```bash
cd /Users/ananttripathi/Desktop/mlops
git init
git add .
git commit -m "Initial commit: Predictive maintenance MLOps pipeline"
git remote add origin https://github.com/ananttripathi/engine-predictive-maintenance.git
git push -u origin main
```
---
## Upload Workflow Summary
### Step-by-Step Upload Process:
1. **Data Registration** β Hugging Face Dataset Repo
```bash
python src/data_register.py
```
- Uploads: `data/engine_data.csv` β HF Dataset Repo
2. **Data Preparation** β Hugging Face Dataset Repo
```bash
python src/data_prep.py
```
- Uploads: `data/processed/train.csv` and `test.csv` β HF Dataset Repo
3. **Model Training** β Hugging Face Model Repo
```bash
python src/train.py
```
- Uploads: `models/best_model.joblib` β HF Model Repo
4. **Deploy App** β Hugging Face Space
```bash
python src/deploy_to_hf.py
```
- Uploads: `src/app.py`, `Dockerfile`, `requirements.txt`, etc. β HF Space
5. **Push to GitHub** β GitHub Repository
```bash
git add .
git commit -m "Complete MLOps pipeline"
git push origin main
```
- Uploads: Everything β GitHub Repo
---
## What Gets Uploaded Automatically vs Manually
### Automatic (via Scripts):
- β
Hugging Face Dataset Repo β `src/data_register.py` and `src/data_prep.py`
- β
Hugging Face Model Repo β `src/train.py`
- β
Hugging Face Space β `src/deploy_to_hf.py`
- β
GitHub Actions β Runs automatically when you push to GitHub
### Manual:
- β οΈ **GitHub Repository** β You need to run `git push` yourself
---
## File Size Considerations
### Large Files (may be ignored):
- `data/engine_data.csv` β Uploaded to HF Dataset, but you might want to add to `.gitignore` for GitHub
- `mlruns/` β MLflow tracking data (can be large) - ignored by HF Space deploy
- `models/best_model.joblib` β Uploaded to HF Model Repo, but you might want to add to `.gitignore` for GitHub
### Recommended `.gitignore`:
```
# Large data files
data/*.csv
data/processed/*.csv
# MLflow tracking
mlruns/
# Model files (already in HF Model Repo)
models/*.joblib
# Python cache
__pycache__/
*.pyc
.venv/
```
---
## Quick Reference Table
| File/Folder | HF Dataset | HF Model | HF Space | GitHub |
|------------|------------|----------|----------|--------|
| `data/engine_data.csv` | β
| β | β | β οΈ Optional |
| `data/processed/train.csv` | β
| β | β | β οΈ Optional |
| `data/processed/test.csv` | β
| β | β | β οΈ Optional |
| `models/best_model.joblib` | β | β
| β | β οΈ Optional |
| `src/app.py` | β | β | β
| β
|
| `src/train.py` | β | β | β | β
|
| `src/data_prep.py` | β | β | β | β
|
| `Dockerfile` | β | β | β
| β
|
| `requirements.txt` | β | β | β
| β
|
| `.github/workflows/pipeline.yml` | β | β | β | β
|
| `README.md` | β | β | β
| β
|
**Legend:**
- β
= Uploaded automatically or should be uploaded
- β = Not uploaded to this location
- β οΈ Optional = Can be uploaded but might want to exclude from GitHub due to size
---
## Need Help?
- **Hugging Face Dataset**: Check `src/hf_data_utils.py`
- **Hugging Face Model**: Check `src/hf_model_utils.py`
- **Hugging Face Space**: Check `src/deploy_to_hf.py`
- **GitHub**: Standard git commands
|