# vennfungus/how-i-got-ml architecture

> Architecture diagram of the GitHub repository vennfungus/how-i-got-ml, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vennfungus/how-i-got-ml
- Repository: https://github.com/vennfungus/how-i-got-ml

## Overview

This is a small educational repository for learning fundamental machine-learning models. Its documented workflow uses notebooks as visual, data-driven demonstrations and Python source as algorithm descriptions. The repository includes classification and regression notebooks, plus logistic and regression implementations. The sampled regression source shows MSE calculation, gradient-descent fitting, and feature scaling; the logistic excerpt only exposes sigmoid, loss, and the start of a training routine. Notebook internals were not sampled, so links from notebooks to source implementations are not asserted.

Main entry points: [`src/regression.py`](https://github.com/vennfungus/how-i-got-ml/blob/main/src/regression.py) (Regression Fitting), [`classification.ipynb`](https://github.com/vennfungus/how-i-got-ml/blob/main/classification.ipynb) (Classification Demo), [`regression.ipynb`](https://github.com/vennfungus/how-i-got-ml/blob/main/regression.ipynb) (Regression Demo), [`src/logistic.py`](https://github.com/vennfungus/how-i-got-ml/blob/main/src/logistic.py) (Logistic Algorithms)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_learner(("Learner"))
node_classification_demo["Classification Demo"]
node_regression_demo["Regression Demo<br/>[regression.ipynb]"]
node_logistic_models["Logistic Algorithms<br/>[logistic.py]"]
node_regression_fit["Regression Fitting<br/>[regression.py]"]
node_regression_tools["Regression Metrics and Scaling<br/>[regression.py]"]

node_learner -->|"explores visually"| node_classification_demo
node_learner -->|"explores visually"| node_regression_demo
node_learner -->|"studies algorithm"| node_logistic_models
node_learner -->|"studies algorithm"| node_regression_fit
node_regression_fit -.->|"shares module"| node_regression_tools

click node_classification_demo "https://github.com/vennfungus/how-i-got-ml/blob/main/classification.ipynb"
click node_regression_demo "https://github.com/vennfungus/how-i-got-ml/blob/main/regression.ipynb"
click node_logistic_models "https://github.com/vennfungus/how-i-got-ml/blob/main/src/logistic.py"
click node_regression_fit "https://github.com/vennfungus/how-i-got-ml/blob/main/src/regression.py"
click node_regression_tools "https://github.com/vennfungus/how-i-got-ml/blob/main/src/regression.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_learner toneIndigo
class node_classification_demo,node_regression_demo,node_logistic_models,node_regression_fit,node_regression_tools toneTeal
```

## Components

### Other components

- **Learner**
- [Classification Demo](https://github.com/vennfungus/how-i-got-ml/blob/main/classification.ipynb): `classification.ipynb`
- [Regression Demo](https://github.com/vennfungus/how-i-got-ml/blob/main/regression.ipynb): `regression.ipynb`
- [Logistic Algorithms](https://github.com/vennfungus/how-i-got-ml/blob/main/src/logistic.py): `src/logistic.py`
- [Regression Fitting](https://github.com/vennfungus/how-i-got-ml/blob/main/src/regression.py): `src/regression.py`
- [Regression Metrics and Scaling](https://github.com/vennfungus/how-i-got-ml/blob/main/src/regression.py): `src/regression.py`

## Connections

- Learner → Classification Demo: explores visually (evidence: `README.md`)
- Learner → Regression Demo: explores visually (evidence: `README.md`)
- Learner → Logistic Algorithms: studies algorithm (evidence: `README.md`)
- Learner → Regression Fitting: studies algorithm (evidence: `README.md`)
- Regression Fitting → Regression Metrics and Scaling: shares module (evidence: `src/regression.py`)
