# ml2325/graduation_project architecture

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

- Interactive diagram: https://gitdiagram.com/ml2325/graduation_project
- Repository: https://github.com/ml2325/graduation_project

## Overview

##### Project Type and Purpose
- This is a self-contained machine-learning classification pipeline implemented in a Jupyter Notebook.
- Purpose: ingest raw data, preprocess it, perform exploratory data analysis (EDA), train classification models (Decision Tree & Logistic Regression), evaluate their performance, and produce visualizations and metrics.

##### Main Architectural Components
a. Data Ingestion Layer
- Raw Dataset (CSV or similar)
- Data Loader component in the notebook
b. Data Preprocessing Module
- Missing value handler
- Categorical encoder
- Numerical scaler
- SMOTE balancer for class‐imbalance
c. Exploratory Data Analysis (EDA) Module
- Visualization libraries: Matplotlib, Seaborn, Plotly
- Feature distribution plots, correlation heatmaps
d. Model Training & Selection
- Decision Tree trainer
- Logistic Regression trainer
- Train/Test split (80/20)
e. Model Evaluation Module
- Metrics calculator (Precision, Recall, F1‐Score, Accuracy)
- Confusion matrix generator
f. Outputs & Artifacts
- Performance reports
- Visualizations (charts, matrices)
- (Optional) Serialized model files for later deployment

##### Architectural Patterns and Principles
- Pipeline pattern: sequential data-processing stages
- Modularity: each stage (preprocessing, EDA, training, evaluation) is a distinct block
- Reproducibility: notebook cells represent steps that can be run end to end
- Extensibility: replace or add new models or preprocessing techniques as separate blocks

##### Technologies & Frameworks to Annotate
- Python & Jupyter Notebook
- pandas, scikit-learn (preprocessing, SMOTE, models, metrics)
- imbalanced-learn (SMOTE)
- Matplotlib, Seaborn, Plotly (visualization)

##### Final Checklist
- All six components (data, preprocessing, EDA, training, evaluation, outputs) clearly labeled
- Legends for clarity
- Space for future extension (e.g., model registry, API layer)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Legend
    subgraph "Legend"
        direction TB
        DL["Data Layers"]:::dataLayers
        PM["Processing Modules"]:::processing
        MC["Model Components"]:::model
        AR["Artifacts"]:::artifacts
    end

    %% Pipeline
    RawData["Raw Dataset (CSV)"]:::dataLayers
    Preprocessing["Data Preprocessing Module"]:::processing
    EDA["Exploratory Data Analysis (EDA)"]:::processing
    Training["Model Training & Selection"]:::model
    Evaluation["Model Evaluation"]:::model
    Outputs["Outputs & Artifacts"]:::artifacts
    ProjectDoc["Project Documentation (README)"]:::artifacts

    %% Data Flow
    RawData -->|"load CSV via pandas"| Preprocessing
    Preprocessing -->|"SMOTE applied"| EDA
    Preprocessing -->|"preprocessed data"| Training
    Training -->|"trained models + test data"| Evaluation
    Evaluation -->|"metrics computed"| Outputs
    Training -.->|"model persistence"| Outputs

    %% Click Events
    click RawData "https://github.com/ml2325/graduation_project/blob/main/Graduation_Project_melissa_lahlou (1).ipynb"
    click Preprocessing "https://github.com/ml2325/graduation_project/blob/main/Graduation_Project_melissa_lahlou (1).ipynb"
    click EDA "https://github.com/ml2325/graduation_project/blob/main/Graduation_Project_melissa_lahlou (1).ipynb"
    click Training "https://github.com/ml2325/graduation_project/blob/main/Graduation_Project_melissa_lahlou (1).ipynb"
    click Evaluation "https://github.com/ml2325/graduation_project/blob/main/Graduation_Project_melissa_lahlou (1).ipynb"
    click Outputs "https://github.com/ml2325/graduation_project/blob/main/Graduation_Project_melissa_lahlou (1).ipynb"
    click ProjectDoc "https://github.com/ml2325/graduation_project/blob/main/README.md"

    %% Styles
    classDef dataLayers fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef processing fill:#90EE90,stroke:#000,stroke-width:1px
    classDef model fill:#FFA500,stroke:#000,stroke-width:1px
    classDef artifacts fill:#D3D3D3,stroke:#000,stroke-width:1px
```
