# realworlddatascience/realworlddatascience.github.io architecture

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

- Interactive diagram: https://gitdiagram.com/realworlddatascience/realworlddatascience.github.io
- Repository: https://github.com/realworlddatascience/realworlddatascience.github.io

## Overview

This repository is the source for the Real World Data Science website, with articles and accompanying examples. The sampled Auburn case-study code implements a distinct workflow: configure a method and dataset, prepare product/retail data and embeddings, train or tune an ANN or random-forest model, then evaluate matches. The graph also preserves the site’s article-content branch. Source excerpts support the Auburn call relationships; README context supports the site’s purpose, but does not describe its rendering or publication internals.

Main entry points: [`applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/main.py) (Configuration entry), [`applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann.py`](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann.py) (ANN operations), [`applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/official_eval/evaluation_script.py`](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/official_eval/evaluation_script.py) (Ranking evaluation), [`applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/interface/embedding.py`](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/interface/embedding.py) (Embedding interface)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_site["Website content"]
  node_articles["Articles and case studies<br/>[main.py]"]
  node_example["Auburn example"]
end

subgraph group_entry["Auburn workflow"]
  node_cli["Configuration entry<br/>[main.py]"]
  node_types["Method types<br/>[user_types.py]"]
end

subgraph group_prep["Data preparation"]
  node_prepdata["Data preparation<br/>[prep_data.py]"]
  node_embedapi["Embedding interface<br/>[embedding.py]"]
  node_glove["GloVe embeddings<br/>[glove.py]"]
  node_bert["BERT embeddings<br/>[bert.py]"]
  node_formatutils["Data utilities<br/>[utils.py]"]
end

subgraph group_models["Modeling and evaluation"]
  node_rf["Random forest<br/>[random_forest.py]"]
  node_rflegacy["Legacy random forest"]
  node_ann["ANN operations<br/>[ann.py]"]
  node_annlegacy["Legacy ANN<br/>[ann_old.py]"]
  node_annmodel["ANN model<br/>[ann_model.py]"]
  node_anndata["ANN data module<br/>[ann_datamodule.py]"]
  node_callbacks["Training callbacks<br/>[callbacks.py]"]
  node_evaluate["Ranking evaluation"]
end

node_readers(("Readers and contributors"))

node_readers -->|"read and contribute"| node_articles
node_articles -->|"includes example"| node_example
node_cli -->|"uses method types"| node_types
node_cli -->|"prepares data"| node_prepdata
node_cli -->|"dispatches method"| node_rf
node_cli -->|"dispatches method"| node_ann
node_cli -->|"uses utilities"| node_formatutils
node_prepdata -->|"requests embeddings"| node_embedapi
node_embedapi -->|"dispatches embedding"| node_glove
node_embedapi -->|"dispatches embedding"| node_bert
node_rf -->|"uses embeddings"| node_glove
node_rf -->|"evaluates results"| node_evaluate
node_rflegacy -->|"uses embeddings"| node_glove
node_rflegacy -->|"evaluates results"| node_evaluate
node_ann -->|"creates data module"| node_anndata
node_ann -->|"creates model"| node_annmodel
node_ann -->|"registers callbacks"| node_callbacks
node_annmodel -->|"uses metrics"| node_evaluate
node_annlegacy -->|"uses metrics"| node_evaluate

click node_articles "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/main.py"
click node_example "https://github.com/realworlddatascience/realworlddatascience.github.io/tree/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code"
click node_cli "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/main.py"
click node_types "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/user_types.py"
click node_prepdata "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/prep_data.py"
click node_embedapi "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/interface/embedding.py"
click node_glove "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/embedding/glove.py"
click node_bert "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/embedding/bert.py"
click node_formatutils "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/utils.py"
click node_rf "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/random_forest.py"
click node_rflegacy "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/random_forest_old.py"
click node_ann "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann.py"
click node_annlegacy "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_old.py"
click node_annmodel "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_model_and_datamodule/ann_model.py"
click node_anndata "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_model_and_datamodule/ann_datamodule.py"
click node_callbacks "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_model_and_datamodule/callbacks.py"
click node_evaluate "https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/official_eval/evaluation_script.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_articles,node_example toneBlue
class node_cli,node_types toneAmber
class node_prepdata,node_embedapi,node_glove,node_bert,node_formatutils toneMint
class node_rf,node_rflegacy,node_ann,node_annlegacy,node_annmodel,node_anndata,node_callbacks,node_evaluate toneRose
class node_readers toneIndigo
```

## Components

### Website content

- [Articles and case studies](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/main.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`
- [Auburn example](https://github.com/realworlddatascience/realworlddatascience.github.io/tree/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code`

### Auburn workflow

- [Configuration entry](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/main.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`
- [Method types](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/user_types.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/user_types.py`

### Data preparation

- [Data preparation](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/prep_data.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/prep_data.py`
- [Embedding interface](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/interface/embedding.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/interface/embedding.py`
- [GloVe embeddings](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/embedding/glove.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/embedding/glove.py`
- [BERT embeddings](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/embedding/bert.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/embedding/bert.py`
- [Data utilities](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/utils.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/utils.py`

### Modeling and evaluation

- [Random forest](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/random_forest.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/random_forest.py`
- [Legacy random forest](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/random_forest_old.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/random_forest_old.py`
- [ANN operations](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann.py`
- [Legacy ANN](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_old.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann_old.py`
- [ANN model](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_model_and_datamodule/ann_model.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann_model_and_datamodule/ann_model.py`
- [ANN data module](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_model_and_datamodule/ann_datamodule.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann_model_and_datamodule/ann_datamodule.py`
- [Training callbacks](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/methods/ann_model_and_datamodule/callbacks.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann_model_and_datamodule/callbacks.py`
- [Ranking evaluation](https://github.com/realworlddatascience/realworlddatascience.github.io/blob/main/applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source%20Code/src/utilities/official_eval/evaluation_script.py): `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/official_eval/evaluation_script.py`

### Other components

- **Readers and contributors**

## Connections

- Readers and contributors → Articles and case studies: read and contribute (evidence: `README.md`)
- Articles and case studies → Auburn example: includes example (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`)
- Configuration entry → Method types: uses method types (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`)
- Configuration entry → Data preparation: prepares data (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`)
- Configuration entry → Random forest: dispatches method (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`)
- Configuration entry → ANN operations: dispatches method (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`)
- Configuration entry → Data utilities: uses utilities (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/main.py`)
- Data preparation → Embedding interface: requests embeddings (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/prep_data.py`)
- Embedding interface → GloVe embeddings: dispatches embedding (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/interface/embedding.py`)
- Embedding interface → BERT embeddings: dispatches embedding (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/interface/embedding.py`)
- Random forest → GloVe embeddings: uses embeddings (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/random_forest.py`)
- Random forest → Ranking evaluation: evaluates results (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/random_forest.py`)
- Legacy random forest → GloVe embeddings: uses embeddings (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/random_forest_old.py`)
- Legacy random forest → Ranking evaluation: evaluates results (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/random_forest_old.py`)
- ANN operations → ANN data module: creates data module (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann.py`)
- ANN operations → ANN model: creates model (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann.py`)
- ANN operations → Training callbacks: registers callbacks (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann.py`)
- ANN model → Ranking evaluation: uses metrics (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann_model_and_datamodule/ann_model.py`)
- Legacy ANN → Ranking evaluation: uses metrics (evidence: `applied-insights/case-studies/posts/2023/08/21/_code/auburn/Source Code/src/utilities/methods/ann_old.py`)
