Deploy DeepFake Detector API - 2026-04-20 00:23:33

README.md

@@ -1,3 +1,13 @@
+---
+title: DeepFake Detector API
+emoji: 🎭
+colorFrom: blue
+colorTo: purple
+sdk: docker
+app_port: 7860
+pinned: false
+---
+
 # DeepFake Detector Backend
 
 FastAPI backend for detecting AI-generated (deepfake) images using a multi-model fusion pipeline.
@@ -16,7 +26,7 @@ FastAPI backend for detecting AI-generated (deepfake) images using a multi-model
 - pip
 
 ## Quick Start (Local)
-docker run -p 7860:7860 deepfake-detector-api
+
 ```bash
 cd backend
 
@@ -32,7 +42,11 @@ cp .env.example .env  # Windows PowerShell: Copy-Item .env.example .env
 
 # Run API
 uvicorn app.main:app --reload
-- copy backend files as-is (single `Dockerfile` setup)
+```
+
+API docs:
+
+- `http://localhost:8000/docs`
 - `http://localhost:8000/redoc`
 
 ## Environment Configuration
@@ -40,12 +54,13 @@ uvicorn app.main:app --reload
 Use [backend/.env.example](.env.example) as the source of truth.
 
 Common runtime variables:
+
 - `HF_FUSION_REPO_ID` (default: `DeepFakeDetector/fusion-logreg-final`)
 - `HF_CACHE_DIR` (default: `.hf_cache`)
 - `HF_TOKEN` (optional; required for private model repos or non-interactive HF auth)
 - `GOOGLE_API_KEY` (optional; required for Gemini explanations)
 - `HOST` (default: `0.0.0.0`)
-- `PORT` (default: `8000`)
+- `PORT` (default: `8000` locally, `7860` in Space by default)
 - `CORS_ORIGINS` (comma-separated origins)
 - `ENABLE_DEBUG`, `LOG_LEVEL`
 
@@ -77,26 +92,33 @@ Build and run locally:
 
 ```bash
 docker build -t deepfake-detector-api .
-docker run -p 8000:8000 deepfake-detector-api
+docker run -p 7860:7860 deepfake-detector-api
 ```
 
 ## Deploy to Hugging Face Spaces
 
-Recommended path is the Bash deploy script:
+Recommended path is the Bash deploy script.
 
 1. Configure [backend/.env](.env) from [backend/.env.example](.env.example)
 2. Ensure `HF_SPACE_URL` and related deploy variables are set
-3. Run from repo root:
+3. Run from backend folder:
 
 ```bash
 bash ./deploy-to-hf.sh
 ```
 
+Or run from repo root:
+
+```bash
+bash ./backend/deploy-to-hf.sh
+```
+
 The script will:
 
 - install Hugging Face CLI if needed
 - prompt/authenticate with HF (`hf auth login`) when required
 - clone Space repo into a separate temp deploy directory
+- copy backend files as-is (single `Dockerfile` setup)
 - commit and push to the HF Space
 
 After deploy, set Space secrets in Hugging Face:
@@ -104,6 +126,12 @@ After deploy, set Space secrets in Hugging Face:
 - `GOOGLE_API_KEY` (if using explanation endpoints)
 - `CORS_ORIGINS` (frontend domains)
 
+## Deploy to Railway
+
+- Set service root to `backend`
+- Configure required env vars (`CORS_ORIGINS`, `HF_FUSION_REPO_ID`, `HF_CACHE_DIR`, `PORT`)
+- Push to main branch to trigger deployment
+
 ## Troubleshooting
 
 - Build fails: inspect Space/Railway logs first
@@ -118,7 +146,15 @@ backend/
 ├── app/
 ├── tests/
 ├── Dockerfile
-├── Dockerfile.huggingface
+├── deploy-to-hf.sh
+├── deploy-to-hf.ps1
+├── requirements.txt
+└── README.md
+```
+
+## License
+
+MIT
 ├── deploy-to-hf.sh
 ├── deploy-to-hf.ps1
 ├── requirements.txt