CU1-X / DEPLOYMENT.md
Abdelkader HASSINE
Deploy CU1-X to Hugging Face Spaces
ff03012
|
raw
history blame
3.31 kB

🚀 Guide de Déploiement Hugging Face Spaces

📋 Scripts Disponibles

1. check_hf_space.sh - Vérification Pré-Déploiement

Vérifie que tout est prêt avant de déployer:

./check_hf_space.sh

Vérifie:

  • ✅ Python version (>= 3.12)
  • ✅ Fichiers requis (app.py, requirements.txt, etc.)
  • ✅ Répertoires requis (detection/, api/, ui/, rfdetr/)
  • ✅ model.pth présent et tracké par Git LFS
  • ✅ Configuration Git LFS
  • ✅ Métadonnées README.md (frontmatter YAML)
  • ✅ requirements.txt complet
  • ✅ Syntaxe Python valide
  • ✅ Configuration Git et remote HF
  • ✅ Connexion Hugging Face CLI

2. deploy_hf_space.sh - Déploiement Automatique

Déploie automatiquement vers Hugging Face Spaces:

./deploy_hf_space.sh

Fait automatiquement:

  • ✅ Configure Git LFS pour model.pth
  • ✅ Vérifie/configure le remote HF
  • ✅ Vérifie la connexion HF
  • ✅ Met à jour requirements.txt si nécessaire
  • ✅ Stage tous les fichiers
  • ✅ Commit avec message descriptif
  • ✅ Push vers HF Spaces
  • ✅ Affiche l'URL du Space

🎯 Workflow Recommandé

Étape 1: Vérifier

./check_hf_space.sh

Résultat attendu:

✅ All checks passed! Ready to deploy! ✨

Étape 2: Déployer

./deploy_hf_space.sh

Le script va:

  1. Vérifier Git LFS
  2. Configurer le remote si nécessaire
  3. Vérifier la connexion HF
  4. Commit et push
  5. Afficher l'URL du Space

Étape 3: Suivre le Build

Le script affichera l'URL de votre Space:

https://huggingface.co/spaces/YOUR_USERNAME/CU1-X

Cliquez sur "Logs" pour voir le build en direct.

📡 Accéder à l'API

Une fois déployé, votre API est accessible via:

API Gradio Native

from gradio_client import Client

client = Client("AI-DrivenTesting/CU1-X")
result = client.predict(
    "screenshot.png",
    0.35, 2, True, True, False, False, "Only image & button",
    False, "RF-DETR Optimized (Recommended)", "standard",
    api_name="/predict"
)

Voir: API_USAGE.md pour plus de détails

🔧 Dépannage

Erreur: "Git LFS not installed"

# macOS
brew install git-lfs
git lfs install

# Linux
sudo apt install git-lfs
git lfs install

Erreur: "Not logged in"

hf login
# OU
huggingface-cli login

Erreur: "model.pth not tracked by LFS"

git lfs track "*.pth"
git add .gitattributes model.pth
git commit -m "Add model with LFS"

Erreur: "No remote configured"

Le script deploy_hf_space.sh vous demandera de configurer le remote automatiquement.

Ou manuellement:

git remote add origin https://huggingface.co/spaces/YOUR_USERNAME/CU1-X

📊 Checklist Rapide

Avant de déployer:

  • ./check_hf_space.sh passe tous les tests
  • Git LFS installé et configuré
  • Connecté à Hugging Face (hf login)
  • model.pth présent (~510MB)
  • Remote HF configuré

Pour déployer:

./deploy_hf_space.sh

🎉 Après le Déploiement

Votre Space sera accessible à:

  • Interface Web: https://huggingface.co/spaces/YOUR_USERNAME/CU1-X
  • API: https://YOUR_USERNAME-CU1-X.hf.space/api/predict

Temps de build: 5-10 minutes (première fois)


Besoin d'aide? Consultez API_USAGE.md pour utiliser l'API!