clovershield_ml_api / README.md
GitHub Action
Sync from GitHub: 2668d117b8c7350141bfb2b961326f23525f8a4f
148eb86
|
Raw History Blame Contribute Delete
995 Bytes
metadata
title: CloverShield ML API
emoji: πŸ›‘οΈ
colorFrom: green
colorTo: blue
sdk: docker
app_port: 7860
pinned: false

CloverShield ML Inference API

The Sovereign AI engine for the CloverShield Fraud Analyst Workstation.

πŸš€ Overview

This is a FastAPI microservice containerized with Docker. It provides:

  • Real-time fraud probability scoring (XGBoost)
  • Feature Engineering pipeline (Graph + Temporal features)
  • Explainable AI (SHAP values)
  • LLM-based narrative generation

πŸ› οΈ Deployment

This service is designed for:

  1. On-Premise: Via docker-compose (see root README)
  2. Hugging Face Spaces: Auto-detected via the YAML metadata above.

πŸ”§ Configuration

Key environment variables:

  • MODEL_PATH: Path to the .pkl model file.
  • GROQ_API_KEY: (Optional) For generating text explanations.
  • MAX_FIT_ROWS: Limits memory usage during feature engineering.

Note: This README serves as the configuration entry point for Hugging Face Spaces.