# ademeecee/time-series-predictions architecture

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

- Interactive diagram: https://gitdiagram.com/ademeecee/time-series-predictions
- Repository: https://github.com/ademeecee/time-series-predictions

## Overview

##### Project type and purpose
- This is a time-series predictive modeling project implemented in Jupyter notebooks.
- Purpose: forecast hourly PM2.5 levels in Lagos using historical air-quality data.

##### File structure
- Top-level items:
– lagos_air_quality.csv (raw data source)
– Report_on_Time_Series_Linear_Regression.ipynb (final report notebook)
– Time_Series_Linear_Regression.ipynb (data prep + model pipeline notebook)
– README.md (documentation)
- No separate frontend/backend code or services—this is a data-science pipeline contained in notebooks.

##### README for additional insights
- Workflow stages are spelled out: data collection, EDA, feature engineering, baseline model, predictive modeling, evaluation, visualization, stakeholder reporting.
- Technologies implied: Python, pandas, scikit-learn, plotting libraries (e.g., matplotlib or plotly).

a. Main components
1. Data Ingestion (lagos_air_quality.csv)
2. Data Preprocessing & Cleaning (resampling, imputation)
3. Feature Engineering (lag features, rolling averages)
4. Baseline Model Module (mean-based predictor)
5. Predictive Model Module (Linear Regression training + inference)
6. Model Evaluation (MAE, R² calculations)
7. Visualization & Reporting (interactive/ static plots, final report notebook)
8. Future-data inputs (weather APIs or expanded datasets)

b. Relationships & interactions
- Data flows from Data Ingestion → Preprocessing → Feature Engineering → Model Modules → Evaluation → Visualizations.
- The report notebook reads outputs from all prior steps.

c. Architectural patterns / design principles
- Linear pipeline pattern: each notebook cell group acts as a modular stage.
- Separation of concerns: distinct tasks (cleaning vs modeling vs reporting) in separate notebook sections/files.
- Extensibility: future insertion of additional data sources or model types (ARIMA, LSTM).

d. Key technologies & libraries
- pandas (data manipulation)
- numpy (numeric operations)
- scikit-learn (linear regression, metrics)
- Jupyter environment (notebooks)
- plotting libs (matplotlib/plotly)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Stages
    DataIngestion[(lagos_air_quality.csv)]:::dataStage
    Preprocessing["Data Preprocessing<br/>(resampling, imputation)"]:::dataStage
    FeatureEngineering["Feature Engineering<br/>(lag features, rolling averages)"]:::dataStage

    %% Modeling Stages
    subgraph "Modeling Pipeline"
        direction TB
        Baseline["Baseline Model<br/>(mean-based predictor)"]:::modelStage
        Predictive["Predictive Model<br/>(Linear Regression)"]:::modelStage
    end

    %% Output Stages
    Evaluation["Model Evaluation<br/>(MAE, R² metrics)"]:::outputStage
    Visualization["Visualization & Reporting<br/>(plots, notebooks)"]:::outputStage

    %% Documentation
    Docs["Documentation & Metadata<br/>(README.md)"]:::docs

    %% Future Extensions
    FutureData["Future Data Sources<br/>(weather APIs)"]:::dashed
    AlternateModels["Alternate Models<br/>(ARIMA, LSTM)"]:::dashed

    %% Flow
    DataIngestion -->|"raw CSV"| Preprocessing
    Preprocessing -->|"cleaned DataFrame"| FeatureEngineering
    FeatureEngineering -->|"features X/y"| Baseline
    FeatureEngineering -->|"features X/y"| Predictive
    Baseline -->|"baseline predictions"| Evaluation
    Predictive -->|"model predictions"| Evaluation
    Evaluation -->|"metrics report"| Visualization
    Visualization -->|"documentation input"| Docs

    %% Future branches
    FutureData -.-> Preprocessing
    AlternateModels -.-> Predictive

    %% Click Events
    click DataIngestion "https://github.com/ademeecee/time-series-predictions/blob/main/lagos_air_quality.csv"
    click Preprocessing "https://github.com/ademeecee/time-series-predictions/blob/main/Time_Series_Linear_Regression.ipynb"
    click FeatureEngineering "https://github.com/ademeecee/time-series-predictions/blob/main/Time_Series_Linear_Regression.ipynb"
    click Baseline "https://github.com/ademeecee/time-series-predictions/blob/main/Time_Series_Linear_Regression.ipynb"
    click Predictive "https://github.com/ademeecee/time-series-predictions/blob/main/Time_Series_Linear_Regression.ipynb"
    click Evaluation "https://github.com/ademeecee/time-series-predictions/blob/main/Time_Series_Linear_Regression.ipynb"
    click Visualization "https://github.com/ademeecee/time-series-predictions/blob/main/Time_Series_Linear_Regression.ipynb"
    click Visualization "https://github.com/ademeecee/time-series-predictions/blob/main/Report_on_Time_Series_Linear_Regression.ipynb"
    click Docs "https://github.com/ademeecee/time-series-predictions/blob/main/README.md"

    %% Styles
    classDef dataStage fill:#D0E8F2,stroke:#0366d6,color:#0366d6
    classDef modelStage fill:#D4EDDA,stroke:#28a745,color:#28a745
    classDef outputStage fill:#FFF3CD,stroke:#d39e00,color:#856404
    classDef docs fill:#E2E3E5,stroke:#6c757d,color:#6c757d
    classDef dashed fill:none,stroke:#999999,stroke-dasharray:5 5,color:#999999
```
