# nagarjuna325/cs584-ml-project-spring23 architecture

> Architecture diagram of the GitHub repository nagarjuna325/cs584-ml-project-spring23, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-31). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nagarjuna325/cs584-ml-project-spring23
- Repository: https://github.com/nagarjuna325/cs584-ml-project-spring23

## Overview

##### Project Type and Purpose
- This project is a course project from CS 584 focused on applying machine learning techniques to detect anomalous network intrusions.
- It uses two Jupyter Notebook files—one for training and one for testing data—to perform feature selection, exploratory data analysis (EDA), and a suite of machine learning models (both supervised and unsupervised).
- The project includes dataset files (CSV and ZIP) containing the UNSW-NB15 dataset and feature description, which are essential parts of its data pipeline.

##### File Structure
- Top-level items include:
- Jupyter Notebook files: one for training and one for testing. These are the core codebases where the ML workflows are implemented.
- A dataset folder containing:
▪ NUSW-NB15_features.csv (feature descriptions)
▪ UNSW_NB15_testing-set.csv (testing dataset)
▪ UNSW_NB15_training-set.zip (training dataset in a compressed file)
- Additional documents (reports and proposals) which can be noted but are less critical for the technical architecture.
- There are no separate backend or frontend directories, so the entire focus is on data processing and ML modeling using Jupyter Notebook environments (both local e.g., Jupyter Notebook, and Google Colab).

##### README for Additional Insights
- The README highlights that there are two distinct workflows corresponding to the training and testing datasets.
- It clearly outlines the distribution of work among collaborators, hinting at the existence of both supervised (Logistic Regression, Decision Tree, SVM, XGBoost, Random Forest) and unsupervised models (MLP Classifier, CNN, RCNN).
- The README also notes that due to CPU/GPU constraints, the workflows are split; this implies an architectural decision to separate concerns between the training and inference/testing pipelines.

##### Final Checklist
- Every central component (datasets, notebook workflows, and ML model implementations) is visually distinct.
- Incorporate notes on split execution environments (local vs. cloud-based) if relevant to the project execution.
- Be very detailed: include sub-divisions (preprocessing, model training, evaluation) wherever appropriate to capture the overall ML pipeline.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Data Pipeline
    subgraph "Data Pipeline"
        DS["Dataset: UNSW-NB15"]:::storage
    end

    %% Notebook Workflows
    subgraph "Notebook Workflows"
        TNB["Training Notebook"]:::notebook
        TNPrep["Preprocessing / EDA"]:::process
        TNModel["Model Training"]:::process
        SM["Supervised Models"]:::model
        UM["Unsupervised Models"]:::model

        TNB --> TNPrep
        TNPrep --> TNModel
        TNModel --> SM
        TNModel --> UM

        TNB2["Testing Notebook"]:::notebook
        TPrep["Data Preprocessing"]:::process
        TInf["Model Inference"]:::process

        TNB2 --> TPrep
        TPrep --> TInf

        DS --> TNB
        DS --> TNB2
    end

    %% Execution Environments
    subgraph "Execution Environments"
        LJ["Local Jupyter"]:::env
        GC["Google Colab"]:::env
    end

    TNB --> LJ
    TNB --> GC
    TNB2 --> LJ
    TNB2 --> GC

    %% Documentation & Reports
    subgraph "Documentation & Reports"
        Doc1["Final Project Report"]:::doc
        Doc2["Intermediate Project Report"]:::doc
        Doc3["Project Proposal"]:::doc
    end

    DS --- Doc1
    DS --- Doc2
    DS --- Doc3

    %% Click Events
    click DS "https://github.com/nagarjuna325/cs584-ml-project-spring23/tree/master/dataset/"
    click TNB "https://github.com/nagarjuna325/cs584-ml-project-spring23/blob/master/ProjectCode_TRAININGset_The_Use_of_Machine_Learning_in_The_Detection_of_Anomaly_Network_Intrusion.ipynb"
    click TNB2 "https://github.com/nagarjuna325/cs584-ml-project-spring23/blob/master/ProjectCode_TESTINGset_The_Use_of_Machine_Learning_in_The_Detection_of_Anomaly_Network_Intrusion.ipynb"
    click Doc1 "https://github.com/nagarjuna325/cs584-ml-project-spring23/blob/master/CS584_Final_Project_Report _A20516439_A20524548_Spring23.pdf"
    click Doc2 "https://github.com/nagarjuna325/cs584-ml-project-spring23/blob/master/CS584_Intermediate_Project_Report _A20516439_A20524548_Spring23.pdf"
    click Doc3 "https://github.com/nagarjuna325/cs584-ml-project-spring23/blob/master/CS584_Project_Proposal_A20516439_A20524548_Spring23.pdf"

    %% Styling
    classDef storage fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef notebook fill:#FDFD96,stroke:#000,stroke-width:2px;
    classDef process fill:#C1FFC1,stroke:#000,stroke-width:2px;
    classDef model fill:#FFB6C1,stroke:#000,stroke-width:2px;
    classDef env fill:#D3D3D3,stroke:#000,stroke-width:2px;
    classDef doc fill:#FFD700,stroke:#000,stroke-width:2px;
```
