# subratamaji/ids-unsw-nb15 architecture

> Architecture diagram of the GitHub repository subratamaji/ids-unsw-nb15, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/subratamaji/ids-unsw-nb15
- Repository: https://github.com/subratamaji/ids-unsw-nb15

## Overview

##### Main components
- Data Acquisition & Cleaning (Directory: “1. Dataset” – Notebook on dataset description and cleaning)
- Exploratory Data Analysis (Directory: “2. EDA” – Notebook on EDA)
- Data Preprocessing & Feature Engineering (Directory: “3. Preprocessing” – Notebook on feature engineering and data preparation)
- Machine Learning Modeling and Evaluation (Directory: “4. ML Models” – Notebook on model building and performance results)
- Prediction Module (Directory: “5. Predict data” – Notebook that wraps up the process into a final prediction function)

##### Relationships and data flow
- A sequential pipeline where raw data first undergoes cleaning and then moves on to analysis (EDA).
- Next, illustrate that the processed insights and cleaned data feed into the preprocessing and feature engineering stage.
- The engineered features then serve as inputs to the ML models component where classification models are developed and validated.

##### Architectural patterns & design principles
- Although the project is implemented as a series of Jupyter notebooks, treat each notebook as a loosely coupled micro-module that together form a processing pipeline.
- Follow the pattern of data flow from ingestion to transformation to modeling and prediction.
- Even if the environment is not a full-blown web or API setup, the sequential modular design helps in maintaining clean separation of concerns and clear responsibilities.

##### Relevant technologies and tools
- The project likely uses Python-based libraries (e.g., pandas for data manipulation, scikit-learn for ML modeling, matplotlib/seaborn for visualization) even though these are not explicitly stated.
- That these libraries are a part of the backend processing for building and evaluating models.
- If applicable, mention that any integration or automation (for instance, coupling these stages via pipeline tools or notebooks execution ordering) adds to the project’s robustness.

## Diagram (Mermaid)

```mermaid
flowchart TD
    A["Data Acquisition & Cleaning"]:::process
    B["Exploratory Data Analysis"]:::process
    C["Data Preprocessing & Feature Engineering"]:::process
    D["Machine Learning Modeling & Evaluation"]:::process
    E["Prediction Module"]:::outcome

    A -->|"next"| B
    B -->|"next"| C
    C -->|"next"| D
    D -->|"next"| E

    click A "https://github.com/subratamaji/ids-unsw-nb15/blob/master/1. Dataset/About Dataset and It's Cleaning.ipynb"
    click B "https://github.com/subratamaji/ids-unsw-nb15/blob/master/2. EDA/Exploratory Data Analysis.ipynb"
    click C "https://github.com/subratamaji/ids-unsw-nb15/blob/master/3. Preprocessing/Feature Engineering and Data Preparation.ipynb"
    click D "https://github.com/subratamaji/ids-unsw-nb15/blob/master/4. ML Models/ML Models and Results.ipynb"
    click E "https://github.com/subratamaji/ids-unsw-nb15/blob/master/5. Predict data/Prediction of Raw Data.ipynb"

    classDef process fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef outcome fill:#90EE90,stroke:#000,stroke-width:2px;
```
