feat: add MIT license, automate HuggingFace synchronization, and update project documentation

.github/workflows/sync_to_hf.yml

@@ -0,0 +1,35 @@
+name: Sync to Hugging Face Spaces
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  sync-to-hub:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          lfs: true
+
+      - name: Install Git LFS
+        run: git lfs install
+
+      - name: Push to Hugging Face
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: |
+          # Configure Git
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
+          
+          # Remove GitHub-specific workflows to keep HF clean
+          rm -rf .github
+          git add .
+          git commit -m "chore: sync to huggingface (clean)" || echo "No changes to commit"
+          
+          # Force push to HuggingFace Spaces
+          git push --force https://0xarchit:$HF_TOKEN@huggingface.co/spaces/0xarchit/ml-assignment main

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Archit Jain
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -7,35 +7,65 @@ sdk: docker
 app_port: 7860
 ---
 
-# Inference Studio
+# ML Lab Assignment | Inference Studio
 
-A premium, highly asynchronous web interface for machine learning model inference built with FastAPI and Jinja2.
+A premium, highly asynchronous web interface for machine learning model inference. This project serves as a comprehensive playground for testing and interpreting three distinct predictive models using **FastAPI**, **Jinja2**, and **SHAP** explainability.
 
 ## Features
-- **Triple Model Support**: Switch between Shopping Trends, F1 Strategy, and Sleep Health models.
-- **Hot Loading**: Seamless transition between models without page refreshes.
-- **Architectural Specs**: Deep dive into dataset distributions and model metrics.
-- **Cyber-Industrial UI**: Glassmorphism aesthetic with high-contrast data visualization.
-- **Auto-Inject Testing**: Quickly test models with real samples from the datasets.
-
-## Setup
-1. Install dependencies:
+
+- **Multi-Model Support**: Seamlessly switch between Consumer Trends, F1 Pit Strategy, and Sleep Health models.
+- **Deep Interpretability**: Real-time **SHAP Diverging Charts** visualizing feature contributions.
+- **Neural UI/UX**: Cyber-Industrial aesthetic with glassmorphism, fluid animations, and dark-mode optimization.
+- **Data Injection**: "Auto-Inject" feature to quickly test models with real samples from the datasets.
+- **HuggingFace Ready**: Fully containerized and optimized for deployment on HF Spaces.
+
+## Project Structure
+
+```text
+.
+├── dataset/                # Source CSV files from Kaggle
+├── inference/
+│   ├── app.py              # FastAPI Backend with SHAP Integration
+│   └── template/           # Frontend (HTML, CSS, JS)
+├── notebooks/              # Jupyter Notebooks for model training
+├── outputs/                # Trained model artifacts (.joblib) and performance metrics
+├── Dockerfile              # Multi-stage Docker configuration
+├── .gitattributes          # LFS tracking for datasets and models
+```
+
+## Datasets & Models
+
+| Model | Target | Dataset Source |
+|-------|--------|----------------|
+| **Consumer Trends** | Category Prediction | [Kaggle Link](https://www.kaggle.com/datasets/minahilfatima12328/consumer-shopping-trends-analysis) |
+| **F1 Pit Strategy** | Pit Stop Next Lap | [Kaggle Link](https://www.kaggle.com/datasets/aadigupta1601/f1-strategy-dataset-pit-stop-prediction) |
+| **Sleep Health** | Sleep Disorder Classifier | [Kaggle Link](https://www.kaggle.com/datasets/mohankrishnathalla/sleep-health-and-daily-performance-dataset) |
+
+## Local Development
+1. **Setup Environment**:
    ```bash
+   python -m venv .venv
+   source .venv/bin/activate  # or .venv\Scripts\activate on Windows
    pip install -r requirements.txt
    ```
-2. Run the server:
+
+2. **Run Server**:
    ```bash
    uvicorn inference.app:app --reload
    ```
 
-## Deployment
-This project is pre-configured for HuggingFace Spaces.
-1. Create a new Space with the Docker SDK.
-2. Upload the repository contents.
-3. The Space will automatically build and deploy via the included `Dockerfile`.
-
-## Structure
-- `inference/app.py`: FastAPI backend with async inference logic.
-- `inference/template/`: Frontend assets (HTML, CSS, JS).
-- `outputs/`: Trained model artifacts and metrics.
-- `dataset/`: Source datasets for feature engineering.
+3. **Access UI**: Open `http://127.0.0.1:8000`
+
+
+## Technology Stack
+- **Backend**: FastAPI (Python 3.11)
+- **Explainability**: SHAP (SHapley Additive exPlanations)
+- **Frontend**: Vanilla CSS, JS (ES6+), Jinja2 Templates
+- **Containerization**: Docker
+- **ML Engine**: Scikit-Learn, XGBoost, Joblib
+
+## License
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
+*Created as part of the B.Tech Semester 04 Machine Learning Lab Assignment.*