getaround-api / README.md
WissamH's picture
Update README.md
7e977f9 verified
metadata
title: Getaround API
emoji: 🚗
colorFrom: blue
colorTo: green
sdk: docker
pinned: false

🤖 Getaround – API de prédiction de prix

📌 Présentation

Cette API permet de prédire le prix de location journalier d’un véhicule à partir de ses caractéristiques grâce à un modèle de Machine Learning.

L’API a été développée avec FastAPI et déployée sur Hugging Face Spaces avec Docker.


🛠 Technologies utilisées

  • FastAPI
  • Scikit-learn
  • Joblib
  • Docker

📊 Performance du modèle

Métrique Valeur
RMSE 16.73
0.73

🔗 Liens de déploiement

🌐 API

https://wissamh-getaround-api.hf.space

📄 Documentation personnalisée

https://wissamh-getaround-api.hf.space/docs

🧪 Swagger

https://wissamh-getaround-api.hf.space/api-docs


🔗 Endpoints disponibles

Endpoint Description
/docs Documentation personnalisée
/api-docs Interface Swagger interactive
POST /predict Prédiction du prix

🤖 Endpoint de prédiction

POST /predict

Permet de prédire le prix journalier d’un véhicule.


📥 Exemple d’entrée

{
  "model_key": "Peugeot",
  "mileage": 50000,
  "engine_power": 120,
  "fuel": "diesel",
  "paint_color": "black",
  "car_type": "sedan",
  "private_parking_available": true,
  "has_gps": true,
  "has_air_conditioning": true,
  "automatic_car": false,
  "has_getaround_connect": true,
  "has_speed_regulator": true,
  "winter_tires": false
}

📤 Exemple de sortie

{
  "prix_location_par_jour": 100.35
}