# abhay-bharat/neural-network-mi-assignment-3 architecture

> Architecture diagram of the GitHub repository abhay-bharat/neural-network-mi-assignment-3, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-03-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abhay-bharat/neural-network-mi-assignment-3
- Repository: https://github.com/abhay-bharat/neural-network-mi-assignment-3

## Overview

##### Project type and purpose (from file tree + README)
This is a **machine learning / educational assignment project**: “Implementation of basic neural network using numpy”. It is not a deployed service; it’s a **local, notebook-driven workflow** with:
- A **raw dataset** (`LBW_Dataset.csv`)
- A **cleaned dataset** (`cleaned_LBW_Dataset.csv`)
- **Jupyter notebooks** that perform data cleaning and model experimentation (`cleaning_data.ipynb`, `nn.ipynb`, plus temp notebooks)
- A **core Python implementation** of the neural network (`Neural_network.py`)
- Supporting artifacts (`Assignment_3_-_Machine_Intelligence.pdf`, `debug.log`, `.ipynb_checkpoints`)

##### Data layer (files)
- **Raw dataset**: `LBW_Dataset.csv`
- **Cleaned dataset**: `cleaned_LBW_Dataset.csv`

##### Preprocessing / data preparation
- **Notebook**: `cleaning_data.ipynb`
- Reads raw CSV
- Performs cleaning/transforms/feature prep
- Writes cleaned CSV (inferred from presence of cleaned file)

(Also present: `temp_file.ipynb` and checkpoint versions; these are non-architectural artifacts unless they contain essential steps.)

##### Model / core logic
- **Neural network implementation**: `Neural_network.py`
- This is the key “library/module” in the project.
- Likely contains forward pass, backprop, weight updates, loss, etc. (typical for numpy NN assignments).

##### Experimentation / training / evaluation driver
- **Notebook**: `nn.ipynb`
- Loads cleaned data
- Uses `Neural_network.py` to train/evaluate
- Produces metrics/results/plots (even if not committed as files)

##### Documentation / assignment spec
- `README.md` (minimal)
- `Assignment_3_-_Machine_Intelligence.pdf` (the spec that dictates requirements)

##### Tooling/auxiliary artifacts (usually not in the ma
- `.ipynb_checkpoints/*` (Jupyter internals)
- `debug.log` (runtime artifact)

##### Inputs
- Raw dataset CSV
- Assignment PDF (requirements)

##### Preprocessing stage
- cleaning notebook (and key transformations, if known)

##### Training/Evaluation stage
- nn notebook (driver/orchestrator)

##### Core Model Implementation
- Neural_network.py (as a reusable module)

##### Outputs
- Cleaned CSV
- Evaluation metrics/plots (conceptual)
- (Optional) saved weights/models if the notebook saves them (not shown in tree, so mark as “optional / not present in repo”)

##### What technologies/frameworks to annotate
Even if the README is minimal, the repo strongly suggests:
- **Python**
- **NumPy** (explicit in README)
- **Jupyter Notebook** (the `.ipynb` workflow)
- “NumPy (confirmed)”
- “pandas/matplotlib (if used in notebooks/code)”

##### “Don’t overthink it”: split into as many components as possible (without inventing)

- Data normalization/encoding utilities (if present)
- Layer definitions (weights/bias)
- Forward propagation
- Loss function
- Backprop/gradient computation
- Optimizer/update rule (e.g., SGD)
- Prediction/inference
- Metrics (accuracy, confusion matrix, etc.)

- Train/validation split
- Hyperparameter selection
- Training loop orchestration
- Evaluation/visualization

- Missing value handling
- Feature selection/encoding
- Scaling/normalization
- Output schema definition (columns of cleaned CSV)

## Diagram (Mermaid)

```mermaid
flowchart TD
  %% =========================
  %% Inputs & Requirements
  %% =========================
  subgraph "Inputs & Requirements"
    SPEC["Assignment Spec (PDF)"]:::doc
    README["Project Overview (README)"]:::doc
    RAW[("Raw Dataset (CSV)")]:::data
  end

  %% =========================
  %% Preprocessing Stage
  %% =========================
  subgraph "Preprocessing (Notebook-as-Orchestrator)"
    CLEAN_NB["cleaning_data.ipynb (Jupyter)\n-Read raw CSV\n-Clean/transform\n-Feature prep\n-Write cleaned CSV"]:::notebook
  end

  %% =========================
  %% Data Contract Between Stages
  %% =========================
  subgraph "File-based Data Contract"
    CLEANED[("Cleaned Dataset (CSV)")]:::data
  end

  %% =========================
  %% Training / Evaluation Stage
  %% =========================
  subgraph "Training & Evaluation (Notebook-as-Orchestrator)"
    NN_NB["nn.ipynb (Jupyter)\n-Load cleaned data\n-Train/evaluate\n-Visualization"]:::notebook
    RESULTS["Notebook Outputs\n(Metrics / Plots)"]:::output
  end

  %% =========================
  %% Core Model Implementation
  %% =========================
  subgraph "Core Model (Reusable Module)"
    NN_MOD["Neural_network.py (NumPy)\n-Neural network implementation\n(Forward/Backprop/Update, etc.)"]:::module
    NN_CORE_NOTE["Note: internal functions/classes\nmay vary (verify in code)"]:::note
  end

  %% =========================
  %% Auxiliary / Tooling Artifacts
  %% =========================
  subgraph "Auxiliary / Tooling (Non-architectural)"
    CKPT[".ipynb_checkpoints/ (Jupyter internals)"]:::aux
    LOG["debug.log (runtime artifact)"]:::aux
    TEMP["temp_file.ipynb (temporary experiments)"]:::aux
  end

  %% =========================
  %% Dataflow & Dependencies
  %% =========================
  SPEC -->|"requirements"| CLEAN_NB
  SPEC -->|"requirements"| NN_NB
  SPEC -->|"requirements"| NN_MOD
  README -->|"project_context"| CLEAN_NB
  README -->|"project_context"| NN_NB

  RAW -->|"read_CSV"| CLEAN_NB
  CLEAN_NB -->|"clean/transform"| CLEANED
  CLEAN_NB -->|"write_cleaned_CSV"| CLEANED

  CLEANED -->|"load_cleaned_data"| NN_NB
  NN_NB -->|"import/use"| NN_MOD
  NN_NB -->|"train/evaluate"| RESULTS

  %% Optional/loose associations for auxiliary artifacts
  CLEAN_NB -.->|"creates/uses"| CKPT
  NN_NB -.->|"creates/uses"| CKPT
  NN_NB -.->|"may_write"| LOG
  TEMP -.->|"ad_hoc_work"| NN_MOD

  NN_MOD -->|"implementation_details"| NN_CORE_NOTE

  %% =========================
  %% Click Events (from mapping)
  %% =========================
  click RAW "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/LBW_Dataset.csv"
  click CLEANED "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/cleaned_LBW_Dataset.csv"
  click CLEAN_NB "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/cleaning_data.ipynb"
  click NN_MOD "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/Neural_network.py"
  click NN_NB "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/nn.ipynb"
  click README "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/README.md"
  click SPEC "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/Assignment_3_-_Machine_Intelligence.pdf"
  click CKPT "https://github.com/abhay-bharat/neural-network-mi-assignment-3/tree/master/.ipynb_checkpoints/"
  click LOG "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/debug.log"
  click TEMP "https://github.com/abhay-bharat/neural-network-mi-assignment-3/blob/master/temp_file.ipynb"

  %% =========================
  %% Styles
  %% =========================
  classDef data fill:#1f77b4,stroke:#0b3d6e,color:#ffffff,stroke-width:1.5px
  classDef notebook fill:#2ca02c,stroke:#1b5e20,color:#ffffff,stroke-width:1.5px
  classDef module fill:#6a3d9a,stroke:#3b1f5c,color:#ffffff,stroke-width:1.5px
  classDef doc fill:#7f7f7f,stroke:#4d4d4d,color:#ffffff,stroke-width:1.5px
  classDef aux fill:#bdbdbd,stroke:#6b6b6b,color:#1f1f1f,stroke-width:1.2px,stroke-dasharray: 4 3
  classDef output fill:#ff7f0e,stroke:#8a4a00,color:#ffffff,stroke-width:1.5px
  classDef note fill:#fff2b2,stroke:#b59b00,color:#4a3b00,stroke-width:1.2px,stroke-dasharray: 3 3
```
