# aadityachachra/aqi-predictor architecture

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

- Interactive diagram: https://gitdiagram.com/aadityachachra/aqi-predictor
- Repository: https://github.com/aadityachachra/aqi-predictor

## Overview

##### Project Overview
- This is a machine learning project focused on predicting air quality levels (AQI) using historical pollution data.
- It leverages TensorFlow for model training and TensorFlow Lite for deployment on resource-constrained devices such as mobile or embedded systems.
- The system includes components for data processing, model training/testing, model conversion, and result visualization.

##### Identifying the Main Components
- Data Layer:
- Raw Data Storage: Represented by the “Data” directory, which contains historical AQI data files, including archived and processed data.
- Processed Data (FinalData): Used for training the model.
- Model Development & Training Module:
- Training Scripts: Located in the “src” folder (e.g., train.py) that preprocess the data, build the neural network, and perform training.
- Testing and Accuracy Evaluation: Additional scripts (e.g., aqiTesting.py, accuracyCalDaily.py) that evaluate model performance.
- Model Conversion:
- Conversion to TensorFlow Lite: The final model converted to a .tflite file in the “FinalModel” directory.
- Visualization Module:
- Visual Presentation: The “Visualisation” folder holds directories for daily and monthly comparisons that display actual versus predicted AQI trends.
- Optional/Supporting Elements:
- Utility Scripts: Other scripts within “src” (e.g., 3DaysTesting.py) that may perform short-term forecasts or interface testing.

##### Highlighting Relationships and Data Flow
- Data Flow:
- Raw AQI data is first acquired and stored in the Data directories.
- The data preparation process (handled by scripts in “src”) cleans, formats, and converts the raw data for model training.
- Model Training Pipeline:
- A sequential neural network (with layers described in the README) is built and trained using TensorFlow.
- Followed by a model testing phase where predictions are evaluated.
- Model Conversion Process:
- Post training/testing, the model is converted to TensorFlow Lite format so it can be deployed on low-power devices.
- Visualization Flow:
- Prediction outputs from the model are aggregated (hourly into daily/monthly) and then visualized to compare against actual observed data.
- Interaction Outlines:

##### Architectural Patterns and Technologies
- The design follows a typical data pipeline pattern:
- Input (data collection and preprocessing) → Processing (model training and testing) → Output (model conversion and visualization).
- Key technologies include:
- TensorFlow for training the sequential neural network.
- TensorFlow Lite for converting the model which enables deployment on embedded/mobile systems.
- Python for scripting (with modules handling different tasks inside “src”).
- The modular separation (data handling, model training, conversion, and visualization) allows each component to be developed, modified, and maintained independently.

##### Final Checklist for the Principal Software Engineer
- Nodes for each component:
- “Data Collection & Storage” (showing both “Data/FinalData” and “Data/archive”).
- “Data Preprocessing & Preparation” (scripts in “src”).
- “Model Training Component” (train.py and its underlying neural network architecture).
- “Model Testing & Evaluation” (accuracy calculation scripts and testing modules).
- “Model Conversion to TF Lite” (output directed to “FinalModel/aqiPredictionModel.tflite”).
- “Visualization & Comparison Module” (from the “Visualisation” directory).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Data Layer
    subgraph "Data Layer"
        raw_data["Raw Data Storage"]:::data
        processed_data["Processed Data Storage"]:::data
    end

    %% Preprocessing & Training Layer
    subgraph "Preprocessing & Training"
        preprocessing["Data Preprocessing & Preparation"]:::processing
        train_component["Model Training Component (train.py)"]:::training
    end

    %% Model Testing & Evaluation
    subgraph "Model Testing & Evaluation"
        aqi_testing["aqiTesting.py"]:::testing
        acc_cal_daily["accuracyCalDaily.py"]:::testing
        acc_calc_hourly["accuracyCalcHourly.py"]:::testing
        acc_calc_monthly["accuracyCalcMonthly.py"]:::testing
        three_days_testing["3DaysTesting.py"]:::testing
    end

    %% Model Conversion
    conversion["TF Lite Conversion"]:::conversion

    %% Visualization & Comparison Module
    subgraph "Visualization & Comparison Module"
        visual_daily["Daily AQI Comparisons"]:::visualization
        visual_monthly["Monthly AQI Comparisons"]:::visualization
    end

    %% Connections
    raw_data -->|"raw data"| preprocessing
    processed_data -->|"processed data"| preprocessing
    preprocessing -->|"prepares data"| train_component
    train_component -->|"evaluates model"| aqi_testing
    train_component -->|"evaluates model"| acc_cal_daily
    train_component -->|"evaluates model"| acc_calc_hourly
    train_component -->|"evaluates model"| acc_calc_monthly
    train_component -->|"evaluates model"| three_days_testing
    train_component -->|"produces model"| conversion
    conversion -->|"model output"| visual_daily
    conversion -->|"model output"| visual_monthly

    %% Click Events
    click raw_data "https://github.com/aadityachachra/aqi-predictor/tree/main/Data/archive"
    click processed_data "https://github.com/aadityachachra/aqi-predictor/tree/main/Data/FinalData"
    click preprocessing "https://github.com/aadityachachra/aqi-predictor/tree/main/src"
    click train_component "https://github.com/aadityachachra/aqi-predictor/blob/main/src/train.py"
    click aqi_testing "https://github.com/aadityachachra/aqi-predictor/blob/main/src/aqiTesting.py"
    click acc_cal_daily "https://github.com/aadityachachra/aqi-predictor/blob/main/src/accuracyCalDaily.py"
    click acc_calc_hourly "https://github.com/aadityachachra/aqi-predictor/blob/main/src/accuracyCalcHourly.py"
    click acc_calc_monthly "https://github.com/aadityachachra/aqi-predictor/blob/main/src/accuracyCalcMonthly.py"
    click three_days_testing "https://github.com/aadityachachra/aqi-predictor/blob/main/src/3DaysTesting.py"
    click conversion "https://github.com/aadityachachra/aqi-predictor/blob/main/FinalModel/aqiPredictionModel.tflite"
    click visual_daily "https://github.com/aadityachachra/aqi-predictor/tree/main/Visualisation/DailyAQIComparisons"
    click visual_monthly "https://github.com/aadityachachra/aqi-predictor/tree/main/Visualisation/MonthlyAQIComparisons"

    %% Styles
    classDef data fill:#AED6F1,stroke:#333,stroke-width:2px;
    classDef processing fill:#A9DFBF,stroke:#333,stroke-width:2px;
    classDef training fill:#F9E79F,stroke:#333,stroke-width:2px;
    classDef testing fill:#F5B7B1,stroke:#333,stroke-width:2px;
    classDef conversion fill:#D2B4DE,stroke:#333,stroke-width:2px;
    classDef visualization fill:#FAD7A0,stroke:#333,stroke-width:2px;
```
