Spaces:
Sleeping
Sleeping
File size: 17,426 Bytes
c09e844 |
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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 |
# 🏗️ Hugging Face Spaces Deployment Architecture
## 📊 High-Level Architecture
```
┌─────────────────────────────────────────────────────────────┐
│ HUGGING FACE SPACES │
│ (16GB RAM - Free) │
│ │
│ ┌───────────────────────────────────────────────────┐ │
│ │ Docker Container │ │
│ │ (User ID: 1000) │ │
│ │ │ │
│ │ ┌─────────────────────────────────────────┐ │ │
│ │ │ FastAPI Application │ │ │
│ │ │ (Port 7860) │ │ │
│ │ │ │ │ │
│ │ │ ┌──────────────┐ ┌──────────────┐ │ │ │
│ │ │ │ Uvicorn │ │ PhoBERT │ │ │ │
│ │ │ │ Server │ │ Model │ │ │ │
│ │ │ │ │ │ (~500MB) │ │ │ │
│ │ │ └──────────────┘ └──────────────┘ │ │ │
│ │ │ │ │ │
│ │ │ ┌──────────────┐ ┌──────────────┐ │ │ │
│ │ │ │ Jinja2 │ │ WordCloud │ │ │ │
│ │ │ │ Templates │ │ Generator │ │ │ │
│ │ │ └──────────────┘ └──────────────┘ │ │ │
│ │ └─────────────────────────────────────────┘ │ │
│ │ │ │
│ │ Environment Variables (from HF Secrets): │ │
│ │ - DATABASE_URL │ │
│ │ - SECRET_KEY │ │
│ └───────────────────────────────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
│
│ HTTPS
▼
┌────────────────────────┐
│ Users │
│ (Web Browsers) │
└────────────────────────┘
│
│
▼
┌─────────────────────────────────────────────────────────────┐
│ External PostgreSQL Database │
│ (Render / Neon / Other) │
│ │
│ ┌──────────────┐ ┌──────────────────────┐ │
│ │ Users │ │ PredictionHistory │ │
│ │ Table │────────▶│ Table │ │
│ │ │ FK │ │ │
│ └──────────────┘ └──────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
```
---
## 🔄 Request Flow
```
1. User visits Space URL
└─▶ https://huggingface.co/spaces/USERNAME/SPACE_NAME
│
▼
2. Hugging Face routes to Docker container (port 7860)
│
▼
3. Uvicorn receives HTTP request
│
├─▶ GET /docs → Swagger UI
├─▶ GET /dashboard → Jinja2 Template + TailwindCSS
├─▶ POST /api/auth/login → JWT Token
├─▶ POST /api/predict/single → PhoBERT Model
└─▶ POST /api/predict/batch → CSV Processing + WordCloud
│
▼
4. Database query (if needed)
└─▶ PostgreSQL on Render/Neon (via DATABASE_URL)
│
▼
5. Response returned to user
└─▶ JSON (API) or HTML (Pages)
```
---
## 🐳 Docker Build Process
```
1. Dockerfile Instructions
│
├─▶ FROM python:3.10-slim
│ └─ Base image (~150MB)
│
├─▶ RUN useradd -m -u 1000 user
│ └─ Create non-root user (HF requirement)
│
├─▶ COPY requirements.txt
│ └─ Copy dependencies first
│
├─▶ RUN pip install -r requirements.txt
│ └─ Install packages (~2GB with PyTorch)
│
├─▶ COPY --chown=user:user . .
│ └─ Copy application code
│
├─▶ RUN chmod -R 777 /app/app/static/uploads
│ └─ Set write permissions
│
├─▶ USER user
│ └─ Switch to non-root user
│
└─▶ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "7860"]
└─ Start application
Total Build Time: 5-10 minutes
Final Image Size: ~2.5GB
```
---
## 🔐 Security Layer
```
┌─────────────────────────────────────────────────────────────┐
│ Security Features │
├─────────────────────────────────────────────────────────────┤
│ │
│ 1. Authentication Layer │
│ ├─ JWT Tokens (24h expiration) │
│ ├─ Bcrypt password hashing │
│ └─ OAuth2 Bearer scheme │
│ │
│ 2. Network Security │
│ ├─ HTTPS (provided by HF) │
│ ├─ CORS configuration │
│ └─ PostgreSQL SSL (sslmode=require) │
│ │
│ 3. Secret Management │
│ ├─ Environment variables (HF Secrets) │
│ ├─ No hardcoded credentials │
│ └─ .dockerignore excludes .env │
│ │
│ 4. Container Security │
│ ├─ Non-root user (UID 1000) │
│ ├─ Read-only filesystem (except uploads) │
│ └─ Minimal base image │
│ │
└─────────────────────────────────────────────────────────────┘
```
---
## 💾 Storage Architecture
```
┌─────────────────────────────────────────────────────────────┐
│ Storage Locations │
├─────────────────────────────────────────────────────────────┤
│ │
│ Container Storage (Ephemeral - Resets on rebuild) │
│ ├─ /app/app/static/uploads/wordclouds/ │
│ │ └─ Word cloud images (temporary) │
│ └─ /app/app/database/ │
│ └─ SQLite fallback (dev only) │
│ │
│ External Storage (Persistent) │
│ └─ PostgreSQL Database (Render/Neon) │
│ ├─ users table │
│ ├─ prediction_history table │
│ └─ All user data & predictions │
│ │
│ Future Enhancements (Optional) │
│ └─ S3 / Cloudinary for file uploads │
│ └─ Persistent word clouds & CSVs │
│ │
└─────────────────────────────────────────────────────────────┘
```
---
## 🔌 Connection Flow
```
┌────────────────────────────────────────────────────────────┐
│ Database Connection Logic │
└────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────┐
│ app/database.py │
└─────────────────────┘
│
▼
┌─────────────────────────────────────┐
│ Check os.getenv("DATABASE_URL") │
└─────────────────────────────────────┘
│
┌──────┴──────┐
│ │
▼ ▼
✅ Found ❌ Not Found
│ │
│ ▼
│ ┌──────────────────┐
│ │ Use SQLite │
│ │ (Local Dev) │
│ └──────────────────┘
│
▼
┌──────────────────────────┐
│ Fix postgres:// URL │
│ (replace with │
│ postgresql://) │
└──────────────────────────┘
│
▼
┌──────────────────────────┐
│ Connect to PostgreSQL │
│ (Production on HF) │
└──────────────────────────┘
```
---
## 📈 Scalability Considerations
```
Current Setup (Free Tier):
├─ 16GB RAM (sufficient for >500MB model)
├─ Shared CPU (adequate for moderate traffic)
└─ Unlimited uptime (99.9% availability)
If Scaling Needed:
├─ Upgrade to Pro Space ($9/month)
│ └─ Better CPU, more RAM, priority support
├─ Database scaling
│ └─ Upgrade PostgreSQL plan on Render/Neon
├─ Add caching layer
│ └─ Redis for frequent queries
└─ Consider load balancing
└─ Multiple Space instances (advanced)
```
---
## 🔄 Deployment Workflow
```
┌──────────────────────────────────────────────────────────┐
│ Local Development │
│ ├─ Edit code │
│ ├─ Test with SQLite │
│ └─ Commit to Git │
└──────────────────────────────────────────────────────────┘
│
▼
┌──────────────────────────────────────────────────────────┐
│ Push to Hugging Face │
│ git push origin main │
└──────────────────────────────────────────────────────────┘
│
▼
┌──────────────────────────────────────────────────────────┐
│ HF Spaces Auto-Build │
│ ├─ Pull latest code │
│ ├─ Build Docker image (5-10 min) │
│ ├─ Run container on port 7860 │
│ └─ Inject environment variables │
└──────────────────────────────────────────────────────────┘
│
▼
┌──────────────────────────────────────────────────────────┐
│ Application Running │
│ ├─ Connect to PostgreSQL │
│ ├─ Load ML model into memory │
│ ├─ Start Uvicorn server │
│ └─ Ready to serve requests │
└──────────────────────────────────────────────────────────┘
```
---
## 📊 Resource Usage
```
Component Memory CPU Disk
─────────────────────────────────────────────────
Base Image ~150MB - ~150MB
Python Dependencies ~2GB - ~2GB
PhoBERT Model ~500MB High ~500MB
Application Code ~50MB Low ~50MB
Runtime Data ~100MB Medium ~100MB
─────────────────────────────────────────────────
TOTAL (approx) ~2.8GB - ~2.8GB
Hugging Face Provides: 16GB RAM (plenty of headroom)
```
---
## 🎯 Key Architectural Decisions
### Why Docker SDK?
✅ Heavy ML model (>500MB) needs more than 512MB RAM
✅ Full control over environment
✅ 16GB RAM on free tier
### Why External Database?
✅ Container is ephemeral (resets on rebuild)
✅ PostgreSQL provides persistence
✅ Easy to scale independently
### Why Port 7860?
✅ Hugging Face Spaces requirement
✅ Auto-routed by HF infrastructure
✅ HTTPS provided automatically
### Why Non-Root User?
✅ Security best practice
✅ Hugging Face Spaces requirement
✅ UID 1000 is standard
---
**This architecture provides:**
- ✅ High availability (99.9% uptime)
- ✅ Sufficient resources (16GB RAM)
- ✅ Secure deployment (JWT, SSL, non-root)
- ✅ Persistent storage (external DB)
- ✅ Cost-effective (free tier)
|