# attiqrafiq/aqi_prediction_model architecture

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

- Interactive diagram: https://gitdiagram.com/attiqrafiq/aqi_prediction_model
- Repository: https://github.com/attiqrafiq/aqi_prediction_model

## Overview

##### Project type and purpose
- This is an end-to-end machine-learning pipeline focused on Air Quality Index (AQI) data for Pakistan.
- It ingests raw time-series pollutant measurements, applies Pakistan’s AQI standard, trains multiple models, evaluates them, and produces a comparison report.

a. Data Sources & Reference Materials
- “final AQI 19-23.csv” / “air_quality_with_AQI.txt” – raw pollutant measurements
- “AQI Standards in Pakistan.docx” – rulebook for AQI calculation
b. Preprocessing Stage
- Component: AQI_preprocessing.ipynb
- Inputs: raw CSV/TXT, standards doc
- Output: “air_quality_with_AQI.csv”
c. Model Training & Evaluation Stage
- Component: model_training_and_evaluation.ipynb
- Inputs: “air_quality_with_AQI.csv”
- Actions: feature engineering, classical and deep-learning model training
- Outputs: trained model artifacts, metrics, “model_comparison_results.csv”
d. Dependency Management
- requirements.txt – Python libraries (pandas, sklearn, tensorflow, etc.)
e. Final Reports
- model_comparison_results.csv
- any charts/notebook outputs

##### Architectural patterns & design principles
- Pipeline/Micro-batch: Each notebook is a pipeline stage.
- Separation of concerns: preprocessing logic separate from modeling logic.
- Reproducibility: requirements.txt captures environment.
- Modularity: easy to swap in/out different model algorithms.

##### Relevant technologies
- Python + Jupyter Notebooks
- pandas, numpy for ETL
- scikit-learn and deep-learning frameworks (e.g., TensorFlow/Keras) for modeling
- CSV as data interchange format

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Local Environment"
        RawCSV(("final AQI 19-23.csv")):::datastore
        RawTXT(("air_quality_with_AQI.txt")):::datastore
        Standards["AQI Standards in Pakistan.docx"]:::datastore
        Requirements["requirements.txt"]:::dependency
        Preprocessing["AQI_preprocessing.ipynb"]:::process
        ProcessedCSV(("air_quality_with_AQI.csv")):::datastore
        Training["model_training_and_evaluation.ipynb"]:::process
        ComparisonReport(("model_comparison_results.csv")):::output
    end

    RawCSV -->|"raw data"| Preprocessing
    RawTXT -->|"raw data"| Preprocessing
    Standards -->|"AQI rules"| Preprocessing
    Requirements -->|"environment"| Preprocessing
    Preprocessing -->|"features + AQI target"| ProcessedCSV
    ProcessedCSV -->|"processed data"| Training
    Requirements -->|"environment"| Training
    Training -->|"trained models + metrics"| ComparisonReport

    click RawCSV "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/final AQI 19-23.csv"
    click RawTXT "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/air_quality_with_AQI.txt"
    click Standards "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/AQI Standards in Pakistan.docx"
    click Requirements "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/requirements.txt"
    click Preprocessing "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/AQI_preprocessing.ipynb"
    click ProcessedCSV "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/air_quality_with_AQI.csv"
    click Training "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/model_training_and_evaluation.ipynb"
    click ComparisonReport "https://github.com/attiqrafiq/aqi_prediction_model/blob/main/model_comparison_results.csv"

    classDef datastore fill:#cce5ff,stroke:#004085,color:#004085
    classDef process fill:#d4edda,stroke:#155724,color:#155724
    classDef output fill:#ffe5b4,stroke:#ff8c00,color:#ff8c00
    classDef dependency fill:#e2e3e5,stroke:#6c757d,color:#6c757d
```
