shmWorks/Retail-IQ

The Retail Forecasting System is a machine learning-based web application that predicts future sales using historical retail data. It uses models like XGBoost for accurate forecasting and is deployed through Flask, allowing users to input data and get real-time predictions. The system helps businesses make better data-driven decisions

โ˜… 0Forks 0Jupyter NotebookGitHub โ†—Compare

README

Retail-IQ: Professional Retail Forecasting System

๐Ÿ“Œ Overview

Retail-IQ = ML sales forecast system. Modular architecture handle big time-series data, feature engineering, auto reports.

๐Ÿ“‚ Project Structure

Retail-IQ/
โ”œโ”€โ”€ data/
โ”‚   โ”œโ”€โ”€ raw/                # Unmodified input CSVs
โ”‚   โ””โ”€โ”€ processed/          # Cleaned and featured datasets
โ”œโ”€โ”€ docs/                   # Project documentation and reports
โ”œโ”€โ”€ notebooks/              # Jupyter notebooks for experimentation
โ”œโ”€โ”€ outputs/
โ”‚   โ”œโ”€โ”€ figures/            # Generated plots and visualizations
โ”‚   โ”œโ”€โ”€ models/             # Serialized model files (.pkl, .json)
โ”‚   โ””โ”€โ”€ logs/               # Processing and error logs
โ”œโ”€โ”€ src/
โ”‚   โ””โ”€โ”€ retail_iq/          # Core Python package
โ”‚       โ”œโ”€โ”€ config.py       # Centralized path and config management
โ”‚       โ”œโ”€โ”€ preprocessing.py # Data loading and cleaning
โ”‚       โ”œโ”€โ”€ features.py      # Feature engineering logic
โ”‚       โ””โ”€โ”€ visualization.py # Plotting utilities
โ”œโ”€โ”€ tests/                  # Unit and integration tests
โ”œโ”€โ”€ pyproject.toml          # Project metadata and dependencies
โ””โ”€โ”€ requirements.txt        # Legacy dependency list

๐Ÿš€ Getting Started

1. Setup Environment

# Using uv (recommended)
uv venv
source .venv/bin/activate  # or .venv\Scripts\activate on Windows
uv pip install -e .

2. Run Analysis

Open notebooks/eda.ipynb, run all cells, generate EDA reports.

๐Ÿ›  Tech Stack

  • ML: Scikit-learn, XGBoost, Statsmodels
  • Data: Pandas, NumPy
  • Visuals: Matplotlib, Seaborn
  • API: Flask
  • DevOps: Pathlib (robust paths), Setuptools (package mgmt)

Contributors

shmWorksaayeshh

Issues