# yuntech-bdrc/waterquality architecture

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

- Interactive diagram: https://gitdiagram.com/yuntech-bdrc/waterquality
- Repository: https://github.com/yuntech-bdrc/waterquality

## Overview

##### Main Components
a. Data Sources
- `dataset/water_potability.csv`
- `dataset/waterQuality1.csv`
b. Data Ingestion & Preprocessing
- CSV loader and cleaning routines inside notebooks (`Load_pretrain_model.ipynb`)
c. Model Training & Persistence
- XGBoost training process (notebooks: `water_patability_XGB_XAI.ipynb`)
- Model artifact: `model.bst`
d. Explainability Engine
- SHAP explainer runs in same notebook to generate feature‐importance (`feature_importance.csv`)
e. Output & Evaluation
- Performance metrics table in README
- Output CSVs: `output_df_water.csv`, `output_df_water_utf8.csv`
f. Notebooks / Orchestration

##### Relationships & Data Flows
- From Preprocessing → Model Training
- From Training → Model Artifact (`model.bst`)
- From Model → Explainability Engine (SHAP)
- From Explainability → Feature Importance CSV & Visual Outputs (`image/`)
- From both Model and Explainability → Evaluation & Output CSVs

##### Architectural Patterns
- Pipeline pattern: Sequential ETL → Train → Explain → Evaluate
- Artifact storage: model binary (`.bst`) and results (`.csv`)
- Interactive orchestration: Jupyter notebooks as the “control plane”

##### Technologies & Frameworks
- Python 3.x
- XGBoost (for training)
- SHAP (for explainability)
- Jupyter Notebook (as orchestration/visualization layer)
- Pandas/NumPy (for data manipulation)

- Component labels (e.g., “Raw Data (CSV)”, “Preprocessing Module”, “XGBoost Trainer”, “SHAP Explainer”, “Evaluation & Output”).

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Data Science Pipeline"
        direction TB

        subgraph "Raw Data Sources"
            WD1["water_potability.csv"]:::data
            WD2["waterQuality1.csv"]:::data
        end

        Notebook1["Load_pretrain_model.ipynb"]:::notebook

        Preprocess["Preprocessing Module"]:::process

        Notebook2["water_patability_XGB_XAI.ipynb"]:::notebook

        Train["XGBoost Trainer"]:::process

        ModelStem["model.bst"]:::data

        Explain["SHAP Explainer"]:::process

        FI["feature_importance.csv"]:::data
        Images["image/"]:::data

        Eval["Evaluation & Output"]:::process

        Out1["output_df_water.csv"]:::data
        Out2["output_df_water_utf8.csv"]:::data
        TestDS["X_test.csv"]:::data

    end

    Readme["README.md"]:::doc
    Req["requirement.txt"]:::doc

    WD1 --> Notebook1
    WD2 --> Notebook1
    Notebook1 --> Preprocess
    Preprocess --> Notebook2
    Notebook2 --> Train
    Train --> ModelStem
    ModelStem --> Explain
    Notebook2 --> Explain
    Explain --> FI
    Explain --> Images
    ModelStem --> Eval
    FI --> Eval
    TestDS --> Eval
    Eval --> Out1
    Eval --> Out2
    Eval --> Readme
    Req --- Notebook1

    click WD1 "https://github.com/yuntech-bdrc/waterquality/blob/main/dataset/water_potability.csv"
    click WD2 "https://github.com/yuntech-bdrc/waterquality/blob/main/dataset/waterQuality1.csv"
    click Notebook1 "https://github.com/yuntech-bdrc/waterquality/blob/main/Load_pretrain_model.ipynb"
    click Notebook2 "https://github.com/yuntech-bdrc/waterquality/blob/main/water_patability_XGB_XAI.ipynb"
    click ModelStem "https://github.com/yuntech-bdrc/waterquality/blob/main/model.bst"
    click FI "https://github.com/yuntech-bdrc/waterquality/blob/main/feature_importance.csv"
    click Images "https://github.com/yuntech-bdrc/waterquality/tree/main/image/"
    click Out1 "https://github.com/yuntech-bdrc/waterquality/blob/main/output_df_water.csv"
    click Out2 "https://github.com/yuntech-bdrc/waterquality/blob/main/output_df_water_utf8.csv"
    click TestDS "https://github.com/yuntech-bdrc/waterquality/blob/main/X_test.csv"
    click Readme "https://github.com/yuntech-bdrc/waterquality/blob/main/README.md"
    click Req "https://github.com/yuntech-bdrc/waterquality/blob/main/requirement.txt"

    classDef data fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef process fill:#90EE90,stroke:#333,stroke-width:1px
    classDef notebook fill:#FFFACD,stroke:#333,stroke-width:1px
    classDef doc fill:#D3D3D3,stroke:#333,stroke-width:1px
```
