app.py

# Import necessary libraries
import numpy as np
import joblib  # For loading the serialized model
import pandas as pd  # For data manipulation
from flask import Flask, request, jsonify  # For creating the Flask API

# Initialize the Flask application
product_store_sales_api = Flask("Product Store Sales Predictor")

# Load the trained machine learning model
model = joblib.load("superkart_sales_forecast_model_v1_0.joblib")

# Define a route for the home page (GET request)
@product_store_sales_api.get('/')
def home():
    """
    This function handles GET requests to the root URL ('/') of the API.
    It returns a simple welcome message.
    """
    return "Welcome to the SuperKart Store Sales Prediction API!"

# Define an endpoint for single property prediction (POST request)
@product_store_sales_api.post('/v1/forecast')
def predict_store_sales():
    """
    This function handles POST requests to the '/v1/forecast' endpoint.
    It expects a JSON payload containing property details and returns
    the predicted store sales as a JSON response.
    """
    # Get the JSON data from the request body
    store_data = request.get_json()

    # Extract relevant features from the JSON data
    sample = {
        'Product_Weight': store_data['Product_Weight'],
        'Product_Sugar_Content': store_data['Product_Sugar_Content'],
        'Product_Allocated_Area': store_data['Product_Allocated_Area'],
        'Product_Type': store_data['Product_Type'],
        'Product_MRP': store_data['Product_MRP'],
        'Store_Id': store_data['Store_Id'],
        'Store_Establishment_Year': store_data['Store_Establishment_Year'],
        'Store_Size': store_data['Store_Size'],
        'Store_Location_City_Type': store_data['Store_Location_City_Type'],
        'Store_Type': store_data['Store_Type']
    }

    # Convert the extracted data into a Pandas DataFrame
    input_data = pd.DataFrame([sample])

    # Make prediction of sales
    predicted_sales = model.predict(input_data)[0]

    # Convert predicted_price to Python float
    predicted_sales = round(float(predicted_sales), 2)
    # The conversion above is needed as we convert the model prediction (log price) to actual price using np.exp, which returns predictions as NumPy float32 values.
    # When we send this value directly within a JSON response, Flask's jsonify function encounters a datatype error

    # Return the actual price
    return jsonify({'Predicted Sales (in dollars)': predicted_sales})


# Define an endpoint for batch prediction (POST request)
@product_store_sales_api.post('/v1/forecastbatch')
def predict_rental_price_batch():
    """
    This function handles POST requests to the '/v1/forecastbatch' endpoint.
    It expects a CSV file containing details for multiple stores
    and returns the predicted rental prices as a dictionary in the JSON response.
    """
    # Get the uploaded CSV file from the request
    file = request.files['file']

    # Read the CSV file into a Pandas DataFrame
    input_data = pd.read_csv(file)

    # Make predictions for all properties in the DataFrame (get sales)
    predicted_sales = model.predict(input_data).tolist()

    # Create a dictionary of predictions with product IDs as keys
    product_ids = input_data['Product_Id'].tolist()  # Assuming 'product_id' is the product ID column
    output_dict = dict(zip(product_ids, predicted_sales))  # Use actual sales

    # Return the predictions dictionary as a JSON response
    return output_dict

# Run the Flask application in debug mode if this script is executed directly
if __name__ == '__main__':
    product_store_sales_api.run(debug=True)