Upload README.md with huggingface_hub

README.md

@@ -1,10 +1,64 @@
----
-title: Superkart Api
-emoji: 💻
-colorFrom: red
-colorTo: gray
-sdk: docker
-pinned: false
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+---
+title: SuperKart Sales Forecasting API
+emoji: 🛋️
+colorFrom: blue
+colorTo: green
+sdk: docker
+app_port: 8080
+pinned: false
+---
+
+# SuperKart Sales Forecasting API
+
+## Overview
+Production-ready Flask API for predicting SuperKart sales using machine learning.
+
+## Features
+- Single prediction endpoint
+- Batch prediction support
+- Input validation and error handling
+- Health monitoring
+- Model information endpoint
+- CORS support
+- Production-ready configuration
+
+## Endpoints
+- `GET /` - API information
+- `GET /health` - Health check
+- `GET /model_info` - Model details
+- `POST /predict` - Single prediction
+- `POST /batch_predict` - Batch predictions
+
+## Local Development
+```bash
+pip install -r requirements.txt
+python app.py
+```
+
+## Docker Deployment
+```bash
+docker build -t superkart-api .
+docker run -p 8080:8080 superkart-api
+```
+
+## Sample Request
+```json
+{
+    "Product_Weight": 10.5,
+    "Product_Sugar_Content": "Low Sugar",
+    "Product_Allocated_Area": 0.15,
+    "Product_Type": "Fruits and Vegetables",
+    "Product_MRP": 150.0,
+    "Store_Size": "Medium",
+    "Store_Location_City_Type": "Tier 2",
+    "Store_Type": "Supermarket Type2",
+    "Store_Age": 15
+}
+```
+
+## Model Information
+- Model: Random Forest (Tuned)
+- Accuracy: High precision sales forecasting
+- Input Features: 9 core features + engineered features
+- Output: Predicted sales value
+