Spaces:
Sleeping
Sleeping
GitHub Action commited on
Commit ·
148eb86
1
Parent(s): e710d79
Sync from GitHub: 2668d117b8c7350141bfb2b961326f23525f8a4f
Browse files
README.md
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: CloverShield ML API
|
| 3 |
+
emoji: 🛡️
|
| 4 |
+
colorFrom: green
|
| 5 |
+
colorTo: blue
|
| 6 |
+
sdk: docker
|
| 7 |
+
app_port: 7860
|
| 8 |
+
pinned: false
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# CloverShield ML Inference API
|
| 12 |
+
|
| 13 |
+
The Sovereign AI engine for the CloverShield Fraud Analyst Workstation.
|
| 14 |
+
|
| 15 |
+
## 🚀 Overview
|
| 16 |
+
|
| 17 |
+
This is a **FastAPI** microservice containerized with **Docker**. It provides:
|
| 18 |
+
- Real-time fraud probability scoring (XGBoost)
|
| 19 |
+
- Feature Engineering pipeline (Graph + Temporal features)
|
| 20 |
+
- Explainable AI (SHAP values)
|
| 21 |
+
- LLM-based narrative generation
|
| 22 |
+
|
| 23 |
+
## 🛠️ Deployment
|
| 24 |
+
|
| 25 |
+
This service is designed for:
|
| 26 |
+
1. **On-Premise:** Via `docker-compose` (see root README)
|
| 27 |
+
2. **Hugging Face Spaces:** Auto-detected via the YAML metadata above.
|
| 28 |
+
|
| 29 |
+
## 🔧 Configuration
|
| 30 |
+
|
| 31 |
+
Key environment variables:
|
| 32 |
+
- `MODEL_PATH`: Path to the `.pkl` model file.
|
| 33 |
+
- `GROQ_API_KEY`: (Optional) For generating text explanations.
|
| 34 |
+
- `MAX_FIT_ROWS`: Limits memory usage during feature engineering.
|
| 35 |
+
|
| 36 |
+
*Note: This README serves as the configuration entry point for Hugging Face Spaces.*
|