Housing-API / README.md
AbrahamKlb's picture
Update README.md
bad35ad verified
|
Raw History Blame Contribute Delete
2.55 kB
metadata
title: Housing API
emoji: 😻
colorFrom: yellow
colorTo: purple
sdk: docker
pinned: false

API-Housing-Price-Prediction

Documentation pour le Repository de l'API

📖 Description du Projet

Ce repository contient le code source de l'API de prédiction des prix des maisons utilisant FastAPI. Cette API prend en entrée diverses caractéristiques d'une maison et renvoie le prix prédit.

🚀 Installation

Suivez les étapes ci-dessous pour installer et exécuter l'API en local.

  1. Cloner le Repository :

    git clone https://github.com/abrahamkoloboe27/API-Housing-Price-Prediction.git
    cd API-Housing-Price-Prediction
    
  2. Créer et Activer un Environnement Virtuel :

    python -m venv venv
    source venv/bin/activate  # Sur Windows, utilisez `venv\Scripts\activate`
    
  3. Installer les Dépendances :

    pip install -r requirements.txt
    
  4. Lancer l'API :

    uvicorn api:app --reload
    

📝 Utilisation

Une fois l'API en cours d'exécution, vous pouvez envoyer des requêtes POST à l'endpoint /predict avec les caractéristiques de la maison pour obtenir une prédiction de prix.

📄 Exemple de Requête avec curl

curl -X POST "http://127.0.0.1:8000/predict" -H "Content-Type: application/json" -d '{
    "area": 2640,
    "bedrooms": 2,
    "bathrooms": 1,
    "stories": 1,
    "mainroad": "no",
    "guestroom": "no",
    "basement": "no",
    "hotwaterheating": "no",
    "airconditioning": "no",
    "parking": 1,
    "prefarea": "no",
    "furnishingstatus": "furnished"
}'

📄 Exemple de Requête avec JavaScript

fetch("http://127.0.0.1:8000/predict", {
    method: "POST",
    headers: {
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        area: 2640,
        bedrooms: 2,
        bathrooms: 1,
        stories: 1,
        mainroad: "no",
        guestroom: "no",
        basement: "no",
        hotwaterheating: "no",
        airconditioning: "no",
        parking: 1,
        prefarea: "no",
        furnishingstatus: "furnished"
    })
})
.then(response => response.json())
.then(data => console.log(data));

🔗 Liens Utiles

📧 Contact

Pour toute question ou suggestion, veuillez contacter Abraham KOLOBOE à l'adresse email abklb27@gmail.com.