# shivharerachit/autovaluator architecture

> Architecture diagram of the GitHub repository shivharerachit/autovaluator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/shivharerachit/autovaluator
- Repository: https://github.com/shivharerachit/autovaluator

## Overview

##### Project type and purpose
- AutoValuator is a lightweight web application whose goal is to predict used‐car prices.
- It consists of a static front end (HTML/JS) and a Python Flask backend that hosts a pre‐trained ML model.
- The “Model” folder also contains a Jupyter notebook and data for offline training, but at runtime only the pickle file and column metadata are required.

##### File structure
- Top level
- .gitignore – standard VCS exclusions
- README.md – project name (“AutoValuator”)
- Documentation/ – PDF reports (not part of runtime)
- FrontEnd/index.html – single‐page UI for collecting input features and displaying results
- Model/
– PredictCarPrice.pkl – serialized ML model
– column_names.txt – feature ordering info
– flask-api.py – Flask app exposing a “/predict” endpoint
– requirements.txt – Python deps (Flask, scikit‐learn, pandas, etc.)
– cardekho_dataset.csv & TrainingModel.ipynb – offline training pipeline

##### README
- The README only names the project but does not detail architecture. All architectural clues come from file names & structure.

##### Detail
- Essential runtime pieces—static front end, REST endpoint, model files.
- Avoid over-splitting; focus on the clear boundaries and interactions described above.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Device
    Browser["Browser"]:::frontend

    %% Front-End Layer
    subgraph "Front-End (Client)"
        FE["FrontEnd/index.html"]:::frontend
    end

    %% Back-End Layer
    subgraph "Back-End (API Server)"
        API["flask-api.py\n(Flask, Python, scikit-learn)"]:::backend
        REQS["requirements.txt"]:::data
    end

    %% Runtime Artifacts
    subgraph "Model Store (Runtime Artifacts)"
        PKL["PredictCarPrice.pkl"]:::data
        COL["column_names.txt"]:::data
    end

    %% Offline Training Pipeline
    subgraph "Offline Training Pipeline"
        TNB["TrainingModel.ipynb"]:::offline
        CSV["cardekho_dataset.csv"]:::offline
    end

    %% Documentation & README
    subgraph "Documentation & Overview"
        DOC1["FinalReport.pdf"]:::offline
        DOC2["SynopsisReport.pdf"]:::offline
        README["README.md"]:::offline
    end

    %% Relationships
    Browser -->|"loads static HTML"| FE
    FE -->|"POST /predict\n(JSON payload)"| API
    API -->|"loads model artifacts"| PKL
    API -->|"loads model artifacts"| COL
    API -->|"uses dependencies"| REQS
    API -->|"returns JSON\n(predicted price)"| FE

    %% Click Events
    click FE "https://github.com/shivharerachit/autovaluator/blob/main/FrontEnd/index.html"
    click API "https://github.com/shivharerachit/autovaluator/blob/main/Model/flask-api.py"
    click PKL "https://github.com/shivharerachit/autovaluator/blob/main/Model/PredictCarPrice.pkl"
    click COL "https://github.com/shivharerachit/autovaluator/blob/main/Model/column_names.txt"
    click TNB "https://github.com/shivharerachit/autovaluator/blob/main/Model/TrainingModel.ipynb"
    click CSV "https://github.com/shivharerachit/autovaluator/blob/main/Model/cardekho_dataset.csv"
    click REQS "https://github.com/shivharerachit/autovaluator/blob/main/Model/requirements.txt"
    click DOC1 "https://github.com/shivharerachit/autovaluator/blob/main/Documentation/FinalReport.pdf"
    click DOC2 "https://github.com/shivharerachit/autovaluator/blob/main/Documentation/SynopsisReport.pdf"
    click README "https://github.com/shivharerachit/autovaluator/blob/main/README.md"

    %% Styles
    classDef frontend fill:#AED6F1,stroke:#3498DB,color:#1B4F72
    classDef backend fill:#A9DFBF,stroke:#27AE60,color:#145A32
    classDef data fill:#F9E79F,stroke:#F1C40F,color:#7D6608
    classDef offline fill:#E5E7E9,stroke:#A6ACAF,color:#424949,stroke-dasharray: 5 5
```
